CreateRule - IoT Platform

使用說明

調用該介面時，請求參數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），且不支援將資料轉寄至Table Store和雲資料庫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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。