VerifySendMessage - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

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

rocketmq:VerifySendMessage

update

*Topic

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}

None

Request syntax

POST /instances/{instanceId}/topics/{topicName}/messages HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	rmq-cn-wwo32kqfm10
topicName	string	Yes	The topic name.	card_status_topic

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
message	string	No	The message content.	successful
messageTag	string	No	The message tag.	xx
messageKey	string	No	The business key.	xx
liteTopicName	string	No	The name of the Lite Message Queue topic.	abc

Response elements

Element	Type	Description	Example
	object	Result
requestId	string	The request ID.	3BD2C19B-66DE-59C7-B2F6-FD1BE21DC8C1
success	boolean	Indicates whether the request was successful.	true
data	string	The returned result.	0A64228900207A4F0F2931A4E0D40BE5
code	string	The error code.	InvalidConsumerGroupId
message	string	The error message.	The instance cannot be found.
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	ConsumerGroupId
dynamicMessage	string	The dynamic error message.	consumerGroupId

Examples

Success response

JSON format

{
  "requestId": "3BD2C19B-66DE-59C7-B2F6-FD1BE21DC8C1",
  "success": true,
  "data": "0A64228900207A4F0F2931A4E0D40BE5",
  "code": "InvalidConsumerGroupId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "consumerGroupId"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.