Send Messages via SendMessage API to MQTT Clients - ApsaraMQ for MQTT - Alibaba Cloud - ApsaraMQ for MQTT

Operation description

The SendMessage operation is called by a server-side application and complements message sending from ApsaraMQ for MQTT clients. For the differences between server-side and client-side messaging scenarios, see Developer guide.
Messages sent by calling the SendMessage operation cannot be forwarded to ApsaraMQ for RocketMQ. To forward messages to ApsaraMQ for RocketMQ through an ApsaraMQ for MQTT broker, use an SDK to send the messages. The SendMessage operation supports up to 1,000 queries per second (QPS). For more information, see QPS limits.
Each successful call to the SendMessage operation counts as a message transaction per second (TPS), which affects your instance billing. For more information, see Billing rules.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MqttTopic	string	Yes	The MQTT topic to which you want to send the message.	TopicA
InstanceId	string	Yes	The ID of the ApsaraMQ for MQTT instance. This ID must match the instance that the MQTT client uses. You can find the instance ID in the Basic Information section on the Instance Details page in the ApsaraMQ for MQTT console.	post-cn-0pp12gl****
Payload	string	Yes	The message payload. We recommend that you Base64-encode the content to prevent issues with non-printable characters.	test

Note

For information about other parameters, see Common parameters and Endpoints.

Response elements

Element	Type	Description	Example
	object
MsgId	string	The unique message ID returned by the ApsaraMQ for MQTT broker after the message is sent.	0B736D997B7F45FF54E61C1C1B58****
RequestId	string	The request ID. This is a common parameter.	020F6A43-19E6-4B6E-B846-44EB31DF****

Examples

Success response

JSON format

{
  "MsgId": "0B736D997B7F45FF54E61C1C1B58****",
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****"
}

Error codes

HTTP status code	Error code	Error message
400	CheckAccountInfoFailed	An error occurred while checking the account information by the STS token.
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
400	ParameterCheckFailed	An error occurred while validating the parameters. The parameters may be missing or invalid.
400	PermissionCheckFailed	An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
500	InternalError	An error occurred while processing your request. Try again later.
500	SendMessageFailed	A storage exception occurred while sending the message. Please try again.
500	SystemOverFlow	An error occurred while processing your request. Please try again.
404	ApiNotSupport	The specified API is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.