調(diào)用該接口分頁查詢所有規(guī)則列表。
QPS限制
單個阿里云賬號調(diào)用該接口的每秒請求數(shù)（QPS）最大限制為20。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListRule | 系統(tǒng)規(guī)定參數(shù)。取值：ListRule。 |
| CurrentPage | Integer | 是 | 1 | 顯示返回結果中的第幾頁。最大取值為1000，默認值為1。 |
| PageSize | Integer | 是 | 2 | 返回結果中每頁顯示的記錄數(shù)量。最大值為100，默認值為10。 |
| IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面，查看當前實例的ID。 重要
實例的更多信息，請參見實例概述。 |
| ResourceGroupId | String | 否 | rg-acfmxazb4ph**** | 資源組ID。 重要 目前，物聯(lián)網(wǎng)平臺僅支持實例維度的資源組管理。請求參數(shù)ResourceGroupId配置已無效，無需再傳入。
|
調(diào)用API時，除了本文介紹的該API的特有請求參數(shù)，還需傳入公共請求參數(shù)。公共請求參數(shù)說明，請參見公共參數(shù)文檔。
返回數(shù)據(jù)
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | iot.system.SystemException | 調(diào)用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。 |
| Data | Array of RuleInfo | 調(diào)用成功時，返回的規(guī)則信息列表。詳情參見RuleInfo信息。 說明 返回規(guī)則信息按照規(guī)則創(chuàng)建時間倒序排列。 |
|
| RuleInfo | |||
| CreateUserId | Long | 1231579085000000 | 創(chuàng)建該規(guī)則的用戶ID。 |
| Created | String | Wed Feb 27 20:45:43 CST 2019 | 該規(guī)則創(chuàng)建時的CST（Central Standard Time）時間。 |
| DataType | String | JSON | 該規(guī)則的數(shù)據(jù)類型，取值：JSON和BINARY。 |
| Id | Long | 151454 | 規(guī)則ID。 |
| Modified | String | Wed Feb 27 20:45:43 CST 2019 | 該規(guī)則最近一次被修改時的CST （Central Standard Time）時間。 |
| Name | String | test123 | 規(guī)則名稱。 |
| ProductKey | String | a1KiV****** | 應用該規(guī)則的產(chǎn)品Productkey。 |
| RuleDesc | String | rule1Desc | 規(guī)則的描述信息。 |
| Select | String | deviceName() as deviceName | 該規(guī)則SQL語句中的Select內(nèi)容。 |
| ShortTopic | String | +/thing/event/property/post | 應用該規(guī)則的具體Topic（不包含ProductKey類目），格式為： |
| Status | String | STOP | 該規(guī)則的運行狀態(tài)。取值：
|
| Topic | String | /a1T27vz****/+/thing/event/property/post | 應用該規(guī)則的具體Topic，格式為： |
| UtcCreated | String | 2019-02-27T12:40:43.000Z | 該規(guī)則創(chuàng)建時的UTC時間。 |
| UtcModified | String | 2019-02-27T12:45:43.000Z | 該規(guī)則最近一次被修改時的UTC時間。 |
| Where | String | Temperature>35 | 該規(guī)則SQL語句中的Where查詢條件。 |
| ErrorMessage | String | 系統(tǒng)異常 | 調(diào)用失敗時，返回的出錯信息。 |
| Page | Integer | 1 | 當前頁碼。 |
| PageSize | Integer | 2 | 每頁顯示的記錄數(shù)。 |
| RequestId | String | 1564B626-DE97-452D-9E9B-305888AC6105 | 阿里云為該請求生成的唯一標識符。 |
| Success | Boolean | true | 是否調(diào)用成功。
|
| Total | Integer | 25 | 總頁數(shù)。 |
示例
請求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=ListRule
&PageSize=2
&CurrentPage=1
&<公共請求參數(shù)>正常返回示例
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>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
}