DescribeTopicSubscribeGroup

Last updated: 2021-09-01 10:18:26

1. API Description

Domain name for API request: ckafka.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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: ckafka.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeTopicSubscribeGroup.
Version Yes String Common parameter. The value used for this API: 2019-08-19.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String 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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Searching and subscribing the message group information of a topic

Input Example

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

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

Output Example

{
  "Response": {
    "Result": {
      "Status": 0,
      "TotalCount": 1,
      "StatusCountInfo": "xx",
      "GroupsInfo": [
        {
          "Protocol": "xx",
          "ProtocolType": "xx",
          "ErrorCode": "xx",
          "State": "xx",
          "Members": [
            {
              "ClientHost": "xx",
              "MemberId": "xx",
              "ClientId": "xx",
              "Assignment": {
                "Topics": [
                  {
                    "Topic": "xx",
                    "Partitions": [
                      0
                    ]
                  }
                ],
                "Version": 0
              }
            }
          ],
          "Group": "xx"
        }
      ]
    },
    "RequestId": "xx"
  }
}

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 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.