设备接入 IoTDA设备接入 IoTDA

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

查询规则列表

接口说明

应用服务器可调用此接口查询物联网平台中设置的规则列表。

调试

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

URI

请求方法

GET

URI

/v5/iot/{project_id}/rules

传输协议

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

app_id

可选

String

Query

资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,可以携带该参数查询指定资源空间下的规则列表,不携带该参数则会查询该用户下所有规则列表。

limit

可选

Integer[1,50]

Query

分页查询时每页显示的记录数,查询结果根据limit进行分页,默认值为10,取值范围为1-50的整数。

marker

可选

String

Query

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

offset

可选

Integer[0,500]

Query

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

响应参数

名称

类型

说明

marker

String

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

count

Long

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

rules

List<RuleResponse>

规则信息列表。

表1 RuleResponse

名称

类型

说明

rule_id

String(128)

规则id。

name

String(1-128)

规则名称。

description

String(256)

规则的描述信息。

condition_group

ConditionGroup

规则的条件组,包含简单规则和复杂规则集合。

actions

List<RuleAction>

规则的动作列表,单个规则最多支持设置10个动作。

rule_type

String

规则的类型

  • DATA_FORWARDING:数据转发。
  • EDGE:边缘侧。

status

String

规则的状态,默认值:active。

  • active:激活。
  • inactive:未激活。

app_id

String

资源空间ID,此参数为非必选参数。

edge_node_ids

List<String>

归属边缘侧节点设备ID列表。

last_update_time

String

规则最后更新时间,使用UTC时区,格式:yyyyMMdd'T'HHmmss'Z'。

表2 ConditionGroup

名称

类型

说明

conditions

List<RuleCondition>

规则的条件列表,单个规则最多支持设置10个条件。

logic

String

规则条件列表中多个条件之间的逻辑关系,默认值:and。

  • and:逻辑且。
  • or:逻辑或。

time_range

TimeRange

规则条件触发的有效时间段。

表3 RuleCondition

名称

类型

说明

type

String

规则条件的类型,取值范围:

  • DEVICE_DATA:设备数据类型条件。
  • DEVICE_STATUS:设备状态类型条件。
  • DEVICE_LIFE_CYCLE:设备生命周期类型条件。
  • DEVICE_MESSAGE:设备消息条件。
  • MESSAGE_RESULTS:下行消息结果条件。

device_property_condition

DeviceDataCondition

条件中设备数据类型的信息,当type为DEVICE_DATA时,为必选参数

device_message_condition

DeviceMessageCondition

条件中设备消息类型的信息,当type为DEVICE_MESSAGE时,为必选参数

device_status_condition

DeviceStatusCondition

条件中设备状态类型的信息,当type为DEVICE_STATUS时,为必选参数

表4 DeviceDataCondition

名称

类型

说明

device_id

String

设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。当rule_type为DEVICE_LINKAGE时,该参数值和product_id不能同时为空。如果该参数和product_id同时存在时,以该参数值对应的设备进行条件过滤。

product_id

String(128)

设备关联的产品ID,用于唯一标识一个产品模型,在管理控制台导入产品模型后由平台分配获得。当rule_type为DEVICE_LINKAGE时,该参数值和device_id不能同时为空。如果该参数和device_id同时存在时,以device_id参数值对应的设备进行条件过滤。

filters

List<PropertyFilter>

数据过滤条件

表5 PropertyFilter

名称

类型

说明

path

String(128)

设备属性的路径信息,格式:service_id/DataProperty,例如门磁状态为“DoorWindow/status”。多个属性路径之间以逗号分隔。

operator

String

数据比较的操作符,当前支持的操作符有:>,<,>=,<=,=和between:表示数值区间,geo.circle.in:表示圆形区域范围内,geo.circle.out:表示圆形区域范围外。

value

String(64)

数据比较表达式的右值。与数据比较操作符between联用时,右值表示最小值和最大值,用逗号隔开,如“20,30”表示大于等于20小于30。

表6 DeviceMessageCondition

