tencent cloud



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

1. API Description

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

This API is used to get topic list details (only for call in the console).

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: DescribeTopicDetail.
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 Instance ID
SearchWord No String (Filter) 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. This value must be greater than 0
AclRuleName No String Name of the preset ACL rule.

3. Output Parameters

Parameter Name Type Description
Result TopicDetailResponse Returned entity of topic details
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting topic list details

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "Result": {
            "TopicList": [
                    "TopicName": "test",
                    "TopicId": "inter-topic-d7a2f7fq",
                    "PartitionNum": 3,
                    "ReplicaNum": 2,
                    "Note": "",
                    "CreateTime": 1561637447,
                    "EnableWhiteList": false,
                    "IpWhiteListCount": 0,
                    "ForwardCosBucket": "",
                    "ForwardStatus": 1,
                    "ForwardInterval": 0,
                    "Config": {
                        "Retention": 300000000
                    "RetentionTimeConfig": {
                        "Expect": 1440,
                        "Current": 480,
                        "ModTimeStamp": 1561637447
            "TotalCount": 12
        "RequestId": "98fdae03-9bc2-4c2e-b429-0a96cca7144b"

5. Developer Resources


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.SubnetNotBelongToZone The subnet is not in the zone.
InvalidParameterValue.WrongAction The value of the Action parameter is incorrect.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation Unauthorized operation.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.OssReject Oss rejected the operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support