DescribeRoles

Last updated: 2025-11-25 10:53:49

DescribeRoles

Last updated: 2025-11-25 10:53:49

1. API Description

Domain name for API request: tdmq.intl.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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
ClusterId	Yes	String	Cluster ID (required)
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.
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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Obtains the list of roles

Input Example

POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoles
<Common request parameters>

{
    "RoleName": "devRole",
    "Offset": 0,
    "Limit": 10,
    "ClusterId": "pulsar-xk3ne8k2qkp8"
}

Output Example

{
    "Response": {
        "TotalCount": 4,
        "RoleSets": [
            {
                "RoleName": "test_role_3",
                "Token": "eyJzdddaWIiOiJ0ZXN0X3****O9bDulZQ6lraNswNLtcUcY",
                "Remark": "devRemark",
                "CreateTime": "2020-08-04 11:59:06",
                "UpdateTime": "2020-08-04 11:59:06"
            },
            {
                "RoleName": "test_role_2",
                "Token": "eyJzdWIiOiJ0asZsXN0X3Jasdv****AQRmEs-_3da8yU0O61D0",
                "Remark": "devRemark",
                "CreateTime": "2020-08-03 20:23:52",
                "UpdateTime": "2020-08-03 20:23:52"
            },
            {
                "RoleName": "test_role_1",
                "Token": "eyJzddassWIiOiJ0ZXN0X3J****QA7vWB0igKr_7eQitbweBoo",
                "Remark": "devRemark",
                "CreateTime": "2020-08-03 19:48:36",
                "UpdateTime": "2020-08-03 20:22:21"
            },
            {
                "RoleName": "test_role",
                "Token": "eyJzdWIiOiJ0ZXsas****5wSJ8u6sUJWW",
                "Remark": "Remark1",
                "CreateTime": "2020-08-03 17:22:09",
                "UpdateTime": "2020-08-04 15:59:29"
            }
        ],
        "RequestId": "1004f1de-6fb8-41d5-965e-3aae8c87183a"
    }
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud