OnsMessagePush - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Pushes a message to a specified consumer.

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 can be used to check whether messages in a specified topic can be consumed by consumers in a specified consumer group. This operation obtains the body of the message that is specified by the MsgId parameter, re-encapsulates the message body to produce a new message, and then pushes the new message to a specified consumer. The content of the message that is sent to the consumer is the same as the content of the original message. They are not the same message because they use different message IDs.

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:SUB	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the consumer group. For information about what a consumer group is, see Terms .	GID_test_group_id
ClientId	string	Yes	The ID of the consumer client. You can call the OnsConsumerGetConnection operation to query client IDs.	30.5.121.**@24813#-1999745829#-1737591554#453111174894656
MsgId	string	Yes	The ID of the message.	0BC1669963053CF68F733BB70396****
Topic	string	Yes	The topic to which the message is pushed.	test-mq_topic
InstanceId	string	Yes	The ID of the ApsaraMQ for RocketMQ instance to which the specified consumer group belongs.	MQ_INST_111111111111_DOxxxxxx

Response parameters

Parameter	Type	Description	Example
	object
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.	B8EDC90D-F726-4B9E-8BEF-F0DD25EC****

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history