DescribeTopicSubscribeGroup

最后更新时间：2025-11-21 20:32:24

DescribeTopicSubscribeGroup

最后更新时间： 2025-11-21 20:32:24

1. API Description

Domain name for API request: ckafka.intl.tencentcloudapi.com.

This API is used to search and subscribe the message group information of a topic.

A maximum of 10 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: DescribeTopicSubscribeGroup.
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	The ckafka cluster instance Id.
TopicName	Yes	String	Topic name
Offset	No	Integer	Starting position of paging
Limit	No	Integer	Number of results per page

3. Output Parameters

Parameter Name	Type	Description
Result	TopicSubscribeGroup	Returned results
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 Querying Subscription Topic Message Group Information

Input Example

POST / HTTP/1.1
Host: ckafka.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopicSubscribeGroup
<Common request parameters>

{
    "InstanceId": "ckafka-kmex0nvv",
    "TopicName": "topic-test"
}

Output Example

{
    "Response": {
        "Result": {
            "Status": 1,
            "TotalCount": 2,
            "StatusCountInfo": "1 Empty, 1 Stable",
            "GroupsInfo": [
                {
                    "Protocol": "",
                    "ProtocolType": "",
                    "ErrorCode": "0",
                    "State": "Empty",
                    "Members": [],
                    "Group": "xx1"
                },
                {
                    "Protocol": "roundrobin",
                    "ProtocolType": "consumer",
                    "ErrorCode": "0",
                    "State": "Stable",
                    "Members": [
                        {
                            "ClientHost": "10.0.0.0",
                            "MemberId": "consumer-63-/10.0.0.0-2022-07-31 19:09:08:169-73e4xx82-4c42-4ccf-8d01-7c74c8xxxxx2",
                            "ClientId": "consumer-63",
                            "Assignment": {
                                "Topics": [
                                    {
                                        "Topic": "xx_topic",
                                        "Partitions": [
                                            10
                                        ]
                                    }
                                ],
                                "Version": 0
                            }
                        }
                    ],
                    "Group": "xx2"
                }
            ]
        },
        "RequestId": "91b6b112-7f0a-4e18-b353-5202bcafd2c2"
    }
}

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

Tencent Cloud CLI 3.0

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	Invalid parameter value.
InvalidParameterValue.InstanceNotExist	The instance does not exist.
InvalidParameterValue.NotAllowedEmpty	The parameter is required.
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.
OperationDenied	Operation denied.
RequestLimitExceeded	The number of requests exceeds the frequency limit.
UnauthorizedOperation	Unauthorized operation.
UnknownParameter	Unknown parameter error.
UnsupportedOperation	Unsupported operation.
UnsupportedOperation.BatchDelInstanceLimit	The batch instance deletion limit is reached.
UnsupportedOperation.OssReject	Oss rejected the operation.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud