SendMessage - 向云消息队列 MQTT 版发送单条消息 - 云消息队列 MQTT 版

接口说明

SendMessage 接口为服务端应用调用，与 MQTT 客户端发送消息互补。服务端和客户端的使用场景区别，请参见开发指南使用指引。
调用 SendMessage 接口发送的消息不支持流转至云消息队列 RocketMQ 版。若需要通过 MQTT 服务端将消息流转至云消息队列 RocketMQ 版，请使用 SDK 发送消息。 SendMessage 接口的 QPS 限制为 1000。更多信息，请参见 QPS 限制。
每成功调用一次 SendMessage 接口，都会计算为一次消息 TPS，从而影响您的计费。计费详情，请参见计费说明。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mq:SendMessage

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
MqttTopic	string	是	云消息队列 MQTT 版的 Topic，即消息发送的目标 Topic。	TopicA
InstanceId	string	是	云消息队列 MQTT 版实例的 ID，一定要和客户端实际使用的实例 ID 匹配。您可以在控制台实例详情页面的基础信息区域查看。	post-cn-0pp12gl****
Payload	string	是	消息内容，即消息负载。建议自行做 Base64 编码，避免传输不可见字符。	test

说明

更多参数说明请参见公共参数和服务接入点。

返回参数

名称	类型	描述	示例值
	object
MsgId	string	消息的唯一标识，消息发送成功后服务端会返回消息 ID。	0B736D997B7F45FF54E61C1C1B58****
RequestId	string	公共参数，每个请求的 ID 都是唯一的。	020F6A43-19E6-4B6E-B846-44EB31DF****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	CheckAccountInfoFailed	An error occurred while checking the account information by the STS token.	解析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.	实例权限校验失败，请确认MQTT实例的所属关系以及授权策略。
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.	资源权限校验失败，请检查实例、Topic和Group ID的所属权限和授权策略。
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.	MQTT后端服务异常，请重试。
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.	当前接口不支持，请检查。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。