新功能发布记录
公告
Domain name for API request: trocket.intl.tencentcloudapi.com.
Query the message list. If querying dead letter messages, set the ConsumerGroup parameter.
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: DescribeMessageList. |
| 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. |
| StartTime | Yes | Integer | Start time for querying messages. It is a Unix timestamp (ms). |
| EndTime | Yes | Integer | End time for querying messages. It is a Unix timestamp (ms). |
| TaskRequestId | Yes | String | Query identifier. For the first query, input a null string. If the query results involve pagination, use the TaskRequestId value in the previous request response as the value of this input parameter for requesting data on the next page. |
| Offset | No | Integer | Starting position of the query. Default value: 0. |
| Limit | No | Integer | Maximum number of queried results. Default value: 20. |
| ConsumerGroup | No | String | Consumer group name. It can be obtained from ConsumeGroupItem returned by the API DescribeConsumerGroupList or from the console. |
| MsgId | No | String | Message ID. It can be obtained from MessageItem returned by the API DescribeMessageList or from the workload logs. |
| MsgKey | No | String | Message key. It can be obtained from MessageItem returned by the API DescribeMessageList or from workload logs. |
| RecentMessageNum | No | Integer | Query the last N messages. The value of N cannot exceed 1024. By default, -1 indicates other query conditions. |
| QueryDeadLetterMessage | No | Boolean | Whether to query dead letter messages. Default value: false. |
| Tag | No | String | Message tag. It can be obtained from MessageItem returned by the API DescribeMessageList or from workload logs. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total query count |
| Data | Array of MessageItem | Message record list Note: This field may return null, indicating that no valid values can be obtained. |
| TaskRequestId | String | One-time query ID Note: This field may return null, indicating that no valid values can be obtained. |
| 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: trocket.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMessageList
<Common request parameters>
{
"InstanceId": "rmq-72mo3a9o",
"Topic": "topic",
"Offset": 0,
"Limit": 1,
"MsgId": "1EAE3915000721B8D17C2C5BB31638D1",
"StartTime": 1683613796174,
"EndTime": 1683613796174,
"TaskRequestId": "901a6956-1ab9-7fb7-3bf5-9f02b7aa2a7d"
}{
"Error": null,
"RequestId": null,
"Response": {
"Data": [
{
"DeadLetterResendSuccessTimes": null,
"DeadLetterResendTimes": null,
"Keys": "test_key",
"MsgId": "1EAE3915000721B8D17C2C5BB31638D1",
"ProduceTime": "2023-05-09 14:43:27",
"ProducerAddr": "30.174.57.21",
"Tags": "test_tag"
}
],
"RequestId": "7426c613-085b-48c4-9257-87a208a8adcc",
"TaskRequestId": "901a6956-1ab9-7fb7-3bf5-9f02b7aa2a7d",
"TotalCount": 1
}
}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. |
文档反馈