DescribeRocketMQCluster

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

DescribeRocketMQCluster

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

1. API Description

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

This API is used to get the information of a specific RocketMQ cluster.

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: DescribeRocketMQCluster.
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.
ClusterId	Yes	String	Cluster ID

3. Output Parameters

Parameter Name	Type	Description
ClusterInfo	RocketMQClusterInfo	Cluster information
ClusterConfig	RocketMQClusterConfig	Cluster configuration
ClusterStats	RocketMQClusterRecentStats	Cluster recent usage, about to be deprecated. Use TCOP to obtain related data. Note: This field may return null, indicating that no valid values can be obtained.
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 Retrieving RocketMQ Cluster Details

This example shows you how to get the details of a RocketMQ cluster.

Input Example

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

{
    "ClusterId": "rocketmq-rd3545bkkj49"
}

Output Example

{
    "Response": {
        "RequestId": "c6d158b6-89b2-40d1-b1f6-5973f0f00cd5",
        "ClusterInfo": {
            "ClusterId": "rocketmq-rd3545bkkj49",
            "ClusterName": "test-example",
            "Region": "ap-beijing",
            "CreateTime": 1620321019000,
            "Remark": "modified",
            "PublicEndPoint": "pulsar://xxxxx.com:6650",
            "VpcEndPoint": "pulsar://xxxxx.com:6650",
            "Vpcs": [
                {
                    "SubnetId": "subnet-123",
                    "VpcId": "vpc-12333"
                }
            ],
            "SupportNamespaceEndpoint": true,
            "RocketMQFlag": true,
            "IsVip": true,
            "IsolateTime": 0,
            "Status": 1,
            "AclEnabled": true,
            "InternalEndpoint": "",
            "HttpInternalEndpoint": "",
            "HttpVpcEndpoint": "",
            "HttpPublicEndpoint": ""
        },
        "ClusterConfig": {
            "MaxTpsPerNamespace": 8000,
            "UsedNamespaceNum": 1,
            "MaxTopicNum": 1000,
            "UsedTopicNum": 2,
            "MaxGroupNum": 10000,
            "UsedGroupNum": 1,
            "MaxRetentionTime": 1296000000,
            "MaxLatencyTime": 3456000000,
            "MaxNamespaceNum": 10,
            "MaxQueuesPerTopic": 1,
            "TopicDistribution": []
        },
        "ClusterStats": {
            "TopicNum": 2,
            "ProducedMsgNum": 0,
            "ConsumedMsgNum": 0,
            "AccumulativeMsgNum": 0
        }
    }
}

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