调用ListQueue接口,列出指定阿里云账号下的所有队列,可分页获取数据。
授权信息
默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见授权策略和示例。
Name | Value |
---|---|
API | ListQueue |
RAM授权操作 | mns:ListQueue |
资源 | acs:mns:$region:$accountid:/queues |
使用说明
调用该接口返回结果中只包含QueueURL属性,如需进一步获取消息队列的属性可以通过GetQueueAttributes接口获取。如果仅需要获取特定前缀的队列列表,在调用此接口时指定x-mns-prefix
参数,即可返回对队列名称的前缀匹配结果。
说明 如果本次请求结果返回的消息队列总数超过本次请求的
x-mns-ret-number
参数值,返回的XML结果中包含的NextMarker
表示下一页开始位置,在下一次请求时将该值赋予x-mns-marker
参数以返回下一页的结果。
请求消息
请求消息由请求行、HTTP头和消息体三部分组成:
- 请求行
GET /queues HTTP/1.1
- 特有Request Header
参数名称 类型 是否必选 示例值 描述 x-mns-marker Integer 否 10 请求下一个分页的开始位置,一般从上次分页结果返回的NextMarker获取。 x-mns-ret-number Integer 否 1000 单次请求结果的最大返回个数。 取值范围:1~1000。
x-mns-prefix String 否 queue 按照该前缀开头的queueName进行查找。 其它参数,请参见公共参数。
- Request Body
无。
返回消息
返回消息由返回状态行、HTTP头和消息体三部分组成:
- HTTP Status Code
HTTP/1.1 200 OK
- 特有Response Header
无。
- Response Body
返回XML形式的结果,顶层Queues元素下包含多个Queue元素,Queue元素中包含QueueURL元素,QueueURL表示Queue的可访问URL地址。如果返回结果超过
x-mns-ret-number
的参数值,包含NextMarker
元素表示下个分页的起始位置。
示例
请求示例:
GET /queues HTTP/1.1
x-mns-marker: 10
x-mns-ret-number:1000
Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
Date: Wed, 08 Mar 2012 12:00:00 GMT
x-mns-version: 2015-06-06
Authorization: MNS 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXAM****
返回示例:
HTTP/1.1 200 OK
x-mns-request-id:512B2A634403E52B1956****
x-mns-version: 2015-06-06
<?xml version="1.0" encoding="UTF-8"?>
<Queues xmlns="http://mns.aliyuncs.com/doc/v1/">
<Queue>
<QueueURL>http://$AccountId.mns.cn-hangzhou.aliyuncs.com/queues/queueName1</QueueURL>
</Queue>
<Queue>
<QueueURL>http://$AccountId.mns.cn-hangzhou.aliyuncs.com/queues/queueName2</QueueURL>
</Queue>
<NextMarker> Base64 Encoded Result </NextMarker>
</Queues>
错误码
本操作无特有的错误,主要是权限验证类和参数设置类错误。更多信息,请参见错误码。