文档首页/设备接入 IoTDA/API参考/应用侧API参考/API/AMQP队列管理/查询AMQP列表 - BatchShowQueue
更新时间：2025-12-02 GMT+08:00
查看PDF
分享

查询AMQP列表 - BatchShowQueue

功能介绍

应用服务器可调用此接口查询物联网平台中的AMQP队列信息列表。可通过队列名称作模糊查询，支持分页。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    iotda:amqpqueue:queryList

    List

    -

    g:EnterpriseProjectId

    -

    -

URI

GET /v5/iot/{project_id}/amqp-queues

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数说明：项目ID。获取方法请参见 获取项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

queue_name

否

String

参数说明：amqp队列名称，支持模糊查询，为空查询所有的队列（当前规格单个用户最大100个队列）。

取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）、间隔号（.）、冒号（:）的组合。

limit

否

Integer

参数说明：分页查询时每页显示的记录数。

取值范围：1-50的整数，默认值为10。

marker

否

String

参数说明：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。

取值范围：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。

offset

否

Integer

参数说明：表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。

取值范围：0-500的整数，默认为0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Instance-Id

否

String

参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

queues

Array of QueryQueueBase objects

队列信息列表。

page

Page object

查询结果的分页信息。

表5 QueryQueueBase

参数

参数类型

描述

queue_id

String

队列ID，用于唯一标识一个队列。

queue_name

String

队列名称，同一租户不允许重复。

create_time

String

在物联网平台创建队列的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。

last_modify_time

String

在物联网平台最后修改队列的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。

表6 Page

参数

参数类型

描述

count

Long

满足查询条件的记录总数。

marker

String

本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。

请求示例

列报查询所有的amqp队列。

GET https://{endpoint}/v5/iot/{project_id}/amqp-queues

响应示例

状态码：200

OK

{
  "queues" : [ {
    "queue_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
    "queue_name" : "myQueue0",
    "create_time" : "20190303T081011Z",
    "last_modify_time" : "20190303T081011Z"
  } ],
  "page" : {
    "count" : 10,
    "marker" : "5c90fa7d3c4e4405e8525079"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题：AMQP队列管理