创建规则触发条件

功能介绍

应用服务器可调用此接口在设施云平台创建一条规则触发条件。

URI

POST /v1/iotfm/routing-rules

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数说明：用户Token。通过调用生成Token 接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。
X-Instance-Id	是	String	参数说明：实例ID。通过访问智能设施云平台界面后获取，智能设施云平台资源均为实例级隔离，所有业务接口必须填写正确的实例ID才能被成功调用。取值范围：长度8-36，只允许大小写字母、数字和-字符的组合。

表2 请求Body参数
参数	是否必选	参数类型	描述
rule_name	否	String	参数说明：用户自定义的规则名称。
description	否	String	参数说明：用户自定义的规则描述。
subjects	否	Array of Subject objects	参数说明：资源事件信息列表。

表3 Subject
参数	是否必选	参数类型	描述
resource	是	String	资源名称。 device: 设备。 zone：空间。 product：产品。 device.property：设备属性。 device.status：设备状态。 device.alarm：设备告警。 ai.datahouse.model：AI模型。 device.event：设备事件
event	是	String	资源事件，取值范围：与资源有关，不同的资源，事件不同 event需要与resource关联使用，具体的“resource:event”映射关系如下： device:change（设备信息变更） zone:change（空间信息变更） product:change（产品信息变更） device.status:update （设备状态变更） device.property:report（设备属性上报） device.alarm:active（设备告警生成） device.alarm:recovery（设备告警恢复） ai.datahouse.model:predict（AI模型推理） device.event:report（设备事件上报）

响应参数

状态码：201

表4 响应Body参数
参数	参数类型	描述
rule_id	String	规则触发条件ID，用于唯一标识一个规则触发条件，在创建规则条件时由设施云平台分配获得。
rule_name	String	用户自定义的规则名称。
description	String	用户自定义的规则描述。
subjects	Array of Subject objects	资源事件信息列表。
active	Boolean	规则条件的状态是否为激活。

表5 Subject
参数	参数类型	描述
resource	String	资源名称。 device: 设备。 zone：空间。 product：产品。 device.property：设备属性。 device.status：设备状态。 device.alarm：设备告警。 ai.datahouse.model：AI模型。 device.event：设备事件
event	String	资源事件，取值范围：与资源有关，不同的资源，事件不同 event需要与resource关联使用，具体的“resource:event”映射关系如下： device:change（设备信息变更） zone:change（空间信息变更） product:change（产品信息变更） device.status:update （设备状态变更） device.property:report（设备属性上报） device.alarm:active（设备告警生成） device.alarm:recovery（设备告警恢复） ai.datahouse.model:predict（AI模型推理） device.event:report（设备事件上报）

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	参数说明：错误码。取值范围：长度8-36。
error_msg	String	参数说明：错误描述。取值范围：长度2-512。

请求示例

创建规则触发条件

POST https://{endpoint}/v1/iotfm/routing-rules

{
  "rule_name" : "rule_name",
  "subjects" : [ {
    "resource" : "device",
    "event" : "create"
  } ],
  "description" : "rule_description"
}

响应示例

状态码：201

Created

{
  "rule_id" : "5bcaddda-75bf-4623-8c8d-26175c41fcca",
  "rule_name" : "rule_name",
  "description" : "rule_description",
  "subjects" : [ {
    "resource" : "device",
    "event" : "change"
  } ],
  "active" : "false"
}