調用ReceiveMessage介面消費隊列中的訊息。
授權資訊
預設僅限阿里雲帳號使用本介面,RAM使用者只有在被授予了相關API操作許可權後方可使用。本介面的授權資訊如下表所示。更多資訊,請參見授權策略和樣本。
Name | Value |
API | ReceiveMessage |
RAM授權操作 | mns:ReceiveMessage |
資源 | acs:mns:$region:$accountid:/queues/$queueName/messages |
使用說明
該介面用於消費者消費隊列中的訊息,ReceiveMessage操作會將取得的訊息狀態變成Inactive,Inactive狀態的時間長度由Queue屬性VisibilityTimeout
指定,詳情請參見CreateQueue。
消費者在VisibilityTimeout
時間內消費成功後需要調用DeleteMessage介面刪除該訊息,否則該訊息將會重新變成Active狀態,又可被消費者重新消費。
請求訊息
請求訊息由請求行、特有URL參數、HTTP頭和訊息體四部分組成:
請求行
GET /queues/$queueName/messages?waitseconds=10 HTTP/1.1
特有URI參數
參數
類型
是否必選
樣本值
描述
waitseconds
Integer
否
0
本次ReceiveMessage請求最長的Polling等待時間,單位為秒。
說明如果ReceiveMessage請求附帶waitseconds參數,在Queue無訊息時,此次ReceiveMessage請求進入到Polling狀態(即長輪詢),等待的時間長度為waitseconds,在這段時間中,如果Queue有訊息寫入會返回給使用者;如果未設定waitseconds ,則預設使用所屬Queue的PollingWaitSeconds屬性。詳細資料,請參見CreateQueue。
進入長輪詢後,建議您降低外部調用長輪詢的並發數,選擇合適的長輪詢時間。詳細資料,請參見使用限制。目前Message ServiceMNS服務端會根據長輪詢數量、長輪詢等待時間、訪問IP數量等因素動態調整長輪詢防攻擊的並發上限值。當隊列無訊息時,超過長輪詢上限值的請求將無法被監聽到,並直接返回404 MessageNotExist(按請求量正常計費)。如果您有臨時提升長輪詢上限值的需求,請及時提交工單聯絡客服,避免產生不必要的費用支出。
特有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 a test message
訊息本文。
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
總共被消費的次數。
Priority
Integer
8
訊息的優先順序權值。
樣本
請求樣本:
GET /queues/$queueName/messages 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"?>
<Message xmlns="http://mns.aliyuncs.com/doc/v1/">
<MessageId>5F290C926D472878-2-14D9529A8FA-20000****</MessageId>
<ReceiptHandle>1-ODU4OTkzNDU5My0xNDMyNzI3ODI3LTItOA==</ReceiptHandle>
<MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6****</MessageBodyMD5>
<MessageBody>This is a test message</MessageBody>
<EnqueueTime>1250700979248</EnqueueTime>
<NextVisibleTime>1250700799348</NextVisibleTime>
<FirstDequeueTime>1250700779318</FirstDequeueTime >
<DequeueCount>1</DequeueCount >
<Priority>8</Priority>
</Message>
錯誤碼
錯誤碼 | 錯誤資訊 | HTTP狀態代碼 | 描述內容 |
QueueNotExist | The queue name you provided is not exist. | 404 | 隊列不存在,請先建立隊列。 |
MessageNotExist | Message not exist. | 404 | 隊列中沒有可見訊息。 |