文档首页/ IoT物联网/ API参考/ 应用侧API参考（联通用户专用）/ 数据转发规则/ 创建数据转发规则

更新时间：2023-04-13 GMT+08:00

创建数据转发规则

接口说明

应用服务器可调用此接口在物联网平台创建一条规则，当指定设备上报的数据满足条件时，触发规则。

调试

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

URI

请求方法	POST
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。
name	必选	String(1-128)	Body	规则名称。
description	可选	String(256)	Body	规则的描述信息。
condition_group	必选	ConditionGroup	Body	规则的条件组，包含简单规则和复杂规则集合。
actions	必选	List<RuleAction>	Body	规则的动作列表，单个规则最多支持设置10个动作。
rule_type	必选	String	Body	规则的类型 DATA_FORWARDING：数据转发。 EDGE：边缘侧。
status	可选	String	Body	规则的状态，默认值：active。 active：激活。 inactive：未激活。
app_id	可选	String	Body	资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的规则归属到哪个资源空间下，否则创建的规则将会归属到默认资源空间下。
edge_node_ids	可选	List<String>	Body	归属边缘侧节点设备ID列表。

表1 ConditionGroup
名称	必选/可选	类型	说明
conditions	可选	List<RuleCondition>	规则的条件列表，单个规则最多支持设置10个条件。
logic	可选	String	规则条件列表中多个条件之间的逻辑关系，默认值：and。 and：逻辑且。 or：逻辑或。
time_range	可选	TimeRange	规则条件触发的有效时间段。

表2 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时，为必选参数

表3 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>	数据过滤条件

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

表5 DeviceMessageCondition
名称	必选/可选	类型	说明
product_id	可选	String(128)	设备关联的产品ID，用于唯一标识一个产品模型，在管理门户导入产品模型后由平台分配获得。
topic	可选	String(64)	产品关联的topic信息，用于过滤消息中指定topic消息。

表6 DeviceStatusCondition
名称	必选/可选	类型	说明
status_list	可选	List<String>	状态列表，设备状态条件携带该参数。

表7 TimeRange
名称	必选/可选	类型	说明
start_time	必选	String	规则条件触发的开始时间，格式：HH:mm。
end_time	必选	String	规则条件触发的结束时间，格式：HH:mm。若结束时间与开始时间一致，则时间为全天。
days_of_week	可选	String	星期列表，以逗号分隔。1代表周日，2代表周一，依次类推，默认为每天。星期列表中的日期为开始时间的日期。

表8 RuleAction
名称	必选/可选	类型	说明
type	必选	String	规则动作的类型，取值范围： DIS_FORWARDING：消息转发到DIS服务。 OBS_FORWARDING：消息转发到OBS服务。 ROMA_FORWARDING：消息转发到ROMA Connect服务。 IoTA_FORWARDING：消息转发到IoTA服务。 KAFKA_FORWARDING：消息转发到kafka服务。
addition	可选	List<String>	附加信息，在默认规则执行结果中附加额外内容，仅设备属性和消息类型数据转发规则支持使用，取值范围：PRODUCT_ID
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时，必填。

表9 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服务查询通道详情接口获取。

**表10** ActionObsForwarding
名称	必选/可选	类型	说明
region_name	必选	String(256)	OBS服务对应的region区域
project_id	必选	String(256)	OBS服务对应的projectId信息
bucket_name	必选	String(256)	OBS服务对应的桶名称
location	可选	String(256)	OBS服务对应桶的区域

**表11** ActionRomaForwarding
名称	必选/可选	类型	说明
region_name	必选	String(256)	ROMA Connect服务对应的region区域
project_id	必选	String(256)	ROMA Connect服务对应的projectId信息
roma_push_type	可选	String(256)	ROMA Connect服务对应的推送类型

**表12** ActionIoTAForwarding
名称	必选/可选	类型	说明
region_name	必选	String(256)	IoTA服务对应的region区域
project_id	必选	String(256)	IoTA服务对应的projectId信息

