調(diào)用該接口查詢指定規(guī)則的詳細信息。
QPS限制
單個阿里云賬號調(diào)用該接口的每秒請求數(shù)（QPS）最大限制為50。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetRule | 系統(tǒng)規(guī)定參數(shù)。取值：GetRule。 |
| RuleId | Long | 是 | 100000 | 要查詢的規(guī)則ID。可在物聯(lián)網(wǎng)平臺控制臺對應(yīng)實例下，消息轉(zhuǎn)發(fā)>云產(chǎn)品流轉(zhuǎn)頁查看規(guī)則ID，或調(diào)用ListRule從返回結(jié)果中查看。 |
| IotInstanceId | String | 否 | iot-cn-0pp1n8t**** | 實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面，查看當(dāng)前實例的ID。 重要
實例的更多信息，請參見實例概述。 |
調(diào)用API時，除了本文介紹的該API的特有請求參數(shù)，還需傳入公共請求參數(shù)。公共請求參數(shù)說明，請參見公共參數(shù)文檔。
返回數(shù)據(jù)
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | iot.system.SystemException | 調(diào)用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。 |
| ErrorMessage | String | 系統(tǒng)異常 | 調(diào)用失敗時，返回的出錯信息。 |
| RequestId | String | 58D4CEC0-3E95-4DBE-AFC1-809D1400E52F | 阿里云為該請求生成的唯一標識符。 |
| RuleInfo | Struct | 調(diào)用成功時，返回的規(guī)則詳細信息。詳情參見以下RuleInfo。 |
|
| CreateUserId | Long | 100000000000000 | 創(chuàng)建該規(guī)則的用戶ID。 |
| Created | String | Thu Feb 28 14:14:33 CST 2019 | 該規(guī)則創(chuàng)建時的CST時間。 |
| DataType | String | JSON | 該規(guī)則的數(shù)據(jù)類型，取值：JSON或BINARY。 |
| Id | Long | 100000 | 規(guī)則ID。 |
| Modified | String | Thu Feb 28 14:20:58 CST 2019 | 該規(guī)則最近一次被修改時的CST時間。 |
| Name | String | iotrules | 規(guī)則名稱。 |
| ProductKey | String | a1KiV****** | 應(yīng)用該規(guī)則的產(chǎn)品ProductKey。 |
| RuleDesc | String | rule1Desc | 規(guī)則的描述信息。 |
| Select | String | deviceName() as deviceName | 該規(guī)則SQL語句中的Select內(nèi)容。 |
| ShortTopic | String | +/user/pm25data | 該規(guī)則所處理消息來源的具體Topic（不包含ProductKey類目），格式為： |
| Status | String | STOP | 該規(guī)則的運行狀態(tài)。取值：
|
| Topic | String | /a1QsMlL44pp/+/user/pm25data | 該規(guī)則所處理消息來源的完整Topic，格式為： |
| TopicType | Integer | 1 | 若您設(shè)置了規(guī)則SQL語句，則返回：
若未設(shè)置過規(guī)則SQL語句，則返回-1。 |
| UtcCreated | String | 2019-02-28T06:14:33.000Z | 規(guī)則創(chuàng)建時的UTC時間。 |
| UtcModified | String | 2019-02-28T06:20:58.000Z | 規(guī)則最近一次更新時的UTC時間。 |
| Where | String | Temperature>35 | 該規(guī)則SQL語句中的Where查詢條件。 |
| Success | Boolean | true | 是否調(diào)用成功。
|
示例
請求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=GetRule
&RuleId=100000
&<公共請求參數(shù)>正常返回示例
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
}
}