Domain name for API request: tdmq.intl.tencentcloudapi.com.
Query the RocketMQ topic list.
This API is applicable to clusters: 4.x virtual cluster, 4.x dedicated cluster, and 4.x generic cluster. For 5.x clusters, refer to the API documentation DescribeTopicList.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeRocketMQTopics. |
| Version | Yes | String | Common Params. The value used for this API: 2020-02-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Offset | Yes | Integer | Offset for query. |
| Limit | Yes | Integer | Query limit. |
| ClusterId | Yes | String | Cluster ID. |
| NamespaceId | Yes | String | Namespace of the topic. For 4.x common clusters, the Cluster Namespace is fixed as: tdmq_default |
| FilterType.N | No | Array of String | Filter by topic type. Valid values: Normal, GlobalOrder, PartitionedOrder, Transaction. |
| FilterName | No | String | Search by topic name. Fuzzy query is supported. |
| FilterGroup | No | String | Filters by subscription consumer group name. |
| TagFilters.N | No | Array of TagFilter | Tag filter |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | The total number of query records. |
| Topics | Array of RocketMQTopic | List of topic information |
| 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. |
POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRocketMQTopics
<Common request parameters>
{
"Offset": 1,
"Limit": 1,
"ClusterId": "rocketmq-2p9vx3ax9jxg",
"NamespaceId": "test_ns",
"FilterGroup": "test_group"
}
{
"Response": {
"RequestId": "c017c4d1-13cb-4f14-ab89-2c6530892f90",
"TotalCount": 1,
"Topics": [
{
"Name": "test_topic",
"Type": "Normal",
"GroupNum": 1,
"Remark": "Test topic"
"PartitionNum": 3,
"CreateTime": 1621308465000,
"UpdateTime": 1621308657000,
"InstanceId": "rocketmq-2p9vx3ax9jxg",
"Namespace": "test_ns"
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| InternalError.IllegalMessage | Internal error. |
| InvalidParameter | Incorrect parameter. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.BrokerCluster | The service cluster does not exist. |
| ResourceNotFound.Cluster | The cluster does not exist. |
| ResourceUnavailable | The resource is unavailable. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback