设备接入 IoTDA设备接入 IoTDA

更新时间:2021/09/06 GMT+08:00
分享

查询AMQP列表

接口说明

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

调试

您可以在API Explorer中调试该接口。

URI

请求方法

GET

URI

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

传输协议

HTTPS

请求参数

名称

必选/可选

类型

位置

说明

X-Auth-Token

必选

String

Header

参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

可选

String

Header

参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。

project_id

必选

String

Path

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

queue_name

可选

String

Query

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

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

limit

可选

Integer

Query

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

取值范围:1-50的整数,默认值为10。

marker

可选

String

Query

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

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

offset

可选

Integer

Query

参数说明:表示从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。

响应参数

名称

类型

说明

queues

List<QueryQueueBase>

队列信息列表。

page

Page Object

查询结果的分页信息。

表1 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。

表2 Page

名称

类型

说明

count

Long

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

marker

String

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

请求示例

GET https://{Endpoint}/v5/iot/{project_id}/amqp-queues?queue_name={queue_name}&limit={limit}&marker={marker}&offset={offset}
Content-Type: application/json
X-Auth-Token: ********
Instance-Id: ********

响应示例

Status Code: 200 OK

Content-Type: application/json

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

错误码

HTTP状态码

错误码

错误码英文描述

错误码中文描述

处理建议

400

IOTDA.016000

Invalid input, Repeated queue name in the same spUserName.

队列名称在该用户下已存在

请更换队列名称后重试。

分享:

    相关文档

    相关产品