tencent cloud

DescribeMessageTrace
最后更新时间：2026-01-13 21:52:07
DescribeMessageTrace
最后更新时间： 2026-01-13 21:52:07

1. API Description

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

This API is used to query message trace by message ID.

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: DescribeMessageTrace.
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.
MsgId Yes String Message ID. It can be obtained from MessageItem returned by the API DescribeMessageList or from the workload logs.
QueryDeadLetterMessage No Boolean Whether the message is dead letter message. Default value: false.
QueryDelayMessage No Boolean Whether the message is delayed. Default value: false.

3. Output Parameters

Parameter Name Type Description
ShowTopicName String Topic name
Data Array of MessageTraceItem Track details

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.

4. Example

Example1 Query the Path of Regular Messages

Input Example

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

{
    "InstanceId": "rmq-72mo3a9o",
    "Topic": "topic",
    "MsgId": "1EAE3915000721B8D17C2C5BB31638D1"
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Data": [
            {
                "Data": "{\"MsgId\":\"1EAE3915000721B8D17C2C5BB31638D1\",\"Status\":0,\"ProduceTime\":\"2023-05-09 14:43:27,127\",\"ProducerAddr\":\"30.174.57.21\",\"MsgKey\":\"testKey\",\"MsgTags\":\"testTag\",\"Duration\":76}",
                "Stage": "produce"
            },
            {
                "Data": "{\"MsgId\":\"1EAE3915000721B8D17C2C5BB31638D1\",\"Status\":0,\"PersistTime\":\"2023-05-09 14:43:27,184\"}",
                "Stage": "persist"
            },
            {
                "Data": "{\"TotalCount\":1,\"RocketMqConsumeLogs\":[{\"MsgId\":\"1EAE3915000721B8D17C2C5BB31638D1\",\"Status\":2,\"PushTime\":\"2023-05-09 14:43:27,205\",\"ConsumerAddr\":\"11.139.244.247\",\"ConsumerGroup\":\"group\",\"RetryTimes\":1}]}",
                "Stage": "consume"
            }
        ],
        "RequestId": "0112153a-8cba-44f1-b7a5-5e412d493940",
        "ShowTopicName": "test_topic"
    }
}

Example2 Query the Path of Delayed Messages

Input Example

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

{
    "InstanceId": "rmq-cdqzmmgz8o",
    "Topic": "",
    "MsgId": "010242ECB90067325E06F41EFF00000000",
    "QueryDelayMessage": true
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Data": [
            {
                "Data": "{\"MsgId\":\"010242ECB90067325E06F41EFF00000000\",\"Status\":0,\"ProduceTime\":\"2024-09-12 14:06:55,591\",\"ProducerAddr\":\"9.218.232.160:32038\",\"MsgKey\":\"topic1\",\"MsgTags\":\"tag0\",\"Duration\":2}",
                "Stage": "produce"
            },
            {
                "Data": "{\"MsgId\":\"010242ECB90067325E06F41EFF00000000\",\"Status\":0,\"PersistTime\":\"2024-09-12 14:06:55,590\"}",
                "Stage": "persist"
            },
            {
                "Data": "{\"TotalCount\":0,\"RocketMqConsumeLogs\":[]}",
                "Stage": "consume"
            }
        ],
        "RequestId": "2e4374f9-0c98-4d77-af20-2bc414ccaefd",
        "ShowTopicName": "test_topic"
    }
}

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

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.
ResourceNotFound.Message Message does not exist.
本页内容是否解决了您的问题？
您也可以 联系销售 或 提交工单 以寻求帮助。
是
否

文档反馈