DescribeRocketMQRoles

Last updated: 2025-11-25 10:52:14

DescribeRocketMQRoles

Last updated: 2025-11-25 10:52:14

1. API Description

Domain name for API request: tdmq.intl.tencentcloudapi.com.

Obtains 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: DescribeRocketMQRoles.
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.
Offset	Yes	Integer	Starting index. Default is 0 if left empty.
Limit	Yes	Integer	Number of returns, default to 10 if not specified, maximum value: 20.
ClusterId	Yes	String	Required field, cluster ID
RoleName	No	String	Role name, fuzzy search
Filters.N	No	Array of Filter	Filters RoleName by role name for precise query. Type: string. Required: no.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Record count.
RoleSets	Array of Role	Role array.
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: DescribeRocketMQRoles
<Common request parameters>

{
    "RoleName": "test_role_name",
    "Offset": 0,
    "Limit": 20,
    "ClusterId": "rocketmq-2p9vx3ax9jxg",
    "Filters": [
        {
            "Name": "RoleName",
            "Values": [
                "test_role_name"
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "RoleSets": [
            {
                "RoleName": "test_role_name",
                "Token": "eyJrZXlJZCI6InN1bmdvxxxxx0X3JvbGVfMyJ9.dbHR8m6gc4L4vZUrodhW_O9bDulZQ6lraNswNLtcUcY",
                "Remark": "Test role",
                "CreateTime": "2020-09-22 00:00:00",
                "UpdateTime": "2020-09-22 00:00:00"
            }
        ],
        "RequestId": "23ca1a58-0388-4d2d-8465-653a53addda7"
    }
}

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