Domain name for API request: cls.intl.tencentcloudapi.com.
Retrieve Kafka protocol consumption group details
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: DescribeKafkaConsumerGroupDetail. |
| 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. |
| Group | Yes | String | Consumer group name |
| Parameter Name | Type | Description |
|---|---|---|
| LogsetId | String | Logset id |
| Group | String | Consumer group name |
| PartitionInfos | Array of GroupPartitionInfo | List of consumer group information |
| State | String | Empty: The group has no members but has submitted offsets. All consumers have left but retained offsets. Dead: No members in the group and no submitted offset. The group is deleted or has long-term inactivity. Stable: Members in the group consume normally, and partition allocation is balanced. Normal operating status. PreparingRebalance: The group is preparing to rebalance. A new member joins or an existing member leaves. CompletingRebalance: The group is preparing to rebalance. New members join or existing members leave. |
| 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: DescribeKafkaConsumerGroupDetail
<Common request parameters>
{
"TopicId": "5023192e-1254139626",
"Group": "same_group_id"
}
{
"Response": {
"Group": "same_group_id",
"LogsetId": "a8248746-c989-468e-b931-a9bf6c999c89",
"PartitionInfos": [
{
"CommitTimestamp": 3223609680,
"Consumer": "",
"PartitionId": 0
},
{
"CommitTimestamp": 3223609680,
"Consumer": "",
"PartitionId": 1
},
{
"CommitTimestamp": 3223609680,
"Consumer": "",
"PartitionId": 2
},
{
"CommitTimestamp": 3223609680,
"Consumer": "",
"PartitionId": 3
},
{
"CommitTimestamp": 3223609680,
"Consumer": "",
"PartitionId": 4
},
{
"CommitTimestamp": 3223609680,
"Consumer": "",
"PartitionId": 5
},
{
"CommitTimestamp": 3223609680,
"Consumer": "",
"PartitionId": 6
}
],
"RequestId": "b4a11979-760c-42e2-92b8-5945eb93ee98",
"State": "Empty"
}
}
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. |
피드백