DescribeMsgTrace

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

DescribeMsgTrace

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

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: DescribeMsgTrace.
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.
EnvironmentId	Yes	String	Environment (namespace).
MsgId	Yes	String	Message ID.
ProduceTime	Yes	String	Message production time.
Offset	No	Integer	Starting index. Default is 0 if left empty.
Limit	No	Integer	Number of returns, default to 10 if not specified, maximum value: 20.
SubscriptionName	No	String	Fuzzy matching of consumer group name.
ClusterId	No	String	Pulsar cluster ID

3. Output Parameters

Parameter Name	Type	Description
ProducerLog	ProducerLog	Produce information. Note: This field may return null, indicating that no valid values can be obtained.
ServerLog	ServerLog	Service provider information. Note: This field may return null, indicating that no valid values can be obtained.
ConsumerLogs	ConsumerLogs	Consumption information. 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 Retrieving Message Trace

Input Example

https://tdmq.intl.tencentcloudapi.com/?Action=DescribeMsgTrace
&EnvironmentId=devNs
&MsgId=16839:8:-1
&ProduceTime=2020-08-1908:06:19
&<Common request parameters>

Output Example

{
    "Response": {
        "ProducerLog": {
            "MsgId": "16839:8:-1",
            "ProducerName": "fisrtProducer",
            "ProduceTime": "2020-08-19 08:06:19,211",
            "ProducerAddr": "9.139.220.17:57234",
            "ProduceUseTime": 5309,
            "Status": "success"
        },
        "ServerLog": {
            "SaveTime": "2020-08-19 08:06:19,211",
            "Status": "success"
        },
        "ConsumerLogs": {
            "TotalCount": 1,
            "ConsumerLogSets": [
                {
                    "MsgId": "16839:8:-1",
                    "ConsumerGroup": "sun_consumer",
                    "ConsumerName": "7ef60",
                    "ConsumeTime": "2020-08-19 08:06:22,563",
                    "ConsumerAddr": "9.139.220.17:57241",
                    "ConsumeUseTime": 875,
                    "Status": "success"
                }
            ]
        },
        "RequestId": "msgs"
    }
}

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
InvalidParameterValue.InvalidParams	The parameter value is out of the value range.
MissingParameter.NeedMoreParams	A required parameter is missing.
ResourceNotFound.BrokerCluster	The service cluster does not exist.
ResourceNotFound.Cluster	The cluster does not exist.
ResourceNotFound.Environment	The environment does not exist.
ResourceNotFound.MsgProduceLog	Message production log does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud