Domain name for API request: trocket.intl.tencentcloudapi.com.
Get the consumer group list. The Filter parameter usage instructions are as follows:
-ConsumerGroupName, the consumer group name, supports fuzzy query and can be obtained from the ConsumeGroupItem in the API response of DescribeConsumerGroupList or the console.
-ConsumeMessageOrderly, shipping order, enumeration value as follows:
-ordered delivery
-Concurrent delivery: false.
-RetryPolicy, retry policy, enumeration values as follows:
-EXPONENTIAL: fixed interval
-CUSTOMIZED: Tier backoff
Example of Filters:
[{ "Name": "ConsumeMessageOrderly", "Values": ["true"] }]
This API is applicable to 5.x clusters. For 4.x clusters, refer to the REST API documentation DescribeRocketMQGroups to get the consumer group list.
A maximum of 10000 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: DescribeConsumerGroupList. |
| 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. |
| TagFilters.N | No | Array of TagFilter | Tag filter |
| Filters.N | No | Array of Filter | Filtering condition list. See the description of the API using this parameter for the usage method. |
| Offset | No | Integer | Starting position of the query. Default value: 0. |
| Limit | No | Integer | Maximum number of queried results. Default value: 20. |
| FromTopic | No | String | Queries consumer groups under a specified topic. |
| SortedBy | No | String | Sort by specified field, with the enumerated values as follows: -subscribeNum: Number of topics subscribed |
| SortOrder | No | String | Sort in ascending or descending order, with the enumerated values as follows: -asc: Ascending - DESC: descending order. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total query count |
| Data | Array of ConsumeGroupItem | Consumer group list |
| 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. |
This API is used to obtain the consumer group list.
POST / HTTP/1.1
Host: trocket.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConsumerGroupList
<Common request parameters>
{
"InstanceId": "rmq-72mo3a9o",
"Offset": 0,
"Limit": 1
}
{
"Error": null,
"RequestId": null,
"Response": {
"Data": [
{
"ConsumeEnable": true,
"ConsumeMessageOrderly": true,
"ConsumerGroup": "test_group",
"InstanceId": "rmq-72mo3a9o",
"MaxRetryTimes": 16,
"Remark": "Test consumption group",
"ClusterIdV4": null,
"NamespaceV4": null,
"ConsumerGroupV4": null,
"FullNamespaceV4": null
}
],
"RequestId": "318142bf-0dd1-4b81-9444-a40f988619a1",
"TotalCount": 1
}
}
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 |
|---|---|
| ResourceNotFound.Instance | The instance does not exist. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan