Domain name for API request: tdmq.tencentcloudapi.com.
This API is used to get the list of RocketMQ consumer groups.
A maximum of 20 requests can be initiated per second for this API.
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 | No | String | Common Params. This parameter is not required for this API. |
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 | Sort by specified field. Valid values: tps , accumulative . |
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 |
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, which is returned for each request. RequestId is required for locating a problem. |
test
{
"ClusterId": "xx",
"NamespaceId": "xx",
"Offset": 1,
"Limit": 1,
"FilterTopic": "xx",
"FilterGroup": "xx",
"SortedBy": "xx",
"SortOrder": "xx",
"FilterOneGroup": "xx",
"Types": [
"xx"
]
}
{
"Response": {
"RequestId": "1c127300-fcdd-4087-b1d2-fd75a1cefbe4",
"TotalCount": 1,
"Groups": [
{
"Name": "group-example",
"ConsumerNum": 0,
"TotalAccumulative": 0,
"ConsumptionMode": -1,
"BroadcastEnabled": false,
"ReadEnabled": true,
"RetryPartitionNum": 0,
"CreateTime": 1621307489000,
"UpdateTime": 1621307706000,
"ClientProtocol": "TCP",
"Remark": "modified",
"ConsumerType": "",
"TPS": 0,
"GroupType": "TCP"
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
本页内容是否解决了您的问题?