调用该接口对指定Topic新建一个规则。

限制说明

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

说明 子账号共享主账号配额。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateRule

系统规定参数。取值:CreateRule。

Name String iot_test1

规则名称。支持使用中英文字符、数字、下划线(_)和连接号(-),长度为1~30个字符,一个中文字符计为2个字符。

IotInstanceId String iot_instc_pu****_c*-v64********

公共实例不传此参数;您购买的实例需传入实例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/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:二进制数据。
说明 若选择为BINARYTopicType不能选择为0(基础通信Topic或物模型通信Topic),且不能将数据转发至表格存储、时序时空数据库和云数据库RDS版。

如果不传入该参数,则默认使用JSON格式。

TopicType Integer 1
  • 0ShortTopic参数描述中的基础通信Topic或物模型通信Topic,包含OTA升级批次状态通知Topic。
  • 1:自定义Topic。
  • 2:设备状态变化通知Topic:/as/mqtt/status/${productKey}/${deviceName}
ResourceGroupId String rg-acfmxazb4ph****

传入资源组ID(可在资源管理控制台查看资源组信息),将该规则划归为某个资源组。

若不传入此参数,该规则将被划归为默认资源组。

调用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
&ResourceGroupId=rg-acfmxazb4ph****
&<公共请求参数>

正常返回示例

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
}