Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to obtain the consumer group list.
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: DescribeConsumerGroups. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| LogsetId | Yes | String | Logset ID (the logset to which a log topic belongs). |
| Topics.N | No | Array of String | topic list |
| Parameter Name | Type | Description |
|---|---|---|
| ConsumerGroupsInfo | Array of ConsumerGroupInfo | List of consumer group details. |
| 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. |
Querying Consumer Group Information
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConsumerGroups
<Common request parameters>
{
"LogsetId": "6f6ded3f-948c-4616-9c7c-956a95d8c1a3",
"Topics": [
"6f6ded3f-948c-4616-9c7c-956a95d8c1a3"
]
}
{
"Response": {
"ConsumerGroupsInfo": [
{
"ConsumerGroup": "test-123",
"Timeout": 1,
"Topics": [
"6f6ded3f-948c-4616-9c7c-956a95d8c1a3"
]
}
],
"RequestId": "6f6ded3f-948c-4616-9c7c-956a95d8c1a3"
}
}
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. |
| OperationDenied | Operation denied. |
| OperationDenied.ACLFailed | ACL verification failed. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
文档反馈