使用BatchReceiveMessage接口来批量消费队列的消息。

Name Value
API BatchReceiveMessage
RAM授权操作 mns:BatchReceiveMessage
资源 acs:mns:$region:$accountid:/queues/$queueName/messages

描述

该接口用于消费者批量消费队列的消息,一次BatchReceiveMessage操作最多可以获取16条消息。该操作会将取得的消息状态变成Inactive,Inactive状态的时间长度由Queue的属性VisibilityTimeout指定。详情请参见CreateQueue

消费者在VisibilityTimeout时间内消费成功后需要调用DeleteMessage接口删除取得的消息,否则取得的消息将会被重新变成Active状态,又能被消费者重新消费。

Request

Request由以下几个部分组成:

  • 请求行

    GET /queues/$queueName/messages?numOfMessages=16&waitseconds=10 HTTP/1.1

  • 特有URI参数
    参数名称 是否必选 说明
    numOfMessages 本次BatchReceiveMessage最多获取的消息条数。
    waitseconds 本次ReceiveMessage请求最长的Polling等待时间,单位为秒。
说明 如果BatchReceiveMessage请求附带waitseconds参数,在Queue无消息时,此次BatchReceiveMessage请求进入到Polling状态(即长轮询),等待时长为waitseconds。如果未设置waitseconds,则默认使用所属Queue的PollingWaitSeconds属性,详情请参见CreateQueue
  • 特有Request Header

    无,请参见公共参数

  • Request Body

    无。

Response

返回消息由返回状态行、HTTP头和消息体三部分组成:

  • HTTP Status Code

    HTTP/1.1 200 OK

  • 特有Response Header

    无,请参见公共参数

  • Response Body

    返回的结果为XML格式,返回多条Message消息正文及消息属性。

    参数名称 说明
    MessageId 消息编号,在一个Queue中唯一。
    ReceiptHandle 本次获取消息产生的临时句柄,用于删除和修改处于Inactive消息,NextVisibleTime之前有效。
    MessageBody 消息正文。
    MessageBodyMD5 消息正文的MD5值。
    EnqueueTime 消息发送到队列的时间,从1970年1月1日00:00:00 000开始的毫秒数。
    NextVisibleTime 下次可被再次消费的时间,从1970年1月1日 00:00:00 000开始的毫秒数。
    FirstDequeueTime 第一次被消费的时间,从1970年1月100:00:00 000开始的毫秒数。
    DequeueCount 总共被消费的次数。
    Priority 消息的优先级权值。

示例

请求示例:

GET  /queues/$queueName/messages?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+FIEXAMPLE           

返回示例:

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"?>
<Messages xmlns="http://mns.aliyuncs.com/doc/v1/">
<Message>
    <MessageId>5F290C926D472878-2-14D9529A8FA-200000001</MessageId>
    <ReceiptHandle>1-ODU4OTkzNDU5My0xNDMyNzI3ODI3LTItOA==</ReceiptHandle>
    <MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6D8C7</MessageBodyMD5>
    <MessageBody>This is a test message</MessageBody>
    <EnqueueTime>1250700979248</EnqueueTime>
    <NextVisibleTime>1250700799348</NextVisibleTime>
    <FirstDequeueTime>1250700779318</FirstDequeueTime >
    <DequeueCount>1</DequeueCount>
    <Priority>8</Priority>
</Message>
<Message>
    <ReceiptHandle>1-ODU4OTkzNDU5My0xNDMyNzI3MjQwLTEtOA==</ReceiptHandle>
    <MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6D8C7</MessageBodyMD5>
    <MessageBody>This is a test message</MessageBody>
    <EnqueueTime>1250700979252</EnqueueTime>
    <NextVisibleTime>1250700799350</NextVisibleTime>
    <FirstDequeueTime>1250700779330</FirstDequeueTime >
    <DequeueCount>1</DequeueCount>
    <Priority>8</Priority>
</Message>
</Messages>           

Special Error

错误码 错误信息 状态码
QueueNotExist The queue name you provided is not exist. 404
MessageNotExist Message not exist. 404