從服務(wù)端應(yīng)用向云消息隊列 MQTT 版發(fā)送單條消息。
接口說明
- SendMessage 接口為服務(wù)端應(yīng)用調(diào)用，與 MQTT 客戶端發(fā)送消息互補。服務(wù)端和客戶端的使用場景區(qū)別，請參見開發(fā)指南使用指引。
- 調(diào)用 SendMessage 接口發(fā)送的消息不支持流轉(zhuǎn)至云消息隊列 RocketMQ 版。若需要通過 MQTT 服務(wù)端將消息流轉(zhuǎn)至云消息隊列 RocketMQ 版，請使用 SDK 發(fā)送消息。 SendMessage 接口的 QPS 限制為 1000。更多信息，請參見 QPS 限制。
- 每成功調(diào)用一次 SendMessage 接口，都會計算為一次消息 TPS，從而影響您的計費。計費詳情，請參見計費說明。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
當前API暫無授權(quán)信息透出。
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MqttTopic | string | 是 | 云消息隊列 MQTT 版的 Topic，即消息發(fā)送的目標 Topic。 | TopicA |
| InstanceId | string | 是 | 云消息隊列 MQTT 版實例的 ID，一定要和客戶端實際使用的實例 ID 匹配。您可以在控制臺實例詳情頁面的基礎(chǔ)信息區(qū)域查看。 | post-cn-0pp12gl**** |
| Payload | string | 是 | 消息內(nèi)容，即消息負載。建議自行做 Base64 編碼，避免傳輸不可見字符。 | test |
返回參數(shù)
示例
正常返回示例
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. | 實例權(quán)限校驗失敗，請確認MQTT實例的所屬關(guān)系以及授權(quán)策略。 |
| 400 | ParameterCheckFailed | An error occurred while validating the parameters. The parameters may be missing or invalid. | 參數(shù)校驗失敗，可能缺失或者傳入值非法。 |
| 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. | 資源權(quán)限校驗失敗，請檢查實例、Topic和Group ID的所屬權(quán)限和授權(quán)策略。 |
| 400 | InvalidParameter.%s | An error occurred while validating the parameter. The parameter may be missing or invalid. | 參數(shù)校驗失敗，可能缺失或者傳入值非法。 |
| 404 | ApiNotSupport | The specified API is not supported. | 當前接口不支持，請檢查。 |
| 500 | InternalError | An error occurred while processing your request. Try again later. | MQTT后端服務(wù)異常，請重試。 |
| 500 | SendMessageFailed | A storage exception occurred while sending the message. Please try again. | 由于后端存儲異常，消息發(fā)送失敗，請重試。 |
| 500 | SystemOverFlow | An error occurred while processing your request. Please try again. | 系統(tǒng)限流，請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|
暫無變更歷史