授權信息

默認僅限阿里云賬號使用本接口，RAM用戶只有在被授予了相關API操作權限后方可使用。本接口的授權信息如下表所示。更多信息，請參見授權策略和示例。

使用說明

該接口用于消費者消費隊列中的消息，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。

  • 進入長輪詢后，建議您降低外部調用長輪詢的并發數，選擇合適的長輪詢時間。詳細信息，請參見使用限制。目前輕量消息隊列（原 MNS）服務端會根據長輪詢數量、長輪詢等待時間、訪問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	總共被消費的次數。

示例

請求示例：

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>

錯誤碼