tencent cloud

DescribeRocketMQMsgTrace
Last updated: 2025-11-25 10:52:35
DescribeRocketMQMsgTrace
Last updated: 2025-11-25 10:52:35

1. API Description

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

Queries message trajectory

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: DescribeRocketMQMsgTrace.
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.
ClusterId Yes String Cluster ID.
EnvironmentId Yes String Namespace
TopicName Yes String Topic. When the system queries RocketMQ dead letters, the value is groupId.
MsgId Yes String Message ID
GroupName No String Consumer Group and Subscription
QueryDeadLetterMessage No String The value is true when querying dead letters.

3. Output Parameters

Parameter Name Type Description
Result Array of TraceResult Trace details list.
ShowTopicName String Topic Name Displayed on Message Trace Page
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 Queries message trajectory

Queries message trajectory

Input Example

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

{
    "ClusterId": "rocketmq-4k4orqgq",
    "EnvironmentId": "test_namespace",
    "TopicName": "test_topic",
    "MsgId": "01963F0B14BAF0B5360728F44800000000",
    "GroupName": "test_group",
    "QueryDLQMsg": true
}

Output Example

{
    "Response": {
        "Result": [
            {
                "Stage": "produce",
                "Data": "{\"MsgId\":\"01963F0B14BAF0B5360728F44800000000\",\"Status\":0,\"ProduceTime\":\"2024-10-22 15:54:49,124\",\"ProducerAddr\":\"111.206.94.148:47557\",\"MsgKey\":\"yourMessageKey-1c151062f96e\",\"MsgTags\":\"yourMessageTagA\",\"Duration\":10}"
            },
            {
                "Stage": "persist",
                "Data": "{\"MsgId\":\"01963F0B14BAF0B5360728F44800000000\",\"Status\":0,\"PersistTime\":\"2024-10-22 15:54:49,132\"}"
            },
            {
                "Stage": "consume",
                "Data": "{\"TotalCount\":1,\"RocketMqConsumeLogs\":[{\"MsgId\":\"01963F0B14BAF0B5360728F44800000000\",\"Status\":2,\"PushTime\":\"2024-10-22 15:55:00,122\",\"ConsumerAddr\":\"111.206.94.148:53792\",\"ConsumerGroup\":\"test_group\",\"RetryTimes\":1}]}"
            }
        ],
        "ShowTopicName": "news-topic",
        "RequestId": "23ca1a58-0388-4d2d-8465-653a53addda7"
    }
}

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
FailedOperation Operation failed.
ResourceNotFound.Cluster The cluster does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback