设备接入 IOTDA-查询规则条件列表:URI

时间:2024-06-28 09:24:59

URI

GET /v5/iot/{project_id}/routing-rule/rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

resource

String

参数说明:订阅的资源名称。 取值范围

  • device:设备。

  • device.property:设备属性。

  • device.message:设备消息。

  • device.message.status:设备消息状态。

  • device.status:设备状态。

  • batchtask:批量任务。

  • product:产品。

  • device.command.status:设备异步命令状态。

最小长度:1

最大长度:50

event

String

参数说明:订阅的资源事件。 取值范围:与资源有关,不同的资源,事件不同。 event需要与resource关联使用,具体的“resource:event”映射关系如下:

  • device:create(设备添加)

  • device:delete(设备删除)

  • device:update(设备更新)

  • device.status:update (设备状态变更)

  • device.property:report(设备属性上报)

  • device.message:report(设备消息上报)

  • device.message.status:update(设备消息状态变更)

  • batchtask:update (批量任务状态变更)

  • product:create(产品添加)

  • product:delete(产品删除)

  • product:update(产品更新)

  • device.command.status:update(设备异步命令状态更新)。

最小长度:1

最大长度:50

app_type

String

参数说明:租户规则的生效范围。 取值范围

  • GLOBAL:生效范围为租户级。

  • APP:生效范围为资源空间级。如果类型为APP,可携带app_id查询指定资源空间下的规则动作列表,不携带app_id则查询默认资源空间下的规则列表。

app_id

String

参数说明:资源空间ID。此参数为非必选参数,携带app_id查询指定资源空间下的规则动作列表,不携带app_id则查询默认资源空间下的规则动作列表。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。

rule_name

String

参数说明:用户自定义的规则名称

最小长度:1

最大长度:256

active

Boolean

参数说明:规则条件的状态是否为激活。

limit

Integer

参数说明:分页查询时每页显示的记录数。默认每页10条记录,最大设定每页50条记录。 取值范围:1-50的整数,默认值为10。

最小值:1

最大值:50

缺省值:10

marker

String

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

缺省值: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。

最小值:0

最大值:500

缺省值:0

support.huaweicloud.com/api-iothub/iot_06_v5_01306.html