开发者社区> 问答> 正文

API如何获取队列列表?



基本信息

NameValue
[backcolor=transparent]APIListQueue
[backcolor=transparent]RAM授权操作mns:ListQueue
[backcolor=transparent]资源acs:mns:$region:$accountid:/queues


描述


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

[backcolor=transparent]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

其它参数请参考 [backcolor=transparent]调用方式/公共参数
  • Request Body



Response


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

  • HTTP Status Code

    HTTP/1.1 200 OK

  • 特有Response Header

    无,请参考 [backcolor=transparent]调用方式/公共参数

  • Response Body

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


Special Error


本操作无特有的错误,主要是权限验证类和参数设置类错误,详见 MNS 错误响应码。
[backcolor=transparent]请求示例:
[backcolor=transparent]

展开
收起
轩墨 2017-10-24 15:25:13 1767 0
0 条回答
写回答
取消 提交回答
问答排行榜
最热
最新

相关电子书

更多
CUDA MATH API 立即下载
API PLAYBOOK 立即下载
传统企业的“+互联网”-API服务在京东方的实践 立即下载