CreateRule_物联网平台_API文档-阿里云OpenAPI开发者门户

接口说明

使用说明

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

QPS 限制

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

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

流控信息

请求速率为500/1(s)。更多流控信息，请前往配额中心查看

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称	字段详情
IotInstanceIdstring	实例 ID。您可在物联网平台控制台的实例概览页面，查看当前实例的 ID。展开详情示例值:iot-cn-0pp1n8t****
Selectstring	要执行的 SQL SELECT 语句。具体内容参照 SQL 表达式。展开详情示例值:deviceName() as deviceName, items.Humidity.value as Humidity, items.Temperature.value as Temperature
ShortTopicstring	应用该规则的具体 Topic，格式一般为：`${deviceName}/topicShortName`。其中，`${deviceName}`是具体设备的名称，`topicShortName`是 Topic 短名称。展开详情示例值:+/thing/event/property/post
Wherestring	规则的触发条件。具体内容参照 SQL 表达式。展开详情示例值:Temperature>35
ProductKeystring	应用该规则的产品 ProductKey。示例值:a1T27vz****参考取值来源: CreateProduct QueryProductList ReleaseProduct ListProductByTags BindLicenseProduct BatchBindProductsIntoProject
Namestring	规则名称。支持中文、英文字母、日文、数字、下划线（_）和短划线（-），长度为 1~30 个字符，一个中文或日文占 2 个字符。示例值:iot_test1
RuleDescstring	规则的描述信息。长度限制为 100 个字符，一个中文字符计为 1 个字符。示例值:rule test参考取值来源: GetRule ListRule QuerySceneRule
DataTypestring	规则处理的数据格式，需与待处理的设备数据格式一致。取值：展开详情示例值:JSON
TopicTypeinteger<int32>	0：ShortTopic 参数描述中的基础通信 Topic 或物模型通信 Topic，包含 OTA 升级批次状态通知 Topic。展开详情示例值:1
ResourceGroupIdstring	资源组 ID。展开详情示例值:rg-acfmxazb4ph****
Topicstring	待添加规则的完整 Topic。展开详情示例值:/sys/g18l***/device1/thing/event/property/post参考取值来源: SubscribeTopic UnsubscribeTopic QueryProductTopic CreateProductTopic

请求说明

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

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

返回参数

字段名称	字段详情
Codestring	调用失败时，返回的错误码。更多信息，请参见错误码。示例值:iot.system.SystemException
ErrorMessagestring	调用失败时，返回的出错信息。示例值:系统异常
RequestIdstring	阿里云为该请求生成的唯一标识符。示例值:E4C0FF92-2A86-41DB-92D3-73B60310D25E
Successboolean	是否调用成功。展开详情示例值:true
RuleIdinteger<int64>	调用成功时，规则引擎为该规则生成的规则 ID，作为该规则的标识符。展开详情注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:100000

返回示例

变更历史

暂无变更历史