**表13** 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模式。需要填写对应的用户名密码信息。

**表14** NetAddress
名称	必选/可选	类型	说明
ip	可选	String	服务的对应IP
port	可选	Integer(<=65535)	服务对应端口
domain	可选	String	服务对应的域名

响应参数

名称	类型	说明
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'。

**表15** ConditionGroup
名称	类型	说明
conditions	List<RuleCondition>	规则的条件列表，单个规则最多支持设置10个条件。
logic	String	规则条件列表中多个条件之间的逻辑关系，默认值：and。 and：逻辑且。 or：逻辑或。
time_range	TimeRange	规则条件触发的有效时间段。

**表16** 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时，为必选参数

**表17** 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>	数据过滤条件

**表18** 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。

**表19** DeviceMessageCondition
名称	类型	说明
product_id	String(128)	设备关联的产品ID，用于唯一标识一个产品模型，在管理门户导入产品模型后由平台分配获得。
topic	String(64)	产品关联的topic信息，用于过滤消息中指定topic消息。

**表20** DeviceStatusCondition
名称	类型	说明
status_list	List<String>	状态列表，设备状态条件携带该参数。

**表21** TimeRange
名称	类型	说明
start_time	String	规则条件触发的开始时间，格式：HH:mm。
end_time	String	规则条件触发的结束时间，格式：HH:mm。若结束时间与开始时间一致，则时间为全天。
days_of_week	String	星期列表，以逗号分隔。1代表周日，2代表周一，依次类推，默认为每天。星期列表中的日期为开始时间的日期。

**表22** RuleAction
名称	类型	说明
type	String	规则动作的类型，取值范围： DIS_FORWARDING：消息转发到DIS服务。 OBS_FORWARDING：消息转发到OBS服务。 ROMA_FORWARDING：消息转发到ROMA Connect服务。 IoTA_FORWARDING：消息转发到IoTA服务。 KAFKA_FORWARDING：消息转发到kafka服务。
addition	List<String>	附加信息，在默认规则执行结果中附加额外内容，仅设备属性和消息类型数据转发规则支持使用，取值范围：PRODUCT_ID
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时，必填。

**表23** 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服务查询通道详情接口获取。

**表24** ActionObsForwarding
名称	类型	说明
region_name	String(256)	OBS服务对应的region区域
project_id	String(256)	OBS服务对应的projectId信息
bucket_name	String(256)	OBS服务对应的桶名称
location	String(256)	OBS服务对应桶的区域

**表25** ActionRomaForwarding
名称	类型	说明
region_name	String(256)	ROMA Connect服务对应的region区域
project_id	String(256)	ROMA Connect服务对应的projectId信息
roma_push_type	String(256)	ROMA Connect服务对应的推送类型

**表26** ActionIoTAForwarding
名称	类型	说明
region_name	String(256)	IoTA服务对应的region区域
project_id	String(256)	IoTA服务对应的projectId信息

**表27** 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模式。需要填写对应的用户名密码信息。

**表28** NetAddress
名称	类型	说明
ip	String	服务的对应IP
port	Integer(<=65535)	服务对应端口
domain	String	服务对应的域名

请求示例

