Documentation|Tencent Cloud

Recent Pages

DescribeTopic

Last updated: 2020-07-31 10:00:20

1. API Description

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

API domain name: https://ckafka.tencentcloudapi.com
This API is used to get the list of topics in a CKafka instance of a user.

A maximum of 100 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: DescribeTopic.
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
SearchWord	No	String	Filter by `topicName`. Fuzzy search is supported
Offset	No	Integer	Offset. If this parameter is left empty, 0 will be used by default
Limit	No	Integer	Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 20

3. Output Parameters

Parameter Name	Type	Description
Result	TopicResult	Returned result Note: this field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the list of topics in instance

Input Example

https://ckafka.tencentcloudapi.com/?Action=DescribeTopic
&InstanceId=ckafka-xxooa0
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": {
      "TopicList": [
        {
          "TopicId": "inter-topic-8sj6wxwi",
          "TopicName": "test1",
          "Note": ""
        },
        {
          "TopicId": "inter-topic-844bkmry",
          "TopicName": "test10",
          "Note": ""
        }
      ],
      "TotalCount": 12
    },
    "RequestId": "8d7551b2-651e-4f47-80bc-13a478fda732"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

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