tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeConsumerGroup

Last updated: 2023-07-05 15:57:44

1. API Description

Domain name for API request: ckafka.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 instance ID.
GroupName No String Name of the group to be queried, which is optional.
TopicName No String Name of the corresponding topic in the group to be queried, which is optional. If this parameter is specified but group is not specified, this parameter will be ignored.
Limit No Integer Number of results to be returned in this request
Offset No Integer Offset position

3. Output Parameters

Parameter Name Type Description
Result ConsumerGroupResponse Returned consumer group information
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Listing consumer groups

Input Example

https://ckafka.tencentcloudapi.com/?Action=DescribeConsumerGroup
&InstanceId=10
&<Common request parameters>

Output Example

{
    "Response": {
        "Result": {
            "TotalCount": 2,
            "TopicList": [
                {
                    "TopicId": "topic-g8ud11it",
                    "TopicName": "connect-offset"
                }
            ],
            "GroupList": [
                {
                    "ConsumerGroupName": "connect-cluster-1",
                    "SubscribedInfo": []
                },
                {
                    "ConsumerGroupName": "qcloud_tocos",
                    "SubscribedInfo": [
                        {
                            "TopicName": "connect-offset",
                            "PartitionOffset": [
                                {
                                    "Partition": "0",
                                    "Offset": 966186803
                                },
                                {
                                    "Partition": "1",
                                    "Offset": 968552882
                                },
                                {
                                    "Partition": "2",
                                    "Offset": 957792934
                                }
                            ]
                        }
                    ]
                }
            ],
            "TotalPartition": 0,
            "PartitionListForMonitor": [],
            "TotalTopic": 1,
            "TopicListForMonitor": [
                {
                    "TopicId": "topic-g8ud11it",
                    "TopicName": "connect-offset"
                }
            ],
            "GroupListForMonitor": [
                {
                    "GroupName": "connect-cluster-1"
                },
                {
                    "GroupName": "qcloud_tocos"
                }
            ]
        },
        "RequestId": "3c8a91a3-5921-4d7f-9fd9-6b4261cca363"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy