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

指定されたルールアクションの詳細情報を照会します。

制限

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

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

デバッグ

Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。 OpenAPI Explorer は署名の値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストパラメータ

パラメータ	タイプ	必須	例	説明
Action	String	Yes	GetRuleAction	実行する操作。値を GetRuleAction に設定します。
ActionId	Long	Yes	100001	照会するルールアクション ID。ルールアクション ID は、次の方法で照会できます。 CreateRuleAction 操作を呼び出し、レスポンスの ActionId パラメータを確認します。 ListRuleActions 操作を呼び出し、レスポンスの Id パラメータを確認します。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメータを設定する必要があります。このパラメータを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメータを設定する必要はありません。詳細については、「概要」をご参照ください。

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

レスポンスパラメータ

パラメータ	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	F2D0755D-F350-40FE-9A6D-491859DB5E5F	リクエストの ID。
RuleActionInfo	Struct		呼び出しが成功した場合に返されるルールアクション情報。詳細については、以下のパラメータを参照してください。
Configuration	String	{\"topic\":\"/sys/a1zSA28**/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579*****\"}	ルールアクションの構成。
ErrorActionFlag	Boolean	false	宛先クラウドサービスへの転送に失敗したエラー操作データをルールアクションが転送するかどうかを示します。データ転送の失敗は、転送の再試行も失敗したことを示します。 true: エラー操作データを転送します。 false: エラー操作データではなく、通常のデータを転送します。
Id	Long	100001	ルールアクションの ID。
RuleId	Long	152323	ルールアクションが実行されるルールの ID。
Type	String	REPUBLISH	ルールアクションのタイプ。有効な値： REPUBLISH: データを別の Topic に転送します。 OTS: データを Tablestore に保存します。 MNS: データを Message Service（MNS）に送信します。 FC: データを Function Compute に送信します。 RDS: クラウドデータベースに保存します。 AMQP: データを AMQP コンシューマーグループに転送します。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=GetRuleAction
&ActionId=1000001
&<共通リクエストパラメータ>

成功レスポンスの例

XML 形式

<GetRuleActionResponse>
      <RuleActionInfo>
            <Type>REPUBLISH</Type>
            <RuleId>152323</RuleId>
            <Id>100001</Id>
            <Configuration>
                  <topic>/sys/a1zSA28****/device/thing/service/property/set</topic>
                  <topicType>0</topicType>
                  <uid>1231579*******</uid>
            </Configuration>
            <ErrorActionFlag>false</ErrorActionFlag>
      </RuleActionInfo>
      <RequestId>F2D0755D-F350-40FE-9A6D-491859DB5E5F</RequestId>
      <Success>true</Success>
</GetRuleActionResponse>

JSON 形式

{
  "RuleActionInfo": {
    "Type": "REPUBLISH", 
    "RuleId": 152323, 
    "Id": 100001, 
    "Configuration": "{\"topic\":\"/sys/a1zSA28***/device/thing/service/property/set\",\"topicType\":0,\"uid\":\"1231579*******\"}", 
    "ErrorActionFlag": false
  }, 
  "RequestId": "F2D0755D-F350-40FE-9A6D-491859DB5E5F", 
  "Success": true
}

エラーコード

エラーコードの一覧については、API エラーセンターをご覧ください。