Domain name for API request: tdmq.tencentcloudapi.com.
This API is used to get the list of roles.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeRoles. |
Version | Yes | String | Common Params. The value used for this API: 2020-02-17. |
Region | No | String | Common Params. This parameter is not required for this API. |
RoleName | No | String | Fuzzy query by role name |
Offset | No | Integer | Offset. If this parameter is left empty, 0 will be used by default. |
Limit | No | Integer | Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 20. |
ClusterId | No | String | Cluster ID (required) |
Filters.N | No | Array of Filter | * RoleName Filter by role name for exact query. Type: String Required: no |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of records. |
RoleSets | Array of Role | Array of roles. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://tdmq.tencentcloudapi.com/?Action=DescribeRoles
&Offset=0
&Limit=10
&<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
AuthFailure.UnauthorizedOperation | CAM authentication failed. |
InternalError.SystemError | System error. |
InvalidParameterValue.InvalidParams | The parameter value is out of the value range. |
MissingParameter.NeedMoreParams | A required parameter is missing. |
ResourceNotFound.BrokerCluster | The service cluster does not exist. |
ResourceNotFound.Cluster | The cluster does not exist. |
本页内容是否解决了您的问题?