批量消费消息__队列接口规范_API使用手册_消息服务-阿里云
描述
该接口用于消费者批量队列的消息,一次 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 |
请求示例:
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:512B2A634403E52B1956133E
x-mns-version: 2015-06-06
<?xml version="1.0" encoding="UTF-8"?>
<Messages xmlns="https://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>
最后更新:2016-11-23 17:16:09
上一篇:
批量发送消息__队列接口规范_API使用手册_消息服务-阿里云
下一篇:
批量删除消息__队列接口规范_API使用手册_消息服务-阿里云
作业结果和日志查看__执行计划_用户指南_E-MapReduce-阿里云
解析域名__快速入门_负载均衡-阿里云
查看弹性公网IP监控信息__监控相关接口_API 参考_云服务器 ECS-阿里云
获取域名 Whois 信息__域名管理接口_API文档_云解析-阿里云
步骤一: 实验环境准备__快速入门_推荐引擎-阿里云
培训合作伙伴招募___培训合作伙伴-阿里云
在专有网络中搭建SNAT网关__配置_用户指南_专有网络 VPC-阿里云
SqlServer数据源配置__数据源配置_数据同步手册_用户操作指南_大数据开发套件-阿里云
备案服务号怎么获得?__产品验证_备案流程_备案-阿里云
删除编排模板__镜像与模板管理_用户指南_容器服务-阿里云
相关内容
常见错误说明__附录_大数据计算服务-阿里云
发送短信接口__API使用手册_短信服务-阿里云
接口文档__Android_安全组件教程_移动安全-阿里云
运营商错误码(联通)__常见问题_短信服务-阿里云
设置短信模板__使用手册_短信服务-阿里云
OSS 权限问题及排查__常见错误及排除_最佳实践_对象存储 OSS-阿里云
消息通知__操作指南_批量计算-阿里云
设备端快速接入(MQTT)__快速开始_阿里云物联网套件-阿里云
查询API调用流量数据__API管理相关接口_API_API 网关-阿里云
使用STS访问__JavaScript-SDK_SDK 参考_对象存储 OSS-阿里云