全部產品
Search
文件中心

Simple Message Queue (formerly MNS):PeekMessage

更新時間:Jun 30, 2024

調用PeekMessage介面查看訊息。

授權資訊

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

NameValue
APIPeekMessage
RAM授權操作mns:PeekMessage
資源acs:mns:$region:$accountid:/queues/$queueName/messages

使用說明

該介面用於消費者查看訊息,PeekMessage與ReceiveMessage不同,PeekMessage不會改變訊息的狀態。訊息被PeekMessage擷取後,訊息仍然處於Active狀態,可被查看或消費。而訊息被ReceiveMessage擷取後,進入Inactive狀態,在VisibilityTimeout的時間內不可被查看和消費。

請求訊息

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

  • 請求行

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

  • URI參數

    peekonly=true表示這次請求只是去查看隊列頂部的訊息,並不會引起訊息的狀態改變。

  • 特有Request Header

    無。

  • Request Body

    無。

返回訊息

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

  • HTTP Status Code

    HTTP/1.1 200 OK

  • 特有Response Header

    無。

  • Response Body

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

    參數名稱類型樣本值描述
    MessageIdStringD6D5F7C9C12D14A4-1-14D953EFC72-20000****訊息編號,在同一個Queue中唯一。
    MessageBodyStringThis is a test message.訊息本文。
    MessageBodyMD5StringF9360F391579E71CA77BC5D50242****訊息本文的MD5值。
    EnqueueTimeLong1250700979248訊息發送到隊列的時間,取值為從1970年01月01日00:00:00 000開始的毫秒數。
    FirstDequeueTimeLong1250700979348第一次被消費的時間,取值為從1970年01月01日00:00:00 000開始的毫秒數,如果DequeueCount為0,則與訊息的EnqueueTime相同。
    DequeueCountInteger5總共被消費的次數。
    PriorityInteger8訊息消費的優先順序,數值越小,優先順序越高。

樣本

請求樣本:

GET  /queues/$queueName/messages?peekonly=true 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"?>
<Message xmlns="http://mns.aliyuncs.com/doc/v1/">
    <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>            

錯誤碼

錯誤碼錯誤訊息HTTP狀態代碼描述內容
QueueNotExistThe queue name you provided is not exist.404隊列不存在,請先建立隊列。
MessageNotExistMessage not exist.404隊列中沒有可見訊息。