Domain name for API request: cls.intl.tencentcloudapi.com.
Retrieve the information list of Kafka protocol consumption 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: DescribeKafkaConsumerGroupList. |
| 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. |
| TopicId | Yes | String | Log topic ID. -Obtain the log topic Id through Get Log Topic List. |
| Filters.N | No | Array of Filter | - group Filter by [consumer group name]. Type: String Required: No Example: Consumption group 1 Each request can have up to 10 Filters. The upper limit of Filter.Values is 10. |
| Offset | No | Integer | Page offset. Default value: 0 |
| Limit | No | Integer | Maximum number of entries per page. Default value: 20. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TopicName | String | log topic name |
| LogsetId | String | Logset id |
| Total | Integer | Total number |
| Groups | Array of ConsumerGroup | List of consumer group information |
| 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. |
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKafkaConsumerGroupList
<Common request parameters>
{
"TopicId": "5023192e-1254139626",
"Offset": 0,
"Limit": 1
}
{
"Response": {
"Groups": [
{
"Group": "same_group_id",
"ProtocolName": "",
"State": "Empty"
}
],
"LogsetId": "a8248746-c989-468e-b931-a9bf6c999c89",
"RequestId": "53ac1397-336a-4d4b-87ff-a2a16ff97519",
"TopicName": "1254139626-5023192e",
"Total": 2
}
}
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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation | Operation failed. |
| FailedOperation.Timeout | Operation timed out |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing 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. |
| ResourceNotFound.TopicNotExist | The log topic does not exist. |
文档反馈