tencent cloud

DescribeRocketMQTopUsages
Last updated: 2025-11-25 10:52:53
DescribeRocketMQTopUsages
Last updated: 2025-11-25 10:52:53

1. API Description

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

Used to obtain the RocketMQ metric sorting list, such as sorting topics under a cluster instance by the most occupied storage space.

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: DescribeRocketMQTopUsages.
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
MetricName Yes String Metric name. support the following:.
consumeLag. specifies the consumer group backlog count.
deadLetterCount. specifies the dead letter count.
Topic production rate.
Topic consumption rate. specifies the Topic consumption rate.
topicStorageSize. specifies the Topic storage space.
Topic API call count.
Limit Yes Integer Sort quantity. The maximum value is 20.

3. Output Parameters

Parameter Name Type Description
Values Array of Integer Metric Value List
Dimensions Array of DimensionInstance Dimension combinations corresponding to metric value. this API has the following dimensions:.
tenant,namespace,group,topic
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 Group Heaped Messages Sorting Order

Input Example

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

{
    "ClusterId": "rocketmq-abc",
    "MetricName": "consumeLag",
    "Limit": 1
}

Output Example

{
    "Response": {
        "Dimensions": [
            {
                "Dimensions": [
                    {
                        "Name": "tenant",
                        "Value": "rocketmq-vvqb9emabapx"
                    },
                    {
                        "Name": "namespace",
                        "Value": "test_ns"
                    },
                    {
                        "Name": "topic",
                        "Value": "test_topic"
                    }
                ]
            },
            {
                "Dimensions": [
                    {
                        "Name": "tenant",
                        "Value": "rocketmq-vvqb9emabapx"
                    },
                    {
                        "Name": "namespace",
                        "Value": "test_ns"
                    },
                    {
                        "Name": "topic",
                        "Value": "test_topic2"
                    }
                ]
            }
        ],
        "RequestId": "f0288e86-ee7d-4a73-a788-81ca6680b06c",
        "Values": [
            309,
            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

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
ResourceNotFound.Cluster The cluster does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback