OnsMessageGetByKey - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Performs a fuzzy query for a list of messages based on a topic and a message key.

Operation description

Important The OpenAPI provided by Alibaba Cloud is a management API. You can use it to manage and query resources of Alibaba Cloud services. We recommend that you integrate this API only into management data links. Do not use this API for core data links that send and receive messages. This can introduce security threats to your data links.

This operation performs a fuzzy query for messages based on a message key. Because a message key is not always unique, the query may return multiple messages.
You can use this operation when you cannot obtain a message ID. In this scenario, follow these steps:
1. Call this operation to perform a fuzzy query and obtain a list of message IDs.
2. Call the OnsMessageGetByMsgId operation to perform a term query. For more information about the OnsMessageGetByMsgId operation, see OnsMessageGetByMsgId.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mq:QueryMessage

get

Topic

acs:mq:{#regionId}:{#accountId}:{#TopicName}

Topic

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

None

mq:OnsInstanceBaseInfo

Request parameters

Parameter	Type	Required	Description	Example
Topic	string	Yes	The topic of the message to query.	test-mq_topic
Key	string	Yes	The message key of the message to query.	messageKey1
InstanceId	string	No	The ID of the instance to which the message belongs.	MQ_INST_111111111111_DOxxxxxx

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	A common parameter. The ID of the request is unique and can be used to troubleshoot and locate issues.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object
OnsRestMessageDo	array<object>	The list of query results.
	array<object>
StoreSize	integer	The size of the message.	406
ReconsumeTimes	integer	The number of times the message was reconsumed.	1
StoreTimestamp	integer	The timestamp indicating when the message was stored by the broker.	1570760999811
InstanceId	string	The instance ID.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	The message ID.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	The server instance that stores the message.	11.193.*.*:10911
Topic	string	The topic of the message.	test-mq_topic
PropertyList	object
MessageProperty	array<object>	The list of message attributes.
	object
Value	string	The value of the message attribute.	TagA
Name	string	The message attribute. Valid values: TRACE_ON: indicates whether a message trace exists. KEYS: the key of the message. TAGS: the tag of the message. INSTANCE_ID: the ID of the instance to which the message belongs. For more information about the concepts, see Terms.	TAGS
BornTimestamp	integer	The timestamp indicating when the message was created.	1570760999721
BodyCRC	integer	The CRC checksum of the message body.	914112295
BornHost	string	The client instance that created the message.	42.120.*.*:59270

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.