POST https://{Endpoint}/v5/iot/{project_id}/rules
Content-Type: application/json
X-Auth-Token: ********
Instance-Id: ********
{
  "name" : "string",
  "description" : "string",
  "condition_group" : {
    "time_range" : {
      "days_of_week" : "string",
      "start_time" : "string",
      "end_time" : "string"
    },
    "logic" : "string",
    "conditions" : [ {
      "device_status_condition" : {
        "status_list" : [ "string" ]
      },
      "device_property_condition" : {
        "device_id" : "string",
        "product_id" : "string",
        "filters" : [ {
          "path" : "string",
          "value" : "string",
          "operator" : "string"
        } ]
      },
      "type" : "string",
      "device_message_condition" : {
        "product_id" : "string",
        "topic" : "string"
      }
    } ]
  },
  "actions" : [ {
    "iota_forwarding" : {
      "project_id" : "string",
      "region_name" : "string"
    },
    "roma_forwarding" : {
      "project_id" : "string",
      "region_name" : "string",
      "roma_push_type" : "string"
    },
    "kafka_forwarding" : {
      "kafka_mechanism" : "string",
      "project_id" : "string",
      "kafka_addresses" : [ {
        "port" : 0,
        "ip" : "string",
        "domain" : "string"
      } ],
      "kafka_username" : "string",
      "region_name" : "string",
      "kafka_topic" : "string",
      "kafka_password" : "string"
    },
    "obs_forwarding" : {
      "project_id" : "string",
      "bucket_name" : "string",
      "region_name" : "string",
      "location" : "string"
    },
    "type" : "string",
    "dis_forwarding" : {
      "stream_name" : "string",
      "project_id" : "string",
      "stream_id" : "string",
      "region_name" : "string"
    },
    "addition" : [ "string" ]
  } ],
  "rule_type" : "string",
  "status" : "string",
  "app_id" : "string",
  "edge_node_ids" : [ "string" ]
}

响应示例

Status Code: 201 Created

Content-Type: application/json
{
  "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.001001	Invalid input for this application.	应用参数不合法	请排查请求参数是否符合华为云文档要求。
	IOTDA.010000	Invalid input for this rule.	规则参数不合法	请排查请求参数是否符合华为云文档要求。
	IOTDA.010004	Invalid parameter in the rule condition.	规则条件不合法	请排查请求参数是否符合华为云文档要求
	IOTDA.010005	Invalid parameter in the rule action.	规则动作参数不合法	请排查请求中action参数是否符合华为云文档要求。
	IOTDA.010006	Repeated condition ID in the same rule.	规则条件ID重复	请重新命名规则条件ID后重试。
	IOTDA.010007	Repeated action ID in the same rule.	规则动作ID重复	请重新命名规则动作ID后重试。
	IOTDA.010008	The device with this condition does not exist.	规则条件中对应的设备不存在	请检查请求参数是否正确或设备在平台是否已经存在。
	IOTDA.010009	The device with this action does not exist.	规则动作中对应的设备不存在	请检查请求参数是否正确或设备在平台是否已经存在。
	IOTDA.010010	The device data with this condition does not exist.	规则条件中对应的设备信息不存在	请检查请求参数是否正确或设备在平台是否已经存在。
	IOTDA.010011	The device data with this action does not exist.	规则动作中对应的设备信息不存在	请检查请求参数是否正确或设备在平台是否已经存在。
	IOTDA.010012	The tag with this condition does not exist.	规则条件中对应的标签不存在	请检查请求参数是否正确或标签在平台是否已经存在
	IOTDA.010013	Invalid rule parameter.	规则参数不合法	请排查请求参数是否符合华为云文档要求
	IOTDA.010015	The rule count of each user has reached the upper limit, the current up limit is 10 entries.	用户下规则数量超过上限	请删除多余的规则后再注册。
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.	应用与用户信息不匹配	请排查该用户下是否有指定的应用。
	IOTDA.010003	The number of rules has reached the upper limit.	规则数量已达到上限	请删除多余的规则后重试。
404	IOTDA.010002	The rule does not exist.	该规则不存在	请确认平台是否存在该规则或请求参数是否正确。
500	IOTDA.000007	The data in database is abnormal.	数据库中的数据不正常	请联系华为工程师分析解决。
500	IOTDA.000020	Decrypt IAM token failed.	IAM Token解析失败	请联系华为工程师分析解决。

父主题： 数据转发规则

上一篇：查询规则列表

下一篇：查询规则

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建数据转发规则

接口说明

调试

URI

请求参数

响应参数

请求示例

响应示例

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线