調用BatchReceiveMessage接口批量消費隊列中的消息。
授權信息
默認僅限阿里云賬號使用本接口,RAM用戶只有在被授予了相關API操作權限后方可使用。本接口的授權信息如下表所示。更多信息,請參見授權策略和示例。
Name | Value |
API | BatchReceiveMessage |
RAM授權操作 | mns:BatchReceiveMessage |
資源 | acs:mns:$region:$accountid:/queues/$queueName/messages |
使用說明
該接口用于消費者批量消費隊列中的消息,一次BatchReceiveMessage操作最多可以獲取16條消息。該操作會將取得的消息狀態變成Inactive,Inactive狀態的時間長度由Queue的屬性VisibilityTimeout
指定。更多信息,請參見CreateQueue。
消費者在VisibilityTimeout
時間內消費成功后需要調用DeleteMessage接口刪除取得的消息,否則取得的消息將會被重新變成Active狀態,又可被消費者重新消費。
請求消息
請求消息由請求行、特有URL參數、HTTP頭和消息體四部分組成:
請求行
GET /queues/$queueName/messages?numOfMessages=16&waitseconds=10 HTTP/1.1
特有URI參數
參數名稱
類型
是否必選
示例值
描述
numOfMessages
Integer
是
10
本次BatchReceiveMessage最多獲取的消息條數。
waitseconds
Integer
否
0
本次ReceiveMessage請求最長的Polling等待時間,單位為秒。
如果BatchReceiveMessage請求附帶waitseconds
參數,在Queue無消息時,此次BatchReceiveMessage請求進入到Polling狀態(即長輪詢),等待時長為waitseconds
。如果未設置waitseconds
,則默認使用所屬Queue的PollingWaitSeconds
屬性。更多信息,請參見CreateQueue 。
特有Request Header
無。
Request Body
無。
返回消息
返回消息由返回狀態行、HTTP頭和消息體三部分組成:
HTTP Status Code
HTTP/1.1 200 OK
特有Response Header
無。
Response Body
返回的結果為XML格式,返回多條Message消息正文及消息屬性。
參數名稱
類型
示例值
描述
MessageId
String
5F290C926D472878-2-14D9529A8FA-20000****
消息編號,在一個Queue中唯一。
ReceiptHandle
String
1-ODU4OTkzNDU5My0xNDMyNzI3ODI3LTItOA==
本次獲取消息產生的臨時句柄,用于刪除和修改處于Inactive消息,NextVisibleTime之前有效。
MessageBody
String
This is test message 1.
消息正文。
MessageBodyMD5
String
C5DD56A39F5F7BB8B3337C6D11B6****
消息正文的MD5值。
EnqueueTime
Long
1250700979248
消息發送到隊列的時間,從1970年01月01日00:00:00 000開始的毫秒數。
NextVisibleTime
Long
1250700799348
下次可被再次消費的時間,從1970年01月01日 00:00:00 000開始的毫秒數。
FirstDequeueTime
Long
1250700779318
第一次被消費的時間,從1970年01月01日00:00:00 000開始的毫秒數。
DequeueCount
Integer
1
總共被消費的次數。
示例
請求示例:
GET /queues/$queueName/messages?numOfMessages=16 HTTP/1.1
Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
Date: Wed, 28 May 2012 22:32:00 GMT
x-mns-version: 2015-06-06
Authorization: MNS 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXA****
返回示例:
HTTP/1.1 200 OK
Content-Type=text/xml;charset=utf-8
Content-Length:500
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>
<ReceiptHandle>1-ODU4OTkzNDU5My0xNDMyNzI3ODI3LTItOA==</ReceiptHandle>
<MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6****</MessageBodyMD5>
<MessageBody>This is test message 1.</MessageBody>
<EnqueueTime>1250700979248</EnqueueTime>
<NextVisibleTime>1250700799348</NextVisibleTime>
<FirstDequeueTime>1250700779318</FirstDequeueTime >
<DequeueCount>1</DequeueCount>
<Priority>8</Priority>
</Message>
<Message>
<ReceiptHandle>1-ODU4OTkzNDU5My0xNDMyNzI3MjQwLTEtOA==</ReceiptHandle>
<MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6****</MessageBodyMD5>
<MessageBody>This is test message 2.</MessageBody>
<EnqueueTime>1250700979252</EnqueueTime>
<NextVisibleTime>1250700799350</NextVisibleTime>
<FirstDequeueTime>1250700779330</FirstDequeueTime >
<DequeueCount>1</DequeueCount>
<Priority>8</Priority>
</Message>
</Messages>
錯誤碼
錯誤碼 | 錯誤信息 | HTTP狀態碼 | 描述內容 |
QueueNotExist | The queue name you provided is not exist. | 404 | 隊列不存在,請先創建隊列。 |
MessageNotExist | Message not exist. | 404 | 隊列中沒有可見消息。 |