調用BatchSendMessage介面批量發送訊息到指定的隊列。
授權資訊
預設僅限阿里雲帳號使用本介面,RAM使用者只有在被授予了相關API操作許可權後方可使用。本介面的授權資訊如下表所示。更多資訊,請參見授權策略和樣本。
Name | Value |
API | BatchSendMessage |
RAM授權操作 | mns:BatchSendMessage |
資源 | acs:mns:$region:$accountid:/queues/$queueName/messages |
使用說明
該介面用於批量發送訊息到指定的隊列,一次BatchSendMessage最多發送16條訊息(一次Batch請求的訊息總大小不得超過64 KB)。普通訊息發送到隊列立即被消費者消費,如果生產者發送一個訊息不想立即被消費者消費(典型的使用情境為定期任務),生產者可以在發送訊息時設定
DelaySeconds
參數。發送帶
DelaySeconds
參數值大於0的訊息初始狀態為Delayed,此時訊息不能被消費者消費,只有等DelaySeconds
時間後訊息變成Active狀態後才可消費。發送訊息時指定DelaySeconds
參數的優先順序高於延時訊息佇列的DelaySeconds
屬性,即兩個DelaySeconds
屬性設定的值不同的時候以發送訊息時指定的值為準。使用BatchSendMessage介面時,BatchSendMessage的QPS=BatchSendMessage每秒實際請求次數×介面中的訊息條數。例如:BatchSendMessage介面1秒中實際請求次數是100,介面中包含10條訊息,則佔用單個隊列QPS=100×10=1000。
當您調用API發送訊息時,請事先將訊息體進行Base64編碼,以免存在特殊字元導致不能正常使用。
請求訊息
請求訊息由請求行、HTTP頭和訊息體三部分組成:
請求行
POST /queues/$queueName/messages HTTP/1.1
特有Request Header
無。
Request Body
Request Body為XML格式,其中包含多條建立Message的屬性。
參數名稱
類型
是否必選
樣本值
描述
MessageBody
String
是
This is test message 1.
訊息本文。
DelaySeconds
Integer
否
60
訊息發送後,經過DelaySeconds設定的時間後可被消費。
取值範圍:0~604800,單位為秒。
預設值:0。
Priority
Integer
否
1
指定訊息的優先順序權值,優先順序更高的訊息,將更早被消費。
取值範圍:1~16,數值越小優先順序越高。
預設值:8。
返回訊息
返回訊息由返回狀態行、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值。
樣本
請求樣本:
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+FIEXA****
<?xml version="1.0" encoding="UTF-8"?>
<Messages xmlns="http://mns.aliyuncs.com/doc/v1/">
<Message>
<MessageBody>This is test message 1.</MessageBody>
<DelaySeconds>60</DelaySeconds>
<Priority>1</Priority>
</Message>
<Message>
<MessageBody>This is test message 2.</MessageBody>
<DelaySeconds>60</DelaySeconds>
<Priority>1</Priority>
</Message>
</Messages>
返回樣本:
正常發送所有訊息
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"?> <Messages xmlns="http://mns.aliyuncs.com/doc/v1/"> <Message> <MessageId>5F290C926D472878-2-14D9529A8FA-20000****</MessageId> <MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6****</MessageBodyMD5> </Message> <Message> <MessageId>5F290C926D472878-2-14D9529A8FA-20000****</MessageId> <MessageBodyMD5>377AC5283D8765C9CEE4E0EA353D****</MessageBodyMD5> </Message> </Messages>
只發送了部分訊息
HTTP/1.1 500 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"?> <Messages xmlns="http://mns.aliyuncs.com/doc/v1/"> <Message> <MessageId>5F290C926D472878-2-14D9529A8FA-20000****</MessageId> <MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6****</MessageBodyMD5> </Message> <Message> <MessageId>5F290C926D472878-2-14D9529A8FA-20000****</MessageId> <MessageBodyMD5>377AC5283D8765C9CEE4E0EA353D****</MessageBodyMD5> </Message> <Message> <ErrorCode>InternalError</ErrorCode> <ErrorMessage>Internal error.</ErrorMessage> </Message> </Messages>
錯誤碼
錯誤碼 | 錯誤資訊 | 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 | 參數值非法,請根據提示調整。 |