名称

类型

说明

product_id

String(128)

设备关联的产品ID,用于唯一标识一个产品模型,在管理门户导入产品模型后由平台分配获得。

topic

String(64)

产品关联的topic信息,用于过滤消息中指定topic消息。

表7 DeviceStatusCondition

名称

类型

说明

status_list

List<String>

状态列表,设备状态条件携带该参数。

表8 TimeRange

名称

类型

说明

start_time

String

规则条件触发的开始时间,格式:HH:mm。

end_time

String

规则条件触发的结束时间,格式:HH:mm。若结束时间与开始时间一致,则时间为全天。

days_of_week

String

星期列表,以逗号分隔。1代表周日,2代表周一,依次类推,默认为每天。星期列表中的日期为开始时间的日期。

表9 RuleAction

名称

类型

说明

type

String

规则动作的类型,取值范围:

  • DIS_FORWARDING:消息转发到DIS服务。
  • OBS_FORWARDING:消息转发到OBS服务。
  • ROMA_FORWARDING:消息转发到ROMA Connect服务。
  • IoTA_FORWARDING:消息转发到IoTA服务。
  • KAFKA_FORWARDING:消息转发到kafka服务。

dis_forwarding

ActionDisForwarding

转发到DIS服务的消息内容。当type为DIS_FORWARDING时,必填。

obs_forwarding

ActionObsForwarding

转发到OBS服务的消息内容。当type为OBS_FORWARDING时,必填。

roma_forwarding

ActionRomaForwarding

转发到ROMA Connect服务的消息内容。当type为ROMA_FORWARDING时,必填。

iota_forwarding

ActionIoTAForwarding

转发到IoTA服务的消息内容。当type为IoTA_FORWARDING时,必填。

kafka_forwarding

ActionKafkaForwarding

转发到Kafka服务的消息内容。当type为KAFKA_FORWARDING时,必填。

表10 ActionDisForwarding

名称

类型

说明

region_name

String(256)

DIS服务对应的region区域

project_id

String(256)

DIS服务对应的projectId信息

stream_name

String(256)

DIS服务对应的通道名称,和通道ID参数中至少一个不为空,和通道ID参数都存在时,以通道ID参数值为准。通过调用DIS服务 查询通道列表接口获取。

stream_id

String(256)

DIS服务对应的通道ID,和通道名称参数中至少一个不为空,和通道名称参数都存在时,以本参数值为准。通过调用DIS服务 查询通道详情接口获取。

表11 ActionObsForwarding

名称

类型

说明

region_name

String(256)

OBS服务对应的region区域

project_id

String(256)

OBS服务对应的projectId信息

bucket_name

String(256)

OBS服务对应的桶名称

location

String(256)

OBS服务对应桶的区域

表12 ActionRomaForwarding

名称

类型

说明

region_name

String(256)

ROMA Connect服务对应的region区域

project_id

String(256)

ROMA Connect服务对应的projectId信息

roma_push_type

String(256)

ROMA Connect服务对应的推送类型

表13 ActionIoTAForwarding

名称

类型

说明

region_name

String(256)

IoTA服务对应的region区域

project_id

String(256)

IoTA服务对应的projectId信息

表14 ActionKafkaForwarding

名称

类型

说明

region_name

String(256)

kafka服务对应的region区域

project_id

String(256)

kafka服务对应的projectId信息

kafka_addresses

List<NetAddress>

kafka服务对应的地址列表

kafka_topic

String(256)

kafka服务关联的topic信息。

kafka_username

String(256)

kafka服务关联的用户名信息。

kafka_password

String(256)

kafka服务关联的密码信息。

kafka_mechanism

String

kafka服务关联的鉴权机制。

类型说明:

PAAS:非SASL鉴权。

PLAIN:SASL/PLAIN模式。需要填写对应的用户名密码信息。

表15 NetAddress

名称

类型

说明

ip

String

服务的对应IP

port

Integer(<=65535)

服务对应端口

domain

String

服务对应的域名

请求示例

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

