QueryURocketMQMessageByID - QueryURocketMQMessageByID

Overview

Get the details of a Message with a specified ID

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `QueryURocketMQMessageByID`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See Region and Availability Zone List	Yes
ProjectId	string	Project ID. Please refer to the GetProjectList API	Yes
ServiceId	string	Service ID	Yes
MsgId	string	Message ID	Yes
TopicName	string	Topic Name	Yes

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
MessageList	array[MessageDetail]	Message Details	No

Data Model

MessageDetail

Field Name	Type	Description Information	Required
Properties	MessageProperties	Message Attribute	Yes
Topic	string	Topic Name	Yes
MsgId	string	Message’s ID	Yes
StoreTimestamp	int	Message’s landing time, Unix milliseconds	Yes
MessageBody	string	Body of the Message	Yes

MessageProperties

Field Name	Type	Description Information	Required
TAGS	string	Tag of Message	Yes
KEYS	string	Key of the Message	Yes

Example

Request Example


https://api.surfercloud.com/?Action=QueryURocketMQMessageByID
&Region=cn-zj
&ProjectId=TbKkMNBW
&ServiceId=lDRInGeU
&GroupName=OpqwDJnj
&MsgId=BIWmWMwr

Response Example


{
  "Action": "QueryURocketMQMessageByIDResponse",
  "Message": "XNnTsUzD",
  "MessageList": [
    {
      "MessageBody": "dtPXPyXq",
      "MsgId": "mTpiCAmy",
      "Properties": {},
      "StoreTimestamp": 4,
      "Topic": "fwiLfLtZ"
    }
  ],
  "RetCode": 0
}