CreateRule - 阿里云物联网平台

使用说明

调用该接口时，请求参数ProductKey必须传入。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。

说明单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateRule	系统规定参数。取值：CreateRule。
Name	String	是	iot_test1	规则名称。支持中文、英文字母、日文、数字、下划线（_）和短划线（-），长度为1~30个字符，一个中文或日文占2个字符。
IotInstanceId	String	否	iot-cn-0pp1n8t****	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。重要若有ID值，必须传入该ID值，否则调用会失败。若无实例概览页面或ID值，则无需传入。实例的更多信息，请参见实例概述。
Select	String	否	deviceName() as deviceName, items.Humidity.value as Humidity, items.Temperature.value as Temperature	要执行的SQL SELECT语句。具体内容参照SQL表达式。说明此处传入的是SELECT下的内容。例如，如果SELECT语句为`SELECT a,b,c`，则此处传入`a,b,c`。
ShortTopic	String	否	+/thing/event/property/post	应用该规则的具体Topic，格式一般为：`${deviceName}/topicShortName`。其中，`${deviceName}`是具体设备的名称，`topicShortName`是Topic短名称。基础通信Topic或物模型通信Topic的ShortTopic，格式一般为：`${deviceName}/topicShortName`。其中，`${deviceName}`可以使用通配符`+`代替，表示产品下所有设备名称。`topicShortName`取值如下： `/thing/event/property/post` 设备上报的属性消息。 `/thing/event/${tsl.event.identifier}/post`设备上报的事件消息，`${}`中是产品物模型中事件identifier。 `/thing/lifecycle` 设备生命周期变更消息。 `/thing/downlink/reply/message`设备响应云端指令的结果消息。 `/thing/list/found`网关上报发现子设备消息。 `/thing/topo/lifecycle`设备拓扑关系变更消息。 `/thing/event/property/history/post`设备历史属性上报消息。 `/thing/event/${tsl.event.identifier}/history/post`设备历史事件上报消息，`${}`中是产品物模型中事件identifier。 `/ota/upgrade`设备OTA升级状态通知消息。 `/ota/version/post`设备OTA模块版本号上报消息。 `/thing/deviceinfo/update`设备标签变更消息。 `/edge/driver/${driver_id}/point_post`物联网边缘计算的透传模式Topic消息，`${}`中是物联网边缘计算的设备接入驱动ID。 OTA升级批次状态通知Topic也属于基础通信Topic，ShortTopic格式为：`${packageId}/${jobId}/ota/job/status`。其中，`${packageId}`是升级包ID，`${jobId}`是升级批次ID。自定义Topic的ShortTopic，如：`${deviceName}/user/get`。调用QueryProductTopic接口，可以查看产品下的所有自定义Topic类。指定自定义Topic时，可以使用通配符`+`和`#`。 `${deviceName}`可以使用通配符`+`代替，表示产品下所有设备；之后字段可以用`/user/#`，`#`表示`/user`层级之后的所有层级名称。使用通配符，请参见Topic类中的通配符。设备状态变化通知Topic的ShortTopic：`${deviceName}`。可以直接使用通配符`+`，表示产品下所有设备的状态变化通知。
Where	String	否	Temperature>35	规则的触发条件。具体内容参照SQL表达式。说明此处传入的是Where中的内容。例如，如果Where语句为`Where a>10`，则此处传入`a>10`。
ProductKey	String	否	a1T27vz****	应用该规则的产品ProductKey。
RuleDesc	String	否	rule test	规则的描述信息。长度限制为100个字符，一个中文字符计为1个字符。
DataType	String	否	JSON	规则处理的数据格式，需与待处理的设备数据格式一致。取值： JSON（默认）：JSON数据。 BINARY：二进制数据。说明若选择为BINARY，TopicType不能选择为0（基础通信Topic或物模型通信Topic），且不支持将数据转发至表格存储和云数据库RDS版。
TopicType	Integer	否	1	0：ShortTopic参数描述中的基础通信Topic或物模型通信Topic，包含OTA升级批次状态通知Topic。 1：自定义Topic。 2：设备状态变化通知Topic：`/as/mqtt/status/${productKey}/${deviceName}`。
ResourceGroupId	String	否	rg-acfmxazb4ph****	资源组ID。重要目前，物联网平台仅支持实例维度的资源组管理。请求参数ResourceGroupId配置已无效，无需再传入。历史调用本API设置的资源组仍有效。
Topic	String	否	/sys/g18l***/device1/thing/event/property/post	待添加规则的完整Topic。如果传入此参数，无需再传入参数ShortTopic和TopicType。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

说明如需启动规则，请求中需包含ProductKey、ShortTopic、Select三个参数的信息。

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	阿里云为该请求生成的唯一标识符。
RuleId	Long	100000	调用成功时，规则引擎为该规则生成的规则ID，作为该规则的标识符。说明请妥善保管该信息。在调用和规则相关的接口时，您可能需要提供对应的规则ID。
Success	Boolean	true	是否调用成功。 true：调用成功。 false：调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateRule
&Name=iot_test1
&ProductKey=a1T27vz****
&ShortTopic=+/thing/event/property/post
&Select=deviceName() as deviceName, items.Humidity.value as Humidity, items.Temperature.value as Temperature
&RuleDesc=rule test
&DataType=JSON
&Where=Temperature>35
&TopicType=1
&<公共请求参数>

正常返回示例

XML格式

<CreateRuleResponse>
      <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
      <RuleId>100000</RuleId>
      <Success>true</Success>
</CreateRuleResponse>

JSON格式

{
  "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E", 
  "RuleId": 100000, 
  "Success": true
}

错误码

访问错误中心查看更多错误码。