DescribeMsg

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

DescribeMsg

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

1. API Description

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

This API is used to get 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: DescribeMsg.
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) name.
MsgId	Yes	String	Message ID.
TopicName	Yes	String	Topic name.
ClusterId	No	String	Pulsar cluster ID

3. Output Parameters

Parameter Name	Type	Description
Properties	String	Message attributes.
Body	String	Message body.
BatchId	String	Batch ID.
ProduceTime	String	Production time.
MsgId	String	Message ID.
ProducerName	String	Producer name.
Key	String	Message key Note: This field may return null, indicating that no valid values can be obtained.
Metadata	String	Message metadata 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 Details

Input Example

https://tdmq.intl.tencentcloudapi.com/?Action=DescribeMsg
&EnvironmentId=default
&TopicName=msg_dev
&MsgId=16836:8:-1
&<Common request parameters>

Output Example

{
    "Response": {
        "Properties": "{\"publish-time\": \"1597747661679\", \"X-Pulsar-num-batch-message\": \"1\", \"MESSAGE_ID\": \"16836:8:-1\", \"X-Pulsar-producer-name\": \"fisrtProducer\", \"bookies-address\": \"9.139.220.16:3181#9.139.220.8:3181\"}",
        "Body": "i just a10 testing!",
        "BatchId": "1",
        "ProduceTime": "2020-08-18 18:47:41",
        "MsgId": "16836:8:-1",
        "ProducerName": "fisrtProducer",
        "RequestId": "b9c2eff2-e96a-4558-9ffc-d85279cxxxx",
        "Metadata": "{\"X-Pulsar-event-time\":\"1755674979886\",\"X-Pulsar-redelivery-count\":\"0\",\"X-Pulsar-sequence-id\":\"11\",\"X-Pulsar-deliver-at-time\":\"1755686943517\",\"X-Pulsar-replicated-to\":\"[]\",\"X-Pulsar-ordering-key\":\"[116, 101, 115, 116, 50]\"}",
        "Key": "test1"
    }
}

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.
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.Msg	Specified message not found.
ResourceNotFound.Topic	The topic does not exist.

Was this page helpful?

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

Yes

Feedback

tencent cloud