tencent cloud



Last updated: 2023-08-09 14:43:22

1. API Description

Domain name for API request: tdmq.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 No String Common Params. This parameter is not required for this API.
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
QueryDlqMsg No Boolean The value of this parameter is true when you query a dead letter queue. It only applies to TDMQ for RocketMQ.

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 Consumption details of a consumer group
Note: u200dThis field may return null, indicating that no valid values can be obtained.
ShowTopicName String Topic name displayed on the details page
Note: u200dThis field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the details of a TDMQ for RocketMQ message

This example shows you how to query the details of a TDMQ for RocketMQ message.

Input Example

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

    "EnvironmentId": "xx",
    "ClusterId": "xx",
    "TopicName": "xx",
    "PulsarMsgId": "xx",
    "MsgId": "xx",
    "QueryDlqMsg": false

Output Example

    "Response": {
        "Body": "xx",
        "MsgId": "xx",
        "ProduceTime": "xx",
        "RequestId": "xx",
        "Properties": "xx",
        "ProducerAddr": "xx",
        "ShowTopicName": "xx",
        "MessageTracks": []

5. Developer Resources


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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support