查询用户角色

1. 接口描述

接口请求域名： essbasic.tencentcloudapi.com 。

查询用户角色

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelDescribeRoles。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，本接口不需要传递此参数。
Agent	是	Agent	应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
Offset	是	Integer	查询起始偏移，最大2000
Limit	是	String	查询数量，最大200
Filters.N	否	Array of Filter	查询的关键字段: Key:"RoleType",Values:["1"]查询系统角色，Values:["2"]查询自定义角色 Key:"RoleStatus",Values:["1"]查询启用角色，Values:["2"]查询禁用角色
Operator	否	UserInfo	操作人信息

3. 输出参数

参数名称	类型	描述
Offset	Integer	页面偏移量，最大2000
Limit	Integer	查询数量，最大200
TotalCount	Integer	查询角色的总数量
ChannelRoles	Array of ChannelRole	角色信息注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

示例

输入示例

POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelDescribeRoles
<公共请求参数>

{
    "Operator": {
        "OpenId": "abc",
        "Channel": "abc",
        "CustomUserId": "abc",
        "ClientIp": "abc",
        "ProxyIp": "abc"
    },
    "Agent": {
        "AppId": "abc",
        "ProxyOrganizationOpenId": "abc",
        "ProxyOperator": {
            "OpenId": "abc",
            "Channel": "abc",
            "CustomUserId": "abc",
            "ClientIp": "abc",
            "ProxyIp": "abc"
        },
        "ProxyAppId": "abc",
        "ProxyOrganizationId": "abc"
    },
    "Filters": [
        {
            "Key": "abc",
            "Values": [
                "abc"
            ]
        }
    ],
    "Offset": 1,
    "Limit": "abc"
}

输出示例

{
    "Response": {
        "Offset": 1,
        "Limit": 1,
        "TotalCount": 1,
        "ChannelRoles": [
            {
                "RoleId": "abc",
                "RoleName": "abc",
                "RoleStatus": 1
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.Db	数据库错误。
InvalidParameter	参数错误。
InvalidParameter.Limit	参数Limit不正确
InvalidParameter.Offset	参数Offset不正确
InvalidParameter.ParamError	参数错误。
MissingParameter	缺少参数错误。
ResourceNotFound.Application	应用号不存在。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 示例​

输入示例​

输出示例​

5. 开发者资源​

腾讯云 API 平台​

API Inspector​

SDK​

命令行工具​

6. 错误码​