DescribeRocketMQGroups

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

DescribeRocketMQGroups

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

1. API Description

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

This API is used to get the list of RocketMQ consumer groups.

A maximum of 500 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: DescribeRocketMQGroups.
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.
NamespaceId	Yes	String	Namespace.
Offset	Yes	Integer	Offset.
Limit	Yes	Integer	The max number of returned results.
FilterTopic	No	String	Topic name, which can be used to query all subscription groups under the topic
FilterGroup	No	String	Consumer group query by consumer group name. Fuzzy query is supported
SortedBy	No	String	Sorts by the specified field. Valid value: subscribeNum: number of subscribed topics.
SortOrder	No	String	Sort in ascending or descending order. Valid values: `asc`, `desc`.
FilterOneGroup	No	String	Subscription group name. After it is specified, the information of only this subscription group will be returned.
Types.N	No	Array of String	Group type
TagFilters.N	No	Array of TagFilter	Tag filter

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	The total number of subscription groups.
Groups	Array of RocketMQGroup	List of subscription groups
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 Querying Subscription Group List

test

Input Example

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

{
    "ClusterId": "rocketmq-4k4orqgq",
    "NamespaceId": "test_ns",
    "Offset": 0,
    "Limit": 20,
    "FilterTopic": "test_topic",
    "FilterGroup": "test_group",
    "SortedBy": "tps",
    "SortOrder": "asc",
    "FilterOneGroup": "test_group",
    "Types": [
        "TCP"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "1c127300-fcdd-4087-b1d2-fd75a1cefbe4",
        "TotalCount": 1,
        "Groups": [
            {
                "InstanceId": "rocketmq-4k4orqgq",
                "Namespace": "test_ns",
                "Name": "test_group",
                "ConsumerNum": 1,
                "TotalAccumulative": 380,
                "RetryMaxTimes": 10,
                "ConsumptionMode": -1,
                "BroadcastEnabled": false,
                "ReadEnabled": true,
                "RetryPartitionNum": 1,
                "CreateTime": 1621307489000,
                "UpdateTime": 1621307706000,
                "ClientProtocol": "TCP",
                "Remark": "Test consumption group",
                "ConsumerType": "PUSH",
                "TPS": 20,
                "GroupType": "TCP",
                "SubscribeTopicNum": "1"
            }
        ]
    }
}

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	Internal error.
InvalidParameter	Incorrect parameter.
ResourceInUse	The resource is in use.
ResourceNotFound	The resource does not exist.
ResourceNotFound.Cluster	The cluster does not exist.
ResourceUnavailable	The resource is unavailable.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud