閱讀760 返回首頁    go windows


批量查看消息__隊列接口規範_API使用手冊_消息服務-阿裏雲

描述

該接口用於消費者批量查看消息,一次最多查看16條消息。BatchPeekMessage 與 BatchReceiveMessage 不同, BatchPeekMessage 並不會改變消息的狀態,即被 BatchPeekMessage 獲取消息後消息仍然處於 Active 狀態,仍然可被查看或消費;而後者操作成功後消息進入 Inactive,在 VisibilityTimeout 的時間內不可被查看和消費。

Request

Request的構造主要由以下幾個部分組成:

  • 請求行

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

  • 特有URI參數

參數名稱 說明 選項
peekonly=true 表示這次請求隻是去查看隊列頂部的消息並不會引起消息的狀態改變 Required
numOfMessages 本次 BatchPeekMessage 最多查看消息條數 Required
  • 特有Request Header

    無,請參考 調用方式/公共參數

  • Request Body

Response

返回消息由返回狀態行,HTTP頭和消息體三部分組成。

  • HTTP Status Code

    HTTP/1.1 200 OK

  • 特有Response Header

    無,請參考 調用方式/公共參數

  • Response Body

    返回的結果為XML格式,返回多條Message消息正文及消息屬性。

參數名稱 說明
MessageId 消息編號,在一個 Queue 唯一
MessageBody 消息正文
MessageBodyMD5 消息正文的 MD5 值
EnqueueTime 消息發送到隊列的時間,從1970年1月1日 00:00:00 000 開始的毫秒數
FirstDequeueTime 第一次被消費的時間,從1970年1月1日 00:00:00 000 開始的毫秒數,如果 DequeueCount 為0,則與消息的 EnqueueTime 相同
DequeueCount 總共被消費的次數
Priority 消息的優先級權值

Special Error

錯誤代碼 錯誤消息 狀態碼
QueueNotExist The queue name you provided is not exist. 404
MessageNotExist Message not exist. 404

請求示例:

  1. GET /queues/$queueName/messages?peekonly=true&numOfMessages=16 HTTP/1.1
  2. Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
  3. Date: Wed, 28 May 2012 22:32:00 GMT
  4. x-mns-version: 2015-06-06
  5. Authorization: MNS 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE

返回示例:

  1. HTTP/1.1 200 OK
  2. Connection:close
  3. Content-Type=text/xml;charset=utf-8
  4. Content-Length:500
  5. x-mns-request-id:512B2A634403E52B1956133E
  6. x-mns-version: 2015-06-06
  7. <?xml version="1.0" encoding="UTF-8"?>
  8. <Messages xmlns="https://mns.aliyuncs.com/doc/v1/">
  9. <Message>
  10. <MessageId>D6D5F7C9C12D14A4-1-14D953EFC72-200000004</MessageId>
  11. <MessageBodyMD5>F9360F391579E71CA77BC5D50242FCF4</MessageBodyMD5>
  12. <MessageBody>This is a test message</MessageBody>
  13. <EnqueueTime>1250700979248</EnqueueTime>
  14. <FirstDequeueTime>1250700979348</FirstDequeueTime >
  15. <DequeueCount>5</DequeueCount>
  16. <Priority>8<Priority>
  17. </Message>
  18. <Message>
  19. <MessageId>D6D5F7C9C12D14A4-1-14D953EFC72-200000005</MessageId>
  20. <MessageBodyMD5>F9360F391579E71CA77BC5D50242FCF4</MessageBodyMD5>
  21. <MessageBody>This is a test message</MessageBody>
  22. <EnqueueTime>1250700979250</EnqueueTime>
  23. <FirstDequeueTime>1250700979352</FirstDequeueTime >
  24. <DequeueCount>5</DequeueCount>
  25. <Priority>8<Priority>
  26. </Message>
  27. </Messages>

最後更新:2016-11-23 17:16:09

  上一篇:go 查看消息__隊列接口規範_API使用手冊_消息服務-阿裏雲
  下一篇:go 修改消息可見時間__隊列接口規範_API使用手冊_消息服務-阿裏雲