ListRuleActions - IoT Platform - Alibaba Cloud ドキュメントセンター

特定のルールのすべての構成済みデータ転送アクションをクエリします。ルールがトリガーされると、構成されたアクションに基づいて、データを異なる宛先に転送できます。

QPS 制限

各 Alibaba Cloud アカウントは、最大 50 クエリ/秒（QPS）を実行できます。

説明 Alibaba Cloud アカウントの Resource Access Management（RAM）ユーザーは、アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は、署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメータ

パラメータ	データ型	必須	例	説明
Action	String	Yes	ListRuleActions	実行する操作。値を ListRuleActions に設定します。
RuleId	Long	Yes	10000	ルールの ID。 IoT Platform コンソールにログインし、管理するインスタンスの詳細ページに移動します。インスタンスの詳細ページで、[ルールエンジン] > [データ転送] を選択して、ルール ID を取得します。または、ListRule 操作を呼び出して、レスポンスの [Id] パラメータの値を表示することもできます。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。IoT Platform コンソールの [概要] ページで、インスタンスの [ID] を表示できます。重要インスタンスに ID がある場合は、このパラメータに ID を指定する必要があります。指定しないと、呼び出しは失敗します。 IoT Platform コンソールに [概要] ページまたはインスタンス ID が表示されない場合は、このパラメータを構成する必要はありません。インスタンスの詳細については、「概要」をご参照ください。

上記の操作固有のリクエストパラメータに加えて、この操作を呼び出すときは、共通リクエストパラメータを指定する必要があります。共通リクエストパラメータの詳細については、「共通パラメータ」をご参照ください。

レスポンスパラメータ

パラメータ	データ型	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。エラーコードの詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	22254BDB-3DC1-4643-8D1B-EE0437EF09A9	リクエストの ID。
RuleActionList	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	データ宛先がエラー操作データの受信に使用されるかどうかを示します。エラー操作データとは、2 回連続して転送に失敗したデータです。 [true]: この宛先は、エラー操作データの受信に使用されます。 [false]: この宛先は、エラー操作データの受信に使用されません。
Id	Long	139099	データが宛先に転送されるアクションの ID。
RuleId	Long	10000	データが宛先に転送されるルールの ID。
Status	String	NORMAL	データ転送アクションのステータス。有効な値： [INIT]: アクションは構成中です。 [NORMAL]: 構成は完了しており、アクションは正常に実行できます。 [INVALID]: 構成データが無効であり、アクションは実行に失敗します。 [SHORTCUT]: 例外が発生し、データ転送アクションは停止されます。
Type	String	OTS	データが宛先に転送されるアクションのタイプ。有効な値： [REPUBLISH]: データは Topic に転送されます。 [OTS]: データは Tablestore に保存されます。 [MNS]: データは Message Service（MNS）に転送されます。 [ONS]: データは Message Queue for Apache RocketMQ に転送されます。 [TSDB]: データは時系列データベースに保存されます。 [FC]: データは Function Compute に転送されます。 [RDS]: データは ApsaraDB RDS に転送されます。 [AMQP]: データは Advanced Message Queuing Protocol（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
}

エラーコード

エラーコードのリストについては、「エラーセンター」をご参照ください。