OnsMessageDetail - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries the details of a message.

Operation description

Note API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraMQ for RocketMQ Instance.	MQ_INST_184681981******_BXig0x6A
Topic	string	Yes	The name of the topic in which the message you want to query is stored.	test-mq_topic
MsgId	string	Yes	The ID of the message that you want to query.	1E0578FE110F18B4AAC235C0******

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.	EAE5BE23-37A1-4354-94D6-E44AE17E****
Data	object	The data returned.
StoreSize	integer	The size of the message. Unit: KB.	2
ReconsumeTimes	integer	The number of retries that ApsaraMQ for RocketMQ performed to send the message to consumers.	0
StoreTimestamp	long	The timestamp that indicates the point in time when the ApsaraMQ for RocketMQ broker stored the message. Unit: milliseconds.	1570761026708
Body	string	The string that is obtained after the message body is encrypted by using the Base 64 algorithm.	aGVsbG8=
InstanceId	string	The ID of the ApsaraMQ for RocketMQ Instance.	MQ_INST_184681981******_BXig0x6A
MsgId	string	The ID of the message.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	The ApsaraMQ for RocketMQ broker that stores the message.	11.220.*.*:10911
Topic	string	The topic to which the message belongs.	test-mq_topic
PropertyList	object []	The attributes of the message.
Value	string	The value of the attribute.	MSG_REGION
Name	string	The name of the attribute. Valid values: TRACE_ON: indicates whether the trace of the message exists. MSG_REGION: The region ID of the instance to which the topic belongs. __MESSAGE_DECODED_TIME: The time when the message was decoded. __BORNHOST: The IP address of the producer client. UNIQ_KEY: The ID of the message. For information about the terms that are used in ApsaraMQ for RocketMQ, see Terms .	cn-hangzhou
BornTimestamp	long	The timestamp that indicates the point in time when the message was generated. Unit: milliseconds.	1570761026630
BodyCRC	integer	The cyclic redundancy check (CRC) value of the message body.	907060870
BornHost	string	The producer instance that generated the message.	42.120..:64646
BodyStr	string	The information about the message body.	hello

Examples

Sample success responses

JSONformat

{
  "RequestId": "EAE5BE23-37A1-4354-94D6-E44AE17E****",
  "Data": {
    "StoreSize": 2,
    "ReconsumeTimes": 0,
    "StoreTimestamp": 1570761026708,
    "Body": "aGVsbG8=",
    "InstanceId": "MQ_INST_184681981******_BXig0x6A",
    "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
    "StoreHost": "11.220.***.***:10911",
    "Topic": "test-mq_topic",
    "PropertyList": [
      {
        "Value": "MSG_REGION",
        "Name": "cn-hangzhou"
      }
    ],
    "BornTimestamp": 1570761026630,
    "BodyCRC": 907060870,
    "BornHost": "42.120.**.**:64646",
    "BodyStr": "hello"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history