DescribeConsumerGroup

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

DescribeConsumerGroup

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

1. API Description

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

Query consumer group details.

A maximum of 10000 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: DescribeConsumerGroup.
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.

3. Output Parameters

Parameter Name	Type	Description
ConsumerNum	Integer	Number of online consumers.
Tps	Integer	TPS
ConsumerLag	Integer	Specifies the number of accumulated messages.
ConsumeType	String	Consumption type. valid values as follows:. -PULL: specifies the pull consumption type. -PUSH: specifies the push consumption type. -POP: specifies the pop consumption type.
CreatedTime	Integer	Creation time. It is a Unix timestamp (ms).
ConsumeMessageOrderly	Boolean	Specifies whether to use ordered delivery. valid values: true. Concurrent delivery: false.
ConsumeEnable	Boolean	Whether to enable consumption.
MaxRetryTimes	Integer	Maximum number of retries.
Remark	String	Remarks
MessageModel	String	Specifies the consumption mode. BROADCASTING. CLUSTERING cluster mode.
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 Query consumer group details.

This example shows you how to query consumer details.

Input Example

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

{
    "InstanceId": "rmq-72mo3a9o",
    "ConsumerGroup": "group"
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "ConsumeEnable": true,
        "ConsumeMessageOrderly": false,
        "ConsumeType": "PUSH",
        "ConsumerLag": 1580,
        "ConsumerNum": 2,
        "CreatedTime": 1683613488000,
        "MaxRetryTimes": 16,
"Remark": "Test consumption group"
        "RequestId": "bc4ffab1-65cc-4ef6-9114-0de06c333b84",
        "Tps": 60
    }
}

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.Group	Consumer group does not exist. Please check and try again.
ResourceNotFound.Instance	The instance does not exist.

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

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

是

否

文档反馈

tencent cloud