DescribeConsumerGroup
最后更新时间：2025-11-21 20:32:34
1. API Description
Domain name for API request: ckafka.intl.tencentcloudapi.com.
This API is used to query consumer group information.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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: DescribeConsumerGroup. |
| Version | Yes | String | Common Params. The value used for this API: 2019-08-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | ckafka cluster instance Id. obtain through the API DescribeInstances. |
| GroupName | No | String | Specifies the group name you want to query. |
| TopicName | No | String | Specifies the corresponding topic name in the group to be queried by the user. if this parameter is specified while the group is unspecified, ignore this parameter. |
| Limit | No | Integer | Returns the limit quantity of the consumption group. supports a maximum of 50. |
| Offset | No | Integer | Specifies the starting offset amount of the consumer group list. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Result | ConsumerGroupResponse | Returned 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. |
4. Example
Example1 Listing Consumption Groups
Input Example
https://ckafka.intl.tencentcloudapi.com/?Action=DescribeConsumerGroup
&InstanceId=ckafka-test
&<Common request parameters>Output Example
{
"Response": {
"RequestId": "e59b15f1-8c26-4f28-8d7a-31fdbb5d2e90",
"Result": {
"GroupList": [
{
"ConsumerGroupName": "hh",
"SubscribedInfo": [
{
"Partition": [
0,
1,
2
],
"PartitionOffset": [
{
"Offset": 3395,
"Partition": "0"
},
{
"Offset": 3269,
"Partition": "1"
},
{
"Offset": 3336,
"Partition": "2"
}
],
"TopicId": "topic-brany0f0",
"TopicName": "dev"
},
{
"Partition": [
0,
1,
2
],
"PartitionOffset": [
{
"Offset": 2110,
"Partition": "0"
},
{
"Offset": 2239,
"Partition": "1"
},
{
"Offset": 2197,
"Partition": "2"
}
],
"TopicId": "topic-4f78nggi",
"TopicName": "te"
}
]
},
{
"ConsumerGroupName": "tes",
"SubscribedInfo": [
{
"Partition": [
0,
1,
2
],
"PartitionOffset": [
{
"Offset": 3395,
"Partition": "0"
},
{
"Offset": 3269,
"Partition": "1"
},
{
"Offset": 3336,
"Partition": "2"
}
],
"TopicId": "topic-brany0f0",
"TopicName": "dev"
},
{
"Partition": [
0,
1,
2
],
"PartitionOffset": [
{
"Offset": 1409,
"Partition": "0"
},
{
"Offset": 1474,
"Partition": "1"
},
{
"Offset": 1453,
"Partition": "2"
}
],
"TopicId": "topic-4f78nggi",
"TopicName": "te"
}
]
},
{
"ConsumerGroupName": "vv",
"SubscribedInfo": [
{
"Partition": [
0,
1,
2
],
"PartitionOffset": [
{
"Offset": 3395,
"Partition": "0"
},
{
"Offset": 3269,
"Partition": "1"
},
{
"Offset": 3336,
"Partition": "2"
}
],
"TopicId": "topic-brany0f0",
"TopicName": "dev"
}
]
}
],
"GroupListForMonitor": [
{
"GroupName": "hh"
},
{
"GroupName": "tes"
},
{
"GroupName": "vv"
}
],
"PartitionListForMonitor": [],
"TopicList": [
{
"TopicId": "topic-brany0f0",
"TopicName": "dev"
},
{
"TopicId": "topic-4f78nggi",
"TopicName": "te"
}
],
"TopicListForMonitor": [
{
"TopicId": "topic-brany0f0",
"TopicName": "dev"
},
{
"TopicId": "topic-4f78nggi",
"TopicName": "te"
}
],
"TotalCount": 3,
"TotalPartition": 0,
"TotalTopic": 2
}
}
}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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 | Invalid parameter. |
| InvalidParameterValue.InstanceNotExist | The instance does not exist. |
| InvalidParameterValue.RepetitionValue | The parameter already exists. |
| InvalidParameterValue.SubnetIdInvalid | Invalid subnet ID. |
| InvalidParameterValue.SubnetNotBelongToZone | The subnet is not in the zone. |
| InvalidParameterValue.VpcIdInvalid | Invalid VPC ID. |
| InvalidParameterValue.WrongAction | The value of the Action parameter is incorrect. |
| InvalidParameterValue.ZoneNotSupport | The zone is not supported. |
| ResourceUnavailable | The resource is unavailable. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation.BatchDelInstanceLimit | The batch instance deletion limit is reached. |
| UnsupportedOperation.OssReject | Oss rejected the operation. |
文档反馈