tencent cloud



Last updated: 2022-05-06 10:30:34

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 Yes String Common Params. For more information, please see the list of regions supported by the product.
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

3. Output Parameters

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.

4. Example

Example1 Getting the list of roles

Input Example

&<Common request parameters>

Output Example

  "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. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support