tencent cloud



Last updated: 2023-08-09 14:43:23

1. API Description

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

This API is used to get the list of RocketMQ clusters.

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: DescribeRocketMQClusters.
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.
Offset Yes Integer Offset.
Limit Yes Integer The max number of returned results.
IdKeyword No String Search by cluster ID.
NameKeyword No String Search by cluster name.
ClusterIdList.N No Array of String Filter by cluster ID.
IsTagFilter No Boolean For filtering by tag, this parameter must be set to true.
Filters.N No Array of Filter Filter. Currently, you can filter only by tag.

3. Output Parameters

Parameter Name Type Description
ClusterList Array of RocketMQClusterDetail Cluster information.
Note: This field may return null, indicating that no valid values can be obtained.
TotalCount Integer The total number of returned results.
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 created clusters

Input Example

Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRocketMQClusters
<Common request parameters>

    "Limit": "10",
    "Offset": "0"

Output Example

    "Response": {
        "RequestId": "1faeceb2-eaa9-407e-bd9a-d3eff76ca882",
        "TotalCount": 1,
        "ClusterList": [
                "Info": {
                    "ClusterId": "rocketmq-xxxx1",
                    "ClusterName": "test",
                    "Region": "ap-beijing",
                    "CreateTime": 1620321019000,
                    "Remark": "String",
                    "PublicEndPoint": "pulsar://rocketmq-xxxx1.xxxx.com:5678",
                    "VpcEndPoint": "pulsar://rocketmq-xxxx1.xxxx.com:5678",
                    "Vpcs": [
                            "SubnetId": "xx",
                            "VpcId": "xx"
                    "SupportNamespaceEndpoint": true,
                    "RocketMQFlag": true,
                    "IsVip": true
                "Config": {
                    "MaxTpsPerNamespace": 8000,
                    "UsedNamespaceNum": 1,
                    "MaxTopicNum": 1000,
                    "UsedTopicNum": 2,
                    "MaxGroupNum": 10000,
                    "UsedGroupNum": 1,
                    "MaxRetentionTime": 1296000000,
                    "MaxLatencyTime": 3456000000,
                    "MaxNamespaceNum": 10

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
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
ResourceNotFound The resource 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