文档

ListQueue - 列出指定阿里云账号下的所有队列

更新时间:

调用ListQueue接口,列出指定阿里云账号下的所有队列,可分页获取数据。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mns:ListQueuelist
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PageNumlong

分页页码,查询第几页的返回结果。 取值范围:1~100000000。 若您设置的参数值小于 1,则系统默认按照参数值为 1 处理;若您设置的参数值大于 100000000,则系统默认按照参数值为 100000000 处理。

1
PageSizelong

分页大小,每页最多显示的返回结果数量。 取值范围:10~50。 若您设置的参数值小于 10,则系统默认按照参数值为 10 处理;若您设置的参数值大于 50,则系统默认按照参数值为 50 处理。

20
QueueNamestring

Queue 名称。

demo-queue
Tagarray<object>

资源标签列表。

object

标签键对应的标签值。

Keystring

标签的 key。

tag1
Valuestring

标签值。

test

返回参数

名称类型描述示例值
object
RequestIdstring

请求的 ID。

06273500-249F-5863-121D-74D51123****
Codelong

响应 code。

200
Statusstring

响应的状态。

Success
Messagestring

响应信息。

operation success
Successboolean

请求是否成功。

true
Dataobject

响应数据。

PageNumlong

分页页码,查询第几页的返回结果。

1
PageSizelong

分页大小,每页最多显示的返回结果数量。

50
Sizelong

当前页结果数量。

20
Pageslong

总页数

3
Totallong

总结果数。

130
PageDataarray<object>

当前页返回结果。

object

数据项。

QueueNamestring

队列名称。

demo-queue
CreateTimelong

Queue 的创建事件,从 1970-01-01 00:00:00 到现在的时间。

1250700999
LastModifyTimelong

修改 Queue 属性信息最近时间,从 1970-01-01 00:00:00 到现在的时间。

1250700999
DelaySecondslong

发送到该 Queue 的所有消息的延迟时间,发送到队列的消息经过此参数设定的延时时间后,才能被消费,单位为秒。

30
MaximumMessageSizelong

发送到该 Queue 的消息体的最大长度,单位为 Byte。

65536
MessageRetentionPeriodlong

消息在该 Queue 中最长的存活时间,从发送到该队列开始经过此参数指定的时间后,不论消息是否被取出过都将被删除,单位为秒。

65536
VisibilityTimeoutlong

消息从该 Queue 中取出后从 Active 状态变成 Inactive 状态后的持续时间。 取值范围:1~43200,单位为秒。 默认值:30。

60
PollingWaitSecondslong

当 Queue 消息量为空时,针对该 Queue 的 ReceiveMessage 请求最长的等待时间,单位为秒。

0
ActiveMessageslong

在该 Queue 中处于 Active 状态的消息总数,为近似值。 后续会默认为 0,不推荐使用,辛苦用云监控 api 获取指标

0
InactiveMessageslong

在该 Queue 中处于 Inactive 状态的消息总数,为近似值。 后续会默认为 0,不推荐使用,辛苦用云监控 api 获取指标。

0
DelayMessageslong

在该 Queue 中处于 Delayed 状态的消息总数,为近似值。 后续会默认为 0,不推荐使用,辛苦用云监控 api 获取指标。

0
LoggingEnabledboolean

是否开启日志管理功能。

  • True:启用。

  • False:停用。

True
Tagsarray<object>

资源标签列表。

object

标签键对应的标签值。

TagKeystring

标签的 key。

tag1
TagValuestring

标签值。

test

示例

正常返回示例

JSON格式

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 50,
    "Size": 20,
    "Pages": 3,
    "Total": 130,
    "PageData": [
      {
        "QueueName": "demo-queue",
        "CreateTime": 1250700999,
        "LastModifyTime": 1250700999,
        "DelaySeconds": 30,
        "MaximumMessageSize": 65536,
        "MessageRetentionPeriod": 65536,
        "VisibilityTimeout": 60,
        "PollingWaitSeconds": 0,
        "ActiveMessages": 0,
        "InactiveMessages": 0,
        "DelayMessages": 0,
        "LoggingEnabled": true,
        "Tags": [
          {
            "TagKey": "tag1",
            "TagValue": "test"
          }
        ]
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-27OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情