1. 接口描述
接口请求域名: tdmq.tencentcloudapi.com 。
获取角色列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRoles。 |
Version | 是 | String | 公共参数,本接口取值:2020-02-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 必填字段,集群Id 示例值:test |
RoleName | 否 | String | 角色名称,模糊查询 示例值:test |
Offset | 否 | Integer | 起始下标,不填默认为0。 示例值:0 |
Limit | 否 | Integer | 返回数量,不填则默认为10,最大值为20。 示例值:10 |
Filters.N | 否 | Array of Filter | * RoleName 按照角色名进行过滤,精确查询。 类型:String 必选:否 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 记录数。 示例值:4 |
RoleSets | Array of Role | 角色数组。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取角色列表
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoles
<公共请求参数>
{
"RoleName": "abc",
"Offset": 0,
"Limit": 0,
"ClusterId": "abc",
"Filters": [
{
"Name": "abc",
"Values": [
"abc"
]
}
]
}
输出示例
{
"Response": {
"TotalCount": 4,
"RoleSets": [
{
"RoleName": "test_role_3",
"Token": "xxx.eyJzdWIiOiJ0ZXN0X3JvbGVfMyJ9.dbHR8m6gc4L4vZUrodhW_O9bDulZQ6lraNswNLtcUcY",
"Remark": "",
"CreateTime": "2020-08-04 11:59:06",
"UpdateTime": "2020-08-04 11:59:06"
},
{
"RoleName": "test_role_2",
"Token": "xxx.eyJzdWIiOiJ0ZXN0X3JvbGVfMiJ9.KTbLPg1ax2HDa51vfWmoDK5AQRmEs-_3da8yU0O61D0",
"Remark": "",
"CreateTime": "2020-08-03 20:23:52",
"UpdateTime": "2020-08-03 20:23:52"
},
{
"RoleName": "test_role_1",
"Token": "xxx.eyJzdWIiOiJ0ZXN0X3JvbGVfMSJ9.aatGv_WEZK5jqmXNX3dxQA7vWB0igKr_7eQitbweBoo",
"Remark": "",
"CreateTime": "2020-08-03 19:48:36",
"UpdateTime": "2020-08-03 20:22:21"
},
{
"RoleName": "test_role",
"Token": "xxxx.eyJzdWIiOiJ0ZXN0X3JvbGUifQ.xeU_xkiB5wSJ8u6sUJWW",
"Remark": "Remark1",
"CreateTime": "2020-08-03 17:22:09",
"UpdateTime": "2020-08-04 15:59:29"
}
],
"RequestId": "gggxxxx"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnauthorizedOperation | CAM鉴权不通过。 |
InternalError.SystemError | 系统错误。 |
InvalidParameterValue.InvalidParams | 参数值不在允许范围内。 |
MissingParameter.NeedMoreParams | 必要参数没有传递。 |
ResourceNotFound.BrokerCluster | 服务的集群不存在。 |
ResourceNotFound.Cluster | 集群不存在。 |