Simple Message Queue (formerly MNS)：BatchPeekMessage

授權資訊

預設僅限阿里雲帳號使用本介面，RAM使用者只有在被授予了相關API操作許可權後方可使用。本介面的授權資訊如下表所示。更多資訊，請參見授權策略和樣本。

使用說明

該介面用於消費者批量查看訊息，一次最多查看16條訊息。

BatchPeekMessage與BatchReceiveMessage不同，BatchPeekMessage並不會改變訊息的狀態。訊息被BatchPeekMessage擷取後，仍然處於Active狀態，可被查看或消費；而訊息被BatchReceiveMessage擷取後，進入Inactive狀態，在VisibilityTimeout的時間內不可被查看和消費。

請求訊息

請求訊息由請求行、特有URL參數、HTTP頭和訊息體四部分組成：

• 請求行

  GET /queues/$queueName/messages?peekonly=true&numOfMessages=16 HTTP/1.1

• 特有URI參數

  參數名稱	類型	是否必選	樣本值	描述
  peekonly	Boolean	是	true	表示這次請求只是去查看隊列頂部的訊息並不會引起訊息的狀態改變。取值固定為true。
  numOfMessages	Integer	是	16	本次BatchPeekMessage最多查看訊息條數。

• 特有Request Header

  無。

• Request Body

  無。

返回訊息

返回訊息由返回狀態行，HTTP頭和訊息體三部分組成：

• HTTP Status Code

  HTTP/1.1 200 OK

• 特有Response Header

  無。

• Response Body

  返回的結果為XML格式，返回多條Message訊息本文及訊息屬性。

  參數名稱	類型	樣本值	描述
  MessageId	String	D6D5F7C9C12D14A4-1-14D953EFC72-20000****	訊息編號，在同一個Queue中唯一。
  MessageBody	String	This is a test message.	訊息本文。
  MessageBodyMD5	String	F9360F391579E71CA77BC5D50242****	訊息本文的MD5值。
  EnqueueTime	Long	1250700979248	訊息發送到隊列的時間，取值為從1970年01月01日00:00:00 000開始的時間。
  FirstDequeueTime	Long	1250700979348	訊息第一次被消費的時間，取值為從1970年01月01日00:00:00 000開始的毫秒數，如果DequeueCount為0，則與訊息的EnqueueTime相同。
  DequeueCount	Integer	5	總共被消費的次數。
  Priority	Integer	8	訊息消費的優先順序，數值越小，優先順序越高。

樣本

請求樣本：

GET  /queues/$queueName/messages?peekonly=true&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
Connection:close
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>D6D5F7C9C12D14A4-1-14D953EFC72-20000****</MessageId>
    <MessageBodyMD5>F9360F391579E71CA77BC5D50242****</MessageBodyMD5>
    <MessageBody>This is a test message.</MessageBody>
    <EnqueueTime>1250700979248</EnqueueTime>
    <FirstDequeueTime>1250700979348</FirstDequeueTime >
    <DequeueCount>5</DequeueCount>
    <Priority>8<Priority>
</Message>
<Message>
    <MessageId>D6D5F7C9C12D14A4-1-14D953EFC72-20000****</MessageId>
    <MessageBodyMD5>F9360F391579E71CA77BC5D50242****</MessageBodyMD5>
    <MessageBody>This is a test message.</MessageBody>
    <EnqueueTime>1250700979250</EnqueueTime>
    <FirstDequeueTime>1250700979352</FirstDequeueTime >
    <DequeueCount>5</DequeueCount>
    <Priority>8<Priority>
</Message>
</Messages>            

錯誤碼