調用該接口查詢指定規則下已添加操作對應的數據目的列表。

QPS限制

單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為50。

說明 RAM用戶共享阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String ListRuleActions

系統規定參數。取值:ListRuleActions。

RuleId Long 10000

要查詢的規則ID。

您可調用ListRule接口從返回結果中查看Id

IotInstanceId String iot_instc_pu****_c*-v64********

實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID

重要
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無實例概覽頁面或ID值,則無需傳入。

實例的更多信息,請參見實例概述

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

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼

ErrorMessage String 系統異常

調用失敗時,返回的出錯信息。

RequestId String 22254BDB-3DC1-4643-8D1B-EE0437EF09A9

阿里云為該請求生成的唯一標識符。

RuleActionList Array of RuleActionInfo

調用成功后,返回規則下所有數據目的列表。詳細信息,請參見以下RuleActionInfo所包含的參數。

RuleActionInfo
Configuration String {\"endPoint\":\"http://ShanghaiRegion.cn-shanghai.ots.aliyuncs.com\",\"instanceName\":\"ShanghaiRegion\",\"primaryKeys\":[{\"columnName\":\"temperature\",\"columnType\":\"INTEGER\",\"columnValue\":\"${deviceName}\"}],\"regionName\":\"cn-shanghai\",\"role\":{\"roleArn\":\"acs:ram::1231579085******:role/aliyuniotaccessingotsrole\",\"roleName\":\"AliyunIOTAccessingOTSRole\"},\"tableName\":\"iottest\",\"uid\":\"1231579085******\"}

數據目的對應的配置信息。

ErrorActionFlag Boolean false

該數據目的配置是否為轉發錯誤操作數據,即轉發流轉到其他云產品失敗且重試失敗的數據。

  • true:是轉發錯誤操作數據。
  • false:不是轉發錯誤操作數據,而是正常轉發操作。
Id Long 139099

數據目的對應的操作ID。

RuleId Long 10000

數據目的對應的規則ID。

Status String NORMAL

數據目的對應的狀態。返回值:

  • INIT:初始配置中。
  • NORMAL:配置完成,正常可用。
  • INVALID:配置存在異常,不可用。
  • SHORTCUT:云產品流轉服務發生異常,導致流轉熔斷。
Type String OTS

數據目的對應的操作類型。返回值:

  • REPUBLISH:轉發到另一個topic。
  • OTS:存儲到表格存儲。
  • MNS:發送消息到消息服務。
  • ONS:發送數據到消息隊列RocketMQ。
  • TSDB:存儲到時序數據庫。
  • FC:發送數據到函數計算。

  • DATAHUB:發送數據到DataHub中。
  • RDS:存儲數據到云數據庫中。
  • AMQP:數據流轉到AMQP消費組。
Success Boolean true

是否調用成功。

  • true:表示調用成功。
  • false:表示調用失敗。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=ListRuleActions
&RuleId=10000
&<公共請求參數>

正常返回示例

XML格式

<ListRuleActionsResponse>
  <RuleActionList>
        <RuleActionInfo>
              <Type>OTS</Type>
              <RuleId>10000</RuleId>
              <Id>139099</Id>
              <Status>NORMAL</Status>
              <Configuration>{"endPoint":"http://ShanghaiRegion.cn-shanghai.ots.aliyuncs.com","instanceName":"ShanghaiRegion","primaryKeys":[{"columnName":"temperature","columnType":"INTEGER","columnValue":"${deviceName}"}],"regionName":"cn-shanghai","role":{"roleArn":"acs:ram::1231579085******:role/aliyuniotaccessingotsrole","roleName":"AliyunIOTAccessingOTSRole"},"tableName":"iottest","uid":"1231579085******"}</Configuration>
              <ErrorActionFlag>false</ErrorActionFlag>
        </RuleActionInfo>
        <RuleActionInfo>
              <Type>REPUBLISH</Type>
              <RuleId>152323</RuleId>
              <Id>142401</Id>
              <Status>NORMAL</Status>
              <Configuration>{"topic":"/sys/a1zSA28H***/device/thing/service/property/set","topicType":0,"uid":"1231579085******"}</Configuration>
              <ErrorActionFlag>false</ErrorActionFlag>
        </RuleActionInfo>
  </RuleActionList>
  <RequestId>22254BDB-3DC1-4643-8D1B-EE0437EF09A9</RequestId>
  <Success>true</Success>
</ListRuleActionsResponse>

JSON格式

{
  "RuleActionList": {
    "RuleActionInfo": [
      {
        "Type": "OTS", 
        "RuleId": 10000, 
        "Id": 139099, 
        "Status":"NORMAL",
        "Configuration": "{\"endPoint\":\"http://ShanghaiRegion.cn-shanghai.ots.aliyuncs.com\",\"instanceName\":\"ShanghaiRegion\",\"primaryKeys\":[{\"columnName\":\"temperature\",\"columnType\":\"INTEGER\",\"columnValue\":\"${deviceName}\"}],\"regionName\":\"cn-shanghai\",\"role\":{\"roleArn\":\"acs:ram::1231579085******:role/aliyuniotaccessingotsrole\",\"roleName\":\"AliyunIOTAccessingOTSRole\"},\"tableName\":\"iottest\",\"uid\":\"1231579085******\"}", 
        "ErrorActionFlag": false
      }, 
      {
        "Type": "REPUBLISH", 
        "RuleId": 152323, 
        "Id": 142401, 
        "Status": "NORMAL",
        "Configuration": "{\"topic\":\"/sys/a1zSA28H***/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579085******\"}", 
        "ErrorActionFlag": false
      }
    ]
  }, 
  "RequestId": "22254BDB-3DC1-4643-8D1B-EE0437EF09A9", 
  "Success": true
}