ExportRocketMQMessageDetail

Last updated: 2025-11-25 10:52:32

ExportRocketMQMessageDetail

Last updated: 2025-11-25 10:52:32

1. API Description

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

Export the 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: ExportRocketMQMessageDetail.
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	Application namespace.
TopicName	Yes	String	Topic name. If it is a dead letter message, isDlqMsg=true.
MsgId	Yes	String	Message ID
IncludeMsgBody	Yes	Boolean	Whether to Includes Message Body
DeadLetterMsg	No	Boolean	Whether It a Dead Letter Message

3. Output Parameters

Parameter Name	Type	Description
MsgId	String	Message ID
BornTimestamp	Integer	Message Generation Timestamp Note: This field may return null, indicating that no valid values can be obtained.
StoreTimestamp	Integer	Message Storage Timestamp Note: This field may return null, indicating that no valid values can be obtained.
BornHost	String	Message Production Client Address Note: This field may return null, indicating that no valid values can be obtained.
MsgTag	String	Message Tag Note: This field may return null, indicating that no valid values can be obtained.
MsgKey	String	Message key Note: This field may return null, indicating that no valid values can be obtained.
Properties	String	Message Attributes Note: This field may return null, indicating that no valid values can be obtained.
ReConsumeTimes	Integer	Message Retry Count Note: This field may return null, indicating that no valid values can be obtained.
MsgBody	String	Base64 Encoded String Note: This field may return null, indicating that no valid values can be obtained.
MsgBodyCRC	Integer	CRC32 Code of Message Content Note: This field may return null, indicating that no valid values can be obtained.
MsgBodySize	Integer	Specifies the message body size (unit K). Does not return messages when above 2048.
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 Export Message Details

Input Example

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

{
    "ClusterId": "rocketmq-a5nzx52ab7jb",
    "EnvironmentId": "test_namespace",
    "TopicName": "test_topic",
    "MsgId": "7F0000013AEC18B4AAC278B640D30002",
    "DeadLetterMsg": true,
    "IncludeMsgBody": true
}

Output Example

{
    "Response": {
        "MsgId": "7F0000013AEC18B4AAC278B640D30002",
        "BornTimestamp": 1729478721,
        "StoreTimestamp": 1729478721,
        "BornHost": "10.2.139.175:8080",
        "MsgTag": "test_tag",
        "MsgKey": "test_key",
        "Properties": "",
        "ReConsumeTimes": 1,
        "MsgBody": "This is a normal message for Apache RocketMQ",
        "MsgBodyCRC": 0,
        "MsgBodySize": 18,
        "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

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.
InternalError.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