DescribeConsumerLag

最后更新时间：2026-01-13 21:52:14

DescribeConsumerLag

最后更新时间： 2026-01-13 21:52:14

1. API Description

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

This API is used to query the number of heaped messages in a specified consumer group.

A maximum of 200 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: DescribeConsumerLag.
Version	Yes	String	Common Params. The value used for this API: 2023-03-08.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	TDMQ RocketMQ instance ID. It can be obtained from the API DescribeFusionInstanceList or the console.
ConsumerGroup	No	String	Consumer group name. It can be obtained from ConsumeGroupItem returned by the API DescribeConsumerGroupList or from the console.
Namespace	No	String	Namespace. It is required for 4.x clusters. The namespace can be obtained from RocketMQNamespace returned by the API DescribeRocketMQNamespaces or from the console.
SubscribeTopic	No	String	Subscribed topic. If it is not left blank, query heaped messages of consumer groups subscribing to the topic. The topic can be obtained from TopicItem returned by the API DescribeTopicList or from the console.

3. Output Parameters

Parameter Name	Type	Description
ConsumerLag	Integer	Number of heaped messages.
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 Normal Response

Query the accumulation of successes for the designated client

Input Example

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

{
    "InstanceId": "rmq-24kzek2b",
    "ConsumerGroup": "test_group"
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "ConsumerLag": 260,
        "RequestId": "2b9eef15-a8bc-47a3-9445-9edcafccb459"
    }
}

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
ResourceNotFound.Instance	The instance does not exist.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud