ListRule - IoT Platform

QPS限制

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

說明單個阿里雲帳號下的所有RAM使用者共用該阿里雲帳號的配額。

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ListRule	系統規定參數。取值：ListRule。
CurrentPage	Integer	是	1	顯示返回結果中的第幾頁。最大取值為1000，預設值為1。
PageSize	Integer	是	2	返回結果中每頁顯示的記錄數量。最大值為100，預設值為10。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
ResourceGroupId	String	否	rg-acfmxazb4ph****	資源群組ID。重要目前，物聯網平台僅支援執行個體維度資源群組管理。請求參數ResourceGroupId配置已無效，無需再傳入。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Array of RuleInfo		調用成功時，返回的規則資訊列表。詳情參見RuleInfo資訊。說明返回規則資訊按照規則建立時間倒序排列。
RuleInfo
CreateUserId	Long	1231579085000000	建立該規則的使用者ID。
Created	String	Wed Feb 27 20:45:43 CST 2019	該規則建立時的CST（Central Standard Time）時間。
DataType	String	JSON	該規則的資料類型，取值：JSON和BINARY。
Id	Long	151454	規則ID。
Modified	String	Wed Feb 27 20:45:43 CST 2019	該規則最近一次被修改時的CST （Central Standard Time）時間。
Name	String	test123	規則名稱。
ProductKey	String	a1KiV******	應用該規則的產品Productkey。
RuleDesc	String	rule1Desc	規則的描述資訊。
Select	String	deviceName() as deviceName	該規則SQL語句中的Select內容。
ShortTopic	String	+/thing/event/property/post	應用該規則的具體Topic（不包含ProductKey類目），格式為：`${deviceName}/topicShortName`。其中，${deviceName}是具體裝置的名稱，topicShortName是Topic餘下部分。說明若Topic包含萬用字元`+`或`#`，請參見Topic萬用字元說明。
Status	String	STOP	該規則的運行狀態。取值： RUNNING：運行中。 STOP：停止。
Topic	String	/a1T27vz****/+/thing/event/property/post	應用該規則的具體Topic，格式為：`${productKey}/${deviceName}/topicShortName`。說明若Topic包含萬用字元`+`或`#`，請參見Topic萬用字元說明。
UtcCreated	String	2019-02-27T12:40:43.000Z	該規則建立時的UTC時間。
UtcModified	String	2019-02-27T12:45:43.000Z	該規則最近一次被修改時的UTC時間。
Where	String	Temperature>35	該規則SQL語句中的Where查詢條件。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
Page	Integer	1	當前頁碼。
PageSize	Integer	2	每頁顯示的記錄數。
RequestId	String	1564B626-DE97-452D-9E9B-305888AC6105	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。
Total	Integer	25	總頁數。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=ListRule
&PageSize=2
&CurrentPage=1
&<公用請求參數>

正常返回樣本

XML格式

<ListRuleResponse>
  <Data>
        <RuleInfo>
              <DataType>JSON</DataType>
              <ProductKey>a1T27vz****</ProductKey>
              <CreateUserId>198426864326****</CreateUserId>
              <UtcModified>2020-02-26T06:38:27.000Z</UtcModified>
              <UtcCreated>2020-02-26T02:50:44.000Z</UtcCreated>
              <Where>Temperature&gt;35</Where>
              <Name>testrule2</Name>
              <Status>STOP</Status>
              <Select>deviceName() as DeviceName</Select>
              <Created>Wed Feb 26 10:50:44 CST 2020</Created>
              <Modified>Wed Feb 26 14:38:27 CST 2020</Modified>
              <Topic>/a1T27vz****/+/thing/event/property/post</Topic>
              <Id>497350</Id>
        </RuleInfo>
  </Data>
  <Page>1</Page>
  <PageSize>1</PageSize>
  <RequestId>1A6131EC-7504-4673-B997-DEFC6B363A37</RequestId>
  <Success>true</Success>
  <Total>5</Total>
</ListRuleResponse>

JSON格式

{
	"Data": {
		"RuleInfo": [
			{
				"DataType": "JSON",
				"ProductKey": "a1T27vz****",
				"CreateUserId": "198426864326****",
				"UtcModified": "2020-02-26T06:38:27.000Z",
				"UtcCreated": "2020-02-26T02:50:44.000Z",
				"Where": "Temperature>35",
				"Name": "testrule2",
				"Status": "STOP",
				"Select": "deviceName() as DeviceName",
				"Created": "Wed Feb 26 10:50:44 CST 2020",
				"Modified": "Wed Feb 26 14:38:27 CST 2020",
				"Topic": "/a1T27vz****/+/thing/event/property/post",
				"Id": 497350
			}
		]
	},
	"Page": 1,
	"PageSize": 1,
	"RequestId": "1A6131EC-7504-4673-B997-DEFC6B363A37",
	"Success": true,
	"Total": 5
}

錯誤碼

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