tencent cloud

DescribeRocketMQMsg
Last updated: 2025-11-25 10:52:36
DescribeRocketMQMsg
Last updated: 2025-11-25 10:52:36

1. API Description

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

This API is used to query the TDMQ for RocketMQ message details.

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: DescribeRocketMQMsg.
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 ID
TopicName Yes String Topic name. Pass in the group ID when querying a dead letter queue.
MsgId Yes String Message ID
PulsarMsgId Yes String ID of a TDMQ for Pulsar message
QueryDeadLetterMessage No Boolean The value is true when querying dead letters, and only valid for RocketMQ.
Offset No Integer Pagination offset
Limit No Integer Pagination limit
FilterTrackGroup No String Filters consumption details based on the consumer group name.

3. Output Parameters

Parameter Name Type Description
Body String Message body
Properties String Details parameter
ProduceTime String Production time
MsgId String Message ID
ProducerAddr String Producer address
MessageTracks Array of RocketMQMessageTrack Consumer group consumption list.
Note: This field may return null, indicating that no valid values can be obtained.
ShowTopicName String Topic name displayed on the details page
Note: This field may return null, indicating that no valid values can be obtained.
MessageTracksCount Integer Total number of consumer group consumption lists.
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 message details.

Input Example

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

{
    "EnvironmentId": "test_namespace",
    "ClusterId": "rocketmq-4k4orqgq",
    "TopicName": "test_topic",
    "PulsarMsgId": "092BAE5A1656070DEA4E276DF0760089",
    "MsgId": "092BAE5A1656070DEA4E276DF0760023",
    "QueryDlqMsg": false
}

Output Example

{
    "Response": {
        "Body": "order-id-2ksn3b23",
        "MsgId": "092BAE5A1656070DEA4E276DF0760089",
        "ProduceTime": "2021-11-23 21:21:26",
        "RequestId": "23ca1a58-0388-4d2d-8465-653a53addda7",
        "Properties": "",
        "ProducerAddr": "9.43.174.90",
        "ShowTopicName": "test_topic",
        "MessageTracks": [
            {
                "Group": "test_group",
                "ConsumeStatus": "CONSUMED",
                "TrackType": "CONSUMED",
                "ExceptionDesc": ""
            }
        ]
    }
}

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