DescribeTopicList

Last updated:2026-01-13 21:52:02

DescribeTopicList

Last updated: 2026-01-13 21:52:02

1. API Description

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

This API is used to search the topic list. Filter parameter usage instructions are as follows:.

-TopicName supports fuzzy search. Obtain it from the TopicItem in the DescribeTopicList API response or the console.
-Search by TopicType, support multiple selections. See the TopicType field in the DescribeTopic API.

This API is used to demonstrate Filters.
[{ "Name": "TopicName", "Values": ["test_topic"] }]

A maximum of 20 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: DescribeTopicList.
Version	Yes	String	Common Params. The value used for this API: 2023-03-08.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	TDMQ RocketMQ instance ID. It can be obtained from the API DescribeFusionInstanceList or the console.
TagFilters.N	No	Array of TagFilter	Tag filter
Filters.N	No	Array of Filter	Filtering condition list. See the description of the API using this parameter for the usage method.
Offset	No	Integer	Starting position of the query. Default value: 0.
Limit	No	Integer	Maximum number of queried results. Default value: 20.
FromGroup	No	String	Queries subscribed topics by consumer group.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total query count
Data	Array of TopicItem	Topic list.
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 Query Topic List

This example shows you how to query topic list.

Input Example

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

{
    "InstanceId": "rmq-72mo3a9o",
    "Offset": 0,
    "Limit": 20
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Data": [
            {
                "InstanceId": "rmq-72mo3a9o",
                "QueueNum": 16,
"Remark": "Test topic"
                "Topic": "test_topic",
                "TopicType": "NORMAL"
            }
        ],
        "RequestId": "927cbd2c-be83-410e-a83f-24dcea1d88d9",
        "TotalCount": 1
    }
}

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
ResourceNotFound.Instance	The instance does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud