全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 阿里云办公 培训与认证 物联网
消息服务

获取队列列表

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

基本信息

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

描述

该接口用于列出 AccountId 下的队列列表,可分页获取数据。返回结果中只包含 QueueURL 属性,如需进一步获取消息队列的属性可以通过 GetQueueAttributes 接口(详见本文档 GetQueueAttributes 接口)获取。如果只是要获取特定前缀的队列列表,在调用此接口时指定 x-mns-prefix 参数,返回对队列名称的前缀匹配结果。

Tip:

如果本次请求结果返回的消息队列总数超过本次请求的 x-mns-ret-number 参数值,返回的XML结果中包含的 NextMarker 表示下一页开始位置,在下一次请求时将该值赋予 x-mns-marker 参数以返回下一页的结果。

Request

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

  • 请求行

    GET /queues HTTP/1.1

  • 特有Request Header

参数名称 说明 选项
x-mns-marker 请求下一个分页的开始位置,一般从上次分页结果返回的NextMarker获取。 Optional
x-mns-ret-number 单次请求结果的最大返回个数,可以取1-1000范围内的整数值,默认值为1000。 Optional
x-mns-prefix 按照该前缀开头的 queueName 进行查找。 Optional

其它参数请参考 调用方式/公共参数

  • Request Body

Response

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

  • HTTP Status Code

    HTTP/1.1 200 OK

  • 特有Response Header

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

  • Response Body

    返回XML形式的结果,顶层 Queues 元素下包含多个 Queue 元素, Queue 元素中包含 QueueURL 元素,QueueURL 表示 Quque 的可访问 URL 地址。如果返回结果超过 x-mns-ret-number 的参数值,包含 NextMarker 元素表示下个分页的起始位置。

Special Error

本操作无特有的错误,主要是权限验证类和参数设置类错误,详见 MNS 错误响应码。

请求示例:

  1. GET /queues HTTP/1.1
  2. x-mns-marker: xxxx
  3. x-mns-ret-number:2
  4. Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
  5. Date: Wed, 08 Mar 2012 12:00:00 GMT
  6. x-mns-version: 2015-06-06
  7. Authorization: MNS 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAMPLE=

返回示例:

  1. HTTP/1.1 200 OK
  2. x-mns-request-id:512B2A634403E52B1956133E
  3. x-mns-version: 2015-06-06
  4. <?xml version="1.0" encoding="UTF-8"?>
  5. <Queues xmlns="http://mns.aliyuncs.com/doc/v1/">
  6. <Queue>
  7. <QueueURL>http://$AccountId.mns.cn-hangzhou.aliyuncs.com/queues/queueName1</QueueURL>
  8. </Queue>
  9. <Queue>
  10. <QueueURL>http://$AccountId.mns.cn-hangzhou.aliyuncs.com/queues/queueName2</QueueURL>
  11. </Queue>
  12. <NextMarker> Base64 Encoded Result </NextMarker>
  13. </Queues>
本文导读目录
本文导读目录
以上内容是否对您有帮助?