OnsMessagePush - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Operation description

Important Alibaba Cloud OpenAPI is a control plane API that you can use to manage and query resources of Alibaba Cloud services. Integrate OpenAPI only on the control plane. Do not use OpenAPI for the core data link for sending and receiving messages. This practice introduces security threats to your data link.

This operation is primarily used for testing message consumption. The operation retrieves the body of a specified message based on its message ID, re-encapsulates the message body, and then pushes the message to a consumer. The resent message has the same content as the original message, but it is a new message with a different message ID.

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:SUB

get

Topic

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

Topic

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

None

mq:OnsInstanceBaseInfo

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The group ID. For more information, see Terms.	GID_test_group_id
ClientId	string	Yes	The ID of the consumer instance. Call the OnsConsumerGetConnection operation to obtain this ID.	30.5.121.**@24813#-1999745829#-1737591554#453111174894656
MsgId	string	Yes	The message ID.	0BC1669963053CF68F733BB70396****
Topic	string	Yes	The topic to which the message is pushed.	test-mq_topic
InstanceId	string	No	The ID of the instance that contains the message that you want to push.	MQ_INST_111111111111_DOxxxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request. Use this ID to troubleshoot issues.	B8EDC90D-F726-4B9E-8BEF-F0DD25EC****

Examples

Success response

JSON format

{
  "RequestId": "B8EDC90D-F726-4B9E-8BEF-F0DD25EC****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.