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

获取队列属性

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

基本信息

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

描述

该接口用于获取某个已创建队列的属性,返回属性除了创建队列时设置的可设置属性外,还可以取到队列创建时间、队列属性修改最后时间以及队列中的各类消息统计数(近似值)。

Request

Request的构造主要由以下几个部分组成。

  • 请求行

    GET /queues/$queueName HTTP/1.1

  • 特有Request Header

    无,请参考 调用方式/公共参数

  • Request Body

Response

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

  • HTTP Status Code

    HTTP/1.1 200 OK

  • 特有Response Header

    无,请参考 调用方式/公共参数

  • Response Body

    返回的结果为XML格式,格式为:<Queue>Attribute Element List</Queue>

属性元素列表包括:

参数名称 说明
QueueName Queue 的名称
CreateTime Queue 的创建时间,从1970-1-1 00:00:00 到现在的秒值
LastModifyTime 修改 Queue 属性信息最近时间,从1970-1-1 00:00:00 到现在的秒值
DelaySeconds 发送消息到该 Queue 的所有消息默认将以 DelaySeconds 参数指定的秒数延后可被消费,单位为秒
MaximumMessageSize 发送到该 Queue 的消息体的最大长度,单位为byte
MessageRetentionPeriod 消息在该 Queue 中最长的存活时间,从发送到该队列开始经过此参数指定的时间后,不论消息是否被取出过都将被删除,单位为秒
PollingWaitSeconds 当 Queue 消息量为空时,针对该 Queue 的 ReceiveMessage 请求最长的等待时间,单位为秒
Activemessages 在该 Queue 中处于 Active 状态的消息总数,为近似值
InactiveMessages 在该 Queue 中处于 Inactive 状态的消息总数,为近似值
DelayMessages 在该 Queue 中处于 Delayed 状态的消息总数,为近似值
LoggingEnabled 是否开启日志管理功能,True表示启用,False表示停用

Special Error

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

请求示例:

  1. GET /queues/$queueName HTTP/1.1
  2. Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
  3. Date: Wed, 08 Mar 2012 12:00: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:145
  4. x-mns-request-id:512B2A634403E52B1956133E
  5. x-mns-version: 2015-06-06
  6. <?xml version="1.0" encoding="UTF-8"?>
  7. <Queue xmlns="http://mns.aliyuncs.com/doc/v1/">
  8. <QueueName>$queueName </QueueName ><!—以实际Queue Name返回 ->
  9. <CreateTime>1250700999</CreateTime >
  10. <LastModifyTime>1250700999</LastModifyTime>
  11. <VisibilityTimeout>60</VisibilityTimeout >
  12. <MaximumMessageSize>65536</MaximumMessageSize>
  13. <MessageRetentionPeriod>65536</MessageRetentionPeriod>
  14. <DelaySeconds>30</DelaySecond>
  15. <PollingWaitSeconds>0</PollingWaitSeconds>
  16. <InactiveMessages>0</InactiveMessages>
  17. <ActiveMessages>20</ActiveMessages>
  18. <DelayMessages>0</DelayMessages>
  19. <LoggingEnabled>True</LoggingEnabled>
  20. </Queue>
本文导读目录