調用SendMessage接口發送消息到指定的隊列。
授權信息
默認僅限阿里云賬號使用本接口,RAM用戶只有在被授予了相關API操作權限后方可使用。本接口的授權信息如下表所示。更多信息,請參見授權策略和示例。
Name | Value |
API | SendMessage |
RAM授權操作 | mns:SendMessage |
資源 | acs:mns:$region:$accountid:/queues/$queueName/messages |
使用說明
該接口用于發送消息到指定的隊列,普通消息發送到隊列立即被消費者消費。如果生產者發送一個消息不想立即被消費者消費(典型的使用場景為定期任務),生產者可以在發送消息時設置
DelaySeconds
參數。發送帶DelaySeconds
參數值大于0的消息初始狀態為Delayed,此時消息不能被消費者消費,只有等DelaySeconds
時間后消息變成Active狀態后才可以被消費。發送消息時指定
DelaySeconds
參數的優先級高于延時隊列的DelaySeconds
屬性,即兩個DelaySeconds
屬性設置的值不同的時候以發送消息時指定的值為準。當您調用API發送消息時,請事先將消息體進行Base64編碼,以免存在特殊字符導致不能正常使用。
請求消息
請求消息由請求行、HTTP頭和消息體三部分組成:
請求行
POST /queues/$queueName/messages HTTP/1.1
特有Request Header
無。
Request Body
Request Body為XML格式,其中包含創建Message的屬性。
參數名稱
類型
是否必選
示例值
描述
MessageBody
String
是
This is a test message
消息正文。
DelaySeconds
Integer
否
60
消息發送后,經過DelaySeconds設置的時間后可被消費。
取值范圍:0~604800,單位為秒。
默認值:0。
返回消息
返回消息由返回狀態行、HTTP頭和消息體三部分組成:
HTTP Status Code
HTTP/1.1 201 Created
特有Response Header
無。
Response Body
Response Body為XML格式,返回Message的MessageId和MessageBodyMD5子元素。
參數名稱
類型
示例值
描述
MessageId
String
5F290C926D472878-2-14D9529A8FA-20000****
消息編號,在一個隊列中唯一。
MessageBodyMD5
String
C5DD56A39F5F7BB8B3337C6D11B6****
消息正文的MD5值。
ReceiptHandle
String
1-ODU4OTkzNDU5My0xNDM1MTk3NjAwLTItNg==
發送延遲消息后返回的消息句柄。
示例
請求示例:
POST /queues/$queueName/messages HTTP/1.1
Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
Date: Wed, 18 Mar 2012 12:00:00 GMT
Content-Length:500
Content-Type:text/xml;charset=utf-8
x-mns-version: 2015-06-06
Authorization: MNS 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEX****
<?xml version="1.0" encoding="UTF-8"?>
<Message xmlns="http://mns.aliyuncs.com/doc/v1/">
<MessageBody>This is a test message</MessageBody>
<DelaySeconds>60</DelaySeconds>
<Priority>1</Priority>
</Message>
返回示例:
HTTP/1.1 201 Created
Content-Length:120
Content-Type:text/xml;charset=utf-8
x-mns-request-id:512B2A634403E52B1956****
x-mns-version: 2015-06-06
<?xml version="1.0" encoding="UTF-8"?>
<Message xmlns="http://mns.aliyuncs.com/doc/v1/">
<MessageId>5F290C926D472878-2-14D9529****-200000001</MessageId>
<MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6****</MessageBodyMD5>
<ReceiptHandle>1-ODU4OTkzNDU5My0xNDM1MTk3NjAwLTItNg==</ReceiptHandle>
</Message>
錯誤碼
錯誤碼 | 錯誤信息 | HTTP狀態碼 | 描述內容 |
QueueNotExist | The queue name you provided is not exist. | 404 | 隊列不存在,請先創建隊列。 |
MalformedXML | The XML you provided was not well-formed. | 400 | XML結構異常。 |
InvalidArgument | The value of Element should between Low and High seconds/bytes. | 400 | 參數值非法,請根據提示調整。 |