全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件
消息服务

批量消费消息

更新时间:2017-06-07 13:26:11

基本信息

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最多获取的消息条数 Required
waitseconds 本次ReceiveMessage请求最长的Polling等待时间①,单位为秒 Optional

说明:

① 如果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月1日 00:00:00 000 开始的毫秒数
DequeueCount 总共被消费的次数
Priority 消息的优先级权值

Special Error

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

请求示例:

  1. GET /queues/$queueName/messages?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. Content-Type=text/xml;charset=utf-8
  3. Content-Length:500
  4. x-mns-request-id:512B2A634403E52B1956133E
  5. x-mns-version: 2015-06-06
  6. <?xml version="1.0" encoding="UTF-8"?>
  7. <Messages xmlns="http://mns.aliyuncs.com/doc/v1/">
  8. <Message>
  9. <MessageId>5F290C926D472878-2-14D9529A8FA-200000001</MessageId>
  10. <ReceiptHandle>1-ODU4OTkzNDU5My0xNDMyNzI3ODI3LTItOA==</ReceiptHandle>
  11. <MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6D8C7</MessageBodyMD5>
  12. <MessageBody>This is a test message</MessageBody>
  13. <EnqueueTime>1250700979248</EnqueueTime>
  14. <NextVisibleTime>1250700799348</NextVisibleTime>
  15. <FirstDequeueTime>1250700779318</FirstDequeueTime >
  16. <DequeueCount>1</DequeueCount>
  17. <Priority>8</Priority>
  18. </Message>
  19. <Message>
  20. <ReceiptHandle>1-ODU4OTkzNDU5My0xNDMyNzI3MjQwLTEtOA==</ReceiptHandle>
  21. <MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6D8C7</MessageBodyMD5>
  22. <MessageBody>This is a test message</MessageBody>
  23. <EnqueueTime>1250700979252</EnqueueTime>
  24. <NextVisibleTime>1250700799350</NextVisibleTime>
  25. <FirstDequeueTime>1250700779330</FirstDequeueTime >
  26. <DequeueCount>1</DequeueCount>
  27. <Priority>8</Priority>
  28. </Message>
  29. </Messages>
本文导读目录