调用该接口查询指定规则下已添加操作对应的数据目的列表。

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:存储到表格存储。
  • 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
}