863
阿裏雲
批量消費消息__隊列接口規範_API使用手冊_消息服務-阿裏雲
描述
該接口用於消費者批量隊列的消息,一次 BatchReceiveMessage 操作最多可以獲取16條消息。該操作會將取得的消息狀態變成 Inactive,Inactive 的時間長度由 Queue 屬性 VisibilityTimeout 指定(詳見 CreateQueue 接口)。消費者在 VisibilityTimeout 時間內消費成功後需要調用 DeleteMessage 接口刪除取得的消息,否則取得的消息將會被重新置為 Active,又可被消費者重新消費。
Request
Request的構造主要由以下幾個部分組成:
請求行
GET /queues/$queueName/messages?numOfMessages=16&waitseconds=10 HTTP/1.1
特有URI參數
參數名稱 | 說明 | 選項 |
---|---|---|
numOfMessages | 本次BatchReceiveMessage最多獲取的消息條數 | Required |
waitseconds | 本次ReceiveMessage請求最長的Polling等待時間①,單位為秒 | Optional |
說明:
① 如果BatchReceiveMessage請求附帶waitseconds參數,在 Queue 無消息時,此次 BatchReceiveMessage 請求進入到 Polling,等待時長為 waitseconds;如果未設置 waitseconds,則默認使用所屬 Queue 的 PollingWaitSeconds 屬性(參見 CreateQueue 接口)。
特有Request Header
無,請參考 調用方式/公共參數
Request Body
無
Response
返回消息由返回狀態行,HTTP頭和消息體三部分組成。
HTTP Status Code
HTTP/1.1 200 OK
特有Response Header
無,請參考 調用方式/公共參數
Response Body
返回的結果為XML格式,返回多條Message消息正文及消息屬性。
參數名稱 | 說明 |
---|---|
MessageId | 消息編號,在一個 Queue 中唯一 |
ReceiptHandle | 本次獲取消息產生的臨時句柄,用於刪除和修改處於 Inactive 消息,NextVisibleTime 之前有效。 |
MessageBody | 消息正文 |
MessageBodyMD5 | 消息正文的 MD5 值 |
EnqueueTime | 消息發送到隊列的時間,從1970年1月1日 00:00:00 000 開始的毫秒數 |
NextVisibleTime | 下次可被再次消費的時間,從1970年1月1日 00:00:00 000 開始的毫秒數 |
FirstDequeueTime | 第一次被消費的時間,從1970年1月1日 00:00:00 000 開始的毫秒數 |
DequeueCount | 總共被消費的次數 |
Priority | 消息的優先級權值 |
Special Error
錯誤代碼 | 錯誤消息 | 狀態碼 |
---|---|---|
QueueNotExist | The queue name you provided is not exist. | 404 |
MessageNotExist | Message not exist. | 404 |
請求示例:
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+FIEXAMPLE
返回示例:
HTTP/1.1 200 OK
Content-Type=text/xml;charset=utf-8
Content-Length:500
x-mns-request-id:512B2A634403E52B1956133E
x-mns-version: 2015-06-06
<?xml version="1.0" encoding="UTF-8"?>
<Messages xmlns="https://mns.aliyuncs.com/doc/v1/">
<Message>
<MessageId>5F290C926D472878-2-14D9529A8FA-200000001</MessageId>
<ReceiptHandle>1-ODU4OTkzNDU5My0xNDMyNzI3ODI3LTItOA==</ReceiptHandle>
<MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6D8C7</MessageBodyMD5>
<MessageBody>This is a test message</MessageBody>
<EnqueueTime>1250700979248</EnqueueTime>
<NextVisibleTime>1250700799348</NextVisibleTime>
<FirstDequeueTime>1250700779318</FirstDequeueTime >
<DequeueCount>1</DequeueCount>
<Priority>8</Priority>
</Message>
<Message>
<ReceiptHandle>1-ODU4OTkzNDU5My0xNDMyNzI3MjQwLTEtOA==</ReceiptHandle>
<MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6D8C7</MessageBodyMD5>
<MessageBody>This is a test message</MessageBody>
<EnqueueTime>1250700979252</EnqueueTime>
<NextVisibleTime>1250700799350</NextVisibleTime>
<FirstDequeueTime>1250700779330</FirstDequeueTime >
<DequeueCount>1</DequeueCount>
<Priority>8</Priority>
</Message>
</Messages>
最後更新:2016-11-23 17:16:09
上一篇:
批量發送消息__隊列接口規範_API使用手冊_消息服務-阿裏雲
下一篇:
批量刪除消息__隊列接口規範_API使用手冊_消息服務-阿裏雲
作業結果和日誌查看__執行計劃_用戶指南_E-MapReduce-阿裏雲
解析域名__快速入門_負載均衡-阿裏雲
查看彈性公網IP監控信息__監控相關接口_API 參考_雲服務器 ECS-阿裏雲
獲取域名 Whois 信息__域名管理接口_API文檔_雲解析-阿裏雲
步驟一: 實驗環境準備__快速入門_推薦引擎-阿裏雲
培訓合作夥伴招募___培訓合作夥伴-阿裏雲
在專有網絡中搭建SNAT網關__配置_用戶指南_專有網絡 VPC-阿裏雲
SqlServer數據源配置__數據源配置_數據同步手冊_用戶操作指南_大數據開發套件-阿裏雲
備案服務號怎麼獲得?__產品驗證_備案流程_備案-阿裏雲
刪除編排模板__鏡像與模板管理_用戶指南_容器服務-阿裏雲
相關內容
常見錯誤說明__附錄_大數據計算服務-阿裏雲
發送短信接口__API使用手冊_短信服務-阿裏雲
接口文檔__Android_安全組件教程_移動安全-阿裏雲
運營商錯誤碼(聯通)__常見問題_短信服務-阿裏雲
設置短信模板__使用手冊_短信服務-阿裏雲
OSS 權限問題及排查__常見錯誤及排除_最佳實踐_對象存儲 OSS-阿裏雲
消息通知__操作指南_批量計算-阿裏雲
設備端快速接入(MQTT)__快速開始_阿裏雲物聯網套件-阿裏雲
查詢API調用流量數據__API管理相關接口_API_API 網關-阿裏雲
使用STS訪問__JavaScript-SDK_SDK 參考_對象存儲 OSS-阿裏雲