OnsMessageGetByKey - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries messages by using a specified topic and message key.

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.

This operation uses the fuzzy match method to query messages based on a specified message key. The same message key may be used by multiple messages. Therefore, the returned result may contain information about multiple messages.
This operation can be used in scenarios in which you cannot obtain the IDs of the messages that you want to query. You can perform the following steps to query the information about messages:
1. Call this operation to query message IDs.
2. Call the OnsMessageGetByMsgId operation that uses the exact match method to query the details of a specified message. For more information about the OnsMessageGetByMsgId operation, see OnsMessageGetByMsgId .

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mq:QueryMessage	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Topic	string	Yes	The topic that contains the messages that you want to query.	test-mq_topic
Key	string	Yes	The key of the messages that you want to query.	messageKey1
InstanceId	string	Yes	The ID of the instance to which the messages that you want to query belong.	MQ_INST_111111111111_DOxxxxxx

Response parameters

Parameter	Type	Description	Example
	object	The result of the request.
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.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object []	The list of returned results.
StoreSize	integer	The size of the message.	406
ReconsumeTimes	integer	The number of retries that were performed to send the message to consumers.	1
StoreTimestamp	long	The timestamp that indicates when the ApsaraMQ for RocketMQ broker stored the message.	1570760999811
InstanceId	string	The ID of the instance	MQ_INST_111111111111_DOxxxxxx
MsgId	string	The ID of the message.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	The ApsaraMQ for RocketMQ broker that stores the message.	11.193.*.*: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.	TagA
Name	string	The name of the attribute. Valid values: TRACE_ON: indicates whether the message trace exists. KEYS: indicates the key of the message. TAGS: indicates the tag that is attached to the message. INSTANCE_ID: indicates the ID of the instance that contains the message. For information about the terms that are used in ApsaraMQ for RocketMQ, see Terms .	TAGS
BornTimestamp	long	The timestamp that indicates when the message was produced.	1570760999721
BodyCRC	integer	The cyclic redundancy check (CRC) value of the message body.	914112295
BornHost	string	The producer client that generated the message.	42.120.*.*:59270

Examples

Sample success responses

JSONformat

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "OnsRestMessageDo": [
      {
        "StoreSize": 406,
        "ReconsumeTimes": 1,
        "StoreTimestamp": 1570760999811,
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
        "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
        "StoreHost": "11.193.***.***:10911",
        "Topic": "test-mq_topic",
        "PropertyList": {
          "MessageProperty": [
            {
              "Value": "TagA",
              "Name": "TAGS"
            }
          ]
        },
        "BornTimestamp": 1570760999721,
        "BodyCRC": 914112295,
        "BornHost": "42.120.***.***:59270"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history

View the information about a message in the console

You can also view the information about messages in the ApsaraMQ for RocketMQ console.**** For more information, see Query a message.