GetRule - IoT Platform

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為50。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	GetRule	系統規定參數。取值：GetRule。
RuleId	Long	是	100000	要查詢的規則ID。可在物聯網平台控制台規則引擎>雲產品流轉頁查看規則ID，或調用ListRule從返回結果中查看。
IotInstanceId	String	否	iot-cn-0pp1n8t****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	58D4CEC0-3E95-4DBE-AFC1-809D1400E52F	阿里雲為該請求產生的唯一識別碼。
RuleInfo	Struct		調用成功時，返回的規則詳細資料。詳情參見以下RuleInfo。
CreateUserId	Long	100000000000000	建立該規則的使用者ID。
Created	String	Thu Feb 28 14:14:33 CST 2019	該規則建立時的CST時間。
DataType	String	JSON	該規則的資料類型，取值：JSON或BINARY。
Id	Long	100000	規則ID。
Modified	String	Thu Feb 28 14:20:58 CST 2019	該規則最近一次被修改時的CST時間。
Name	String	iotrules	規則名稱。
ProductKey	String	a1KiV******	應用該規則的產品ProductKey。
RuleDesc	String	rule1Desc	規則的描述資訊。
Select	String	deviceName() as deviceName	該規則SQL語句中的Select內容。
ShortTopic	String	+/user/pm25data	該規則所處理訊息來源的具體Topic（不包含ProductKey類目），格式為：`${deviceName}/topicShortName`。其中，${deviceName}是具體裝置的名稱，topicShortName是Topic餘下部分。說明若Topic包含萬用字元`+`或`#`，請參見Topic萬用字元說明。
Status	String	STOP	該規則的運行狀態。取值： RUNNING：運行中 STOP：停止
Topic	String	/a1QsMlL44pp/+/user/pm25data	該規則所處理訊息來源的完整Topic，格式為：`${productKey}/${deviceName}/topicShortName`。說明若Topic包含萬用字元`+`或`#`，請參見Topic萬用字元說明。
TopicType	Integer	1	若您設定了規則SQL語句，則返回： 0：表示基礎通訊Topic或物模型通訊Topic。 1：表示自訂Topic。 2：表示裝置狀態Topic。若未設定過規則SQL語句，則返回-1。
UtcCreated	String	2019-02-28T06:14:33.000Z	規則建立時的UTC時間。
UtcModified	String	2019-02-28T06:20:58.000Z	規則最近一次更新時的UTC時間。
Where	String	Temperature>35	該規則SQL語句中的Where查詢條件。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=GetRule
&RuleId=100000
&<公用請求參數>

正常返回樣本

XML格式

<GetRuleResponse>
  <RequestId>85648524-E5EE-418E-BD16-FAFBB4FF3645</RequestId>
  <Success>true</Success>
  <RuleInfo>
        <DataType>JSON</DataType>
        <ShortTopic>+/user/pm25data</ShortTopic>
        <ProductKey>a1QsMl****</ProductKey>
        <UtcModified>2019-12-23T03:34:45.000Z</UtcModified>
        <CreateUserId>198426864326****</CreateUserId>
        <UtcCreated>2019-12-23T02:32:06.000Z</UtcCreated>
        <Name>Ruff_rule1</Name>
        <Status>RUNNING</Status>
        <Select>deviceName() as deviceName , timestamp('yyyy-MM-dd HH:mm:ss') as time, pm25, pm10</Select>
        <Created>Mon Dec 23 10:32:06 CST 2019</Created>
        <Modified>Mon Dec 23 11:34:45 CST 2019</Modified>
        <TopicType>1</TopicType>
        <Topic>/a1QsMlL****/+/user/pm25data</Topic>
        <Id>425367</Id>
  </RuleInfo>
</GetRuleResponse>

JSON格式

{
	"RequestId": "85648524-E5EE-418E-BD16-FAFBB4FF3645",
	"Success": true,
	"RuleInfo": {
		"DataType": "JSON",
		"ShortTopic": "+/user/pm25data",
		"ProductKey": "a1QsMl****",
		"UtcModified": "2019-12-23T03:34:45.000Z",
		"CreateUserId": "198426864326****",
		"UtcCreated": "2019-12-23T02:32:06.000Z",
		"Name": "Ruff_rule1",
		"Status": "RUNNING",
		"Select": "deviceName() as deviceName , timestamp('yyyy-MM-dd HH:mm:ss') as time, pm25, pm10",
		"Created": "Mon Dec 23 10:32:06 CST 2019",
		"Modified": "Mon Dec 23 11:34:45 CST 2019",
		"TopicType": 1,
		"Topic": "/a1QsMlL****/+/user/pm25data",
		"Id": 425367
	}
}

錯誤碼

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