响应示例

Status Code: 200 OK

Content-Type: application/json

{
  "marker" : "string",
  "count" : 0,
  "rules" : [ {
    "rule_id" : "string",
    "name" : "string",
    "description" : "string",
    "condition_group" : {
      "conditions" : [ {
        "type" : "string",
        "device_property_condition" : {
          "device_id" : "string",
          "product_id" : "string",
          "filters" : [ {
            "path" : "string",
            "operator" : "string",
            "value" : "string"
          } ]
        },
        "device_message_condition" : {
          "product_id" : "string",
          "topic" : "string"
        },
        "device_status_condition" : {
          "status_list" : [ "string" ]
        }
      } ],
      "logic" : "string",
      "time_range" : {
        "start_time" : "string",
        "end_time" : "string",
        "days_of_week" : "string"
      }
    },
    "actions" : [ {
      "type" : "string",
      "addition" : [ "string" ],
      "dis_forwarding" : {
        "region_name" : "string",
        "project_id" : "string",
        "stream_name" : "string",
        "stream_id" : "string"
      },
      "obs_forwarding" : {
        "region_name" : "string",
        "project_id" : "string",
        "bucket_name" : "string",
        "location" : "string"
      },
      "roma_forwarding" : {
        "region_name" : "string",
        "project_id" : "string",
        "roma_push_type" : "string"
      },
      "iota_forwarding" : {
        "region_name" : "string",
        "project_id" : "string"
      },
      "kafka_forwarding" : {
        "region_name" : "string",
        "project_id" : "string",
        "kafka_addresses" : [ {
          "ip" : "string",
          "port" : 0,
          "domain" : "string"
        } ],
        "kafka_topic" : "string",
        "kafka_username" : "string",
        "kafka_password" : "string",
        "kafka_mechanism" : "string"
      }
    } ],
    "rule_type" : "string",
    "status" : "string",
    "app_id" : "string",
    "edge_node_id" : [ "string" ],
    "last_update_time" : "string"
  } ]
}

错误码

HTTP状态码

错误码

错误码英文描述

错误码中文描述

处理建议

400

IOTDA.000006

Invalid input data.

请求参数不合法

请排查请求参数是否符合华为云文档要求。

IOTDA.000013

Invalid input. The parameter 'pageSize' multiply 'pageNo' exceeds the upper limit.

查询范围查过最大限制。

请检查pageSize和pageNo参数的大小。

403

IOTDA.000004

Invalid access token.

非法token

请排查请求中的token是否正常。

IOTDA.000021

Operation not allowed. User not found by IAM token or the authorized user has not subscribed IOTDA service.

没有找到IAM Token所对应的用户信息或该用户没有订阅设备接入服务(IOTDA)

请排查IAM Token所在用户是否订阅了设备接入服务(IOTDA)。

IOTDA.001000

The application does not exist.

该应用不存在

请确定是否已在平台注册应用并检查应用ID是否正确。

IOTDA.001002

Operation not allowed. The application has not been authorized.

该应用没有权限访问

请检查该应用是否已被授权。

IOTDA.001005

Operation not allowed. The parameter 'app_id' is not carried, and the authorized user has more than one applications. Include the parameter 'app_id', or contact Huawei technical support engineers to merge application data.

该用户下有多个应用的情况下未携带appId访问接口

请携带对应的appId或联系华为工程师合并应用数据。

IOTDA.001006

Operation not allowed. Application not found by authorized user or the authorized user has no application.

用户下没有应用或应用与用户不匹配

请排查用户下是否有应用或是否有指定的应用。

IOTDA.001007

Operation not allowed. The application does not belong to the authorized user.

应用与用户信息不匹配

请排查该用户下是否有指定的应用。

404

IOTDA.010002

The rule does not exist.

该规则不存在

请确认平台是否存在该规则或请求参数是否正确。

500

IOTDA.000020

Decrypt IAM token failed.

IAM Token解析失败

请联系华为工程师分析解决。

分享:

    相关文档

    相关产品