DescribeMqMsgTrace

Last updated: 2025-11-25 10:54:27

DescribeMqMsgTrace

Last updated: 2025-11-25 10:54:27

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: DescribeMqMsgTrace.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
Protocol	Yes	String	pulsar,rocketmq,rabbitmq,cmq
MsgId	Yes	String	Message ID
ClusterId	No	String	Cluster id. cmq is empty.
EnvironmentId	No	String	Namespace. cmq is empty.
TopicName	No	String	Topic. empty for cmq. group id when querying rocketmq dead letters.
QueueName	No	String	cmq is required. fill in the blank for other protocols.
GroupName	No	String	Consumer Group and Subscription
QueryDlqMsg	No	Boolean	The value is true when querying dead letters, and only valid for RocketMQ.
ProduceTime	No	String	Message production time.

3. Output Parameters

Parameter Name	Type	Description
Result	Array of TraceResult	Message content.
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 Example

demo

Input Example

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

{
    "Protocol": "pulsar",
    "ClusterId": "pulsar-pnvjp9mbd947",
    "EnvironmentId": "devNs",
    "TopicName": "devTopic",
    "QueueName": "devCmq",
    "MsgId": "29292216:15:3",
    "GroupName": "devName",
    "QueryDlqMsg": true
}

Output Example

{
    "Response": {
        "Result": [
            {
                "Stage": "devInfo",
                "Data": "2023-07-20 10:35:17"
            }
        ],
        "ShowTopicName": "devTopic",
        "RequestId": "722558eb-36dc-4643-854f-aa7436b83125"
    }
}

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

Tencent Cloud CLI 3.0

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

Feedback

tencent cloud