新功能发布记录
公告
Domain name for API request: trocket.intl.tencentcloudapi.com.
This API is used to query topic details. The Offset and Limit parameters are pagination parameters for consumer groups subscribing to this topic. The Filter parameter usage instructions are as follows:.
-The ConsumerGroup name can be obtained from the ConsumeGroupItem in the API response of DescribeConsumerGroupList or from the console.
This API is used to demonstrate Filters.
[{ "Name": "ConsumerGroup", "Values": ["test_group"] }]
A maximum of 200 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: DescribeTopic. |
| 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. |
| Topic | Yes | String | Topic name. It can be obtained from TopicItem returned by the API DescribeTopicList or from the console. |
| 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. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| Topic | String | Topic name |
| TopicType | String | Topic type. UNSPECIFIED: not specified. NORMAL: normal message. FIFO: sequential message. DELAY: delayed message. TRANSACTION: transaction message. |
| Remark | String | Remarks |
| CreatedTime | Integer | Creation time. It is a Unix timestamp (ms). |
| LastUpdateTime | Integer | Last write time. It is a Unix timestamp (ms). |
| SubscriptionCount | Integer | Number of Subscriptions |
| SubscriptionData | Array of SubscriptionData | Subscribe to the relationship list. |
| MsgTTL | Integer | Message retention period. Unit: hour. |
| 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. |
This example shows you how to query topic details.
POST / HTTP/1.1
Host: trocket.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopic
<Common request parameters>
{
"InstanceId": "rmq-72mo3a9o",
"Topic": "test_topic",
"Offset": 0,
"Limit": 10
}{
"Error": null,
"RequestId": null,
"Response": {
"CreatedTime": 1683601674000,
"InstanceId": "rmq-72mo3a9o",
"LastUpdateTime": 1683601674000,
"Remark": "Test topic"
"RequestId": "f7f7ba8a-4335-4adb-9186-680b91502c42",
"SubscriptionCount": 0,
"SubscriptionData": [],
"Topic": "test_topic",
"TopicType": "NORMAL"
}
}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 |
|---|---|
| ResourceNotFound.Instance | The instance does not exist. |
| ResourceNotFound.Topic | Topic does not exist. Please check and try again. |
文档反馈