全部產品
Search
文件中心

IoT Platform:ListRuleActions

更新時間:Feb 11, 2025

調用該介面查詢指定規則下已添加操作對應的資料目的列表。

QPS限制

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

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

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
Action String ListRuleActions

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

RuleId Long 10000

要查詢的規則ID。

您可在物聯網平台控制台對應執行個體下,進入規則引擎>雲產品流轉頁面查看規則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:儲存到Table Store。
  • MNS:發送訊息到Message Service。
  • ONS:發送資料到訊息佇列RocketMQ。
  • TSDB:儲存到時序資料庫。
  • FC:發送資料到Function Compute。

  • 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
}

錯誤碼

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