すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::IOT::RuleAction

最終更新日:Jan 16, 2025

ALIYUN::IOT::RuleAction は、指定されたルールのアクションを作成するために使用されます。

構文

{
  "Type": "ALIYUN::IOT::RuleAction",
  "Properties": {
    "ErrorActionFlag": Boolean,
    "Type": String,
    "IotInstanceId": String,
    "Configuration": String,
    "RuleId": Integer
  }
}

プロパティ

プロパティタイプ必須編集可能説明制約
ErrorActionFlagBooleanいいえいいえルールアクションがエラー操作データを転送するかどうかを指定します。エラー操作データは、ルールエンジンがIoT Platform (IOT) トピックから宛先クラウドサービスにデータを転送できなかった場合に生成されます。データ転送の失敗は、転送の再試行も失敗したことを示します。デフォルト値: false。有効な値:
  • true: ルールアクションはエラー操作データを転送します。
  • false: ルールアクションはエラー操作データを転送しません。
TypeStringはいはいルールアクションのタイプ。ルールのデータ型がバイナリデータ形式であるか、DataType パラメーターが BINARY に設定されている場合、ルールは Tablestore (OTS) へのデータ転送をサポートしていません。有効な値:
  • REPUBLISH: ルールエンジンによって処理されたデータを IoT トピックに転送します。
  • AMQP: Advanced Message Queuing Protocol (AMQP) コンシューマーグループにデータを転送します。
  • DATAHUB: ルールエンジンによって処理されたデータをストリームコンピューティングのために DataHub に転送します。
  • ONS: ルールエンジンによって処理されたデータをメッセージ配信のために Message Queue for Apache RocketMQ に転送します。
  • MNS: ルールエンジンによって処理されたデータを Message Service (MNS) に転送します。
  • FC: ルールエンジンによって処理されたデータをイベントコンピューティングのために Function Compute に転送します。
  • OTS: ルールエンジンによって処理されたデータを NoSQL データストレージのために OTS に転送します。
IotInstanceIdStringいいえいいえインスタンスの ID。このパラメーターは、パブリックインスタンスとエンタープライズ版インスタンスに必要です。
ConfigurationStringはいはいルールアクションの構成。JSON 文字列を指定する必要があります。構成は、ルールアクションのタイプによって異なります。詳細については、「CreateRuleAction」をご参照ください。
RuleIdIntegerはいいいえアクションを作成するルールの ID。なし

レスポンスパラメーター

Fn::GetAtt

ActionId: アクションの ID。

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ErrorActionFlag": {
      "Type": "Boolean",
      "Description": "ルールアクションがエラー操作データを転送したかどうかを示します。エラー操作データは、ルールエンジンが IoT プラットフォームのトピックから宛先クラウドサービスにデータを転送できなかったことを示します。データ転送の失敗は、転送の再試行も失敗したことを示します。有効な値:\ntrue:エラー操作データを転送します。\nfalse:エラー操作データの代わりに通常のデータを転送します。\nデフォルト値:false。", // 翻訳済みのコメント
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "Type": {
      "Type": "String",
      "Description": "ルールアクションのタイプ。有効な値:\nMNS:ルールエンジンによって処理されたトピック内のデータを、メッセージ送信のために Message Service(MNS)に転送します。\nFC:ルールエンジンによって処理されたトピック内のデータを、イベントコンピューティングのために Function Compute に転送します。\nREPUBLISH:ルールエンジンによって処理されたトピック内のデータを別の IoT プラットフォームトピックに転送します。\nAMQP:AMQP コンシューマーグループにデータを転送します。\nOTS:ルールエンジンによって処理されたトピック内のデータを、NoSQL データストレージのために Table Store に転送します。\n注\nバイナリデータ形式のルール(DataType パラメーターが BINARY に設定されている)は、Table Store へのデータ転送をサポートしていません。\nルールエンジンでサポートされている宛先 Alibaba Cloud サービスは、リージョンによって異なります。ルールエンジンでサポートされているリージョンと宛先クラウドサービスの詳細については、「リージョンとゾーン」を参照してください。", // 翻訳済みのコメント
      "AllowedValues": [
        "AMQP",
        "DATAHUB",
        "FC",
        "MNS",
        "ONS",
        "OTS",
        "REPUBLISH"
      ]
    },
    "Configuration": {
      "Type": "String",
      "Description": "ルールアクションの構成。JSON 文字列を指定する必要があります。異なるタイプのルールアクションの構成は異なります。必要な構文と例の詳細については、以下の表を参照してください。" // 翻訳済みのコメント
    },
    "IotInstanceId": {
      "Type": "String",
      "Description": "インスタンスの ID。このパラメーターは、パブリックインスタンスには必要ありません。ただし、購入したインスタンスにはこのパラメーターが必要です。" // 翻訳済みのコメント
    },
    "RuleId": {
      "Type": "Number",
      "Description": "アクションを作成するルールの ID。ルール ID を表示するには、次のいずれかの方法を使用できます。1. IoT プラットフォームコンソールにログインし、ルール>データ転送を選択します。2. ListRule オペレーションを呼び出します。" // 翻訳済みのコメント
    }
  },
  "Resources": {
    "RuleAction": {
      "Type": "ALIYUN::IOT::RuleAction",
      "Properties": {
        "ErrorActionFlag": {
          "Ref": "ErrorActionFlag"
        },
        "Type": {
          "Ref": "Type"
        },
        "Configuration": {
          "Ref": "Configuration"
        },
        "IotInstanceId": {
          "Ref": "IotInstanceId"
        },
        "RuleId": {
          "Ref": "RuleId"
        }
      }
    }
  },
  "Outputs": {
    "ActionId": {
      "Description": "ルールアクションの ID。", // 翻訳済みのコメント
      "Value": {
        "Fn::GetAtt": [
          "RuleAction",
          "ActionId"
        ]
      }
    }
  }
}

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
 ErrorActionFlag:
  Type: Boolean
  Description: >-
   ルールアクションがエラー操作データを転送したかどうかを示します。エラー操作

   データは、ルールエンジンがIoTプラットフォームトピックから

   宛先クラウドサービスにデータを転送できなかったことを示します。データ転送の失敗は、転送の

   再試行も失敗したことを示します。有効な値:

   true:エラー操作データを転送します。

   false:エラー操作データの代わりに通常のデータを転送します。

   デフォルト値:false。
  AllowedValues:
   - 'True'
   - 'true'
   - 'False'
   - 'false'
 Type:
  Type: String
  Description: >-
   ルールアクションのタイプ。有効な値:

   MNS:ルールエンジンによって処理されたトピック内のデータを、メッセージ送信のためにMessage

   Service(MNS)に転送します。

   FC:ルールエンジンによって処理されたトピック内のデータを、イベントコンピューティングのためにFunction

   Computeに転送します。

   REPUBLISH:ルールエンジンによって処理されたトピック内のデータを別の

   IoTプラットフォームトピックに転送します。

   AMQP:AMQPコンシューマーグループにデータを転送します。

   OTS:ルールエンジンによって処理されたトピック内のデータを、NoSQLデータストレージのためにTable

   Storeに転送します。

   注

   バイナリデータ形式のルール(DataTypeパラメーターがBINARYに設定されている)

   は、Table Storeへのデータ転送をサポートしていません。

   ルールエンジンでサポートされている宛先Alibaba Cloudサービスは、

   リージョンによって異なります。ルールエンジンでサポートされているリージョンと宛先クラウド

   サービスの詳細については、「リージョンとゾーン」を参照してください。
  AllowedValues:
   - AMQP
   - DATAHUB
   - FC
   - MNS
   - ONS
   - OTS
   - REPUBLISH
 Configuration:
  Type: String
  Description: >-
   ルールアクションの構成。JSON文字列を指定する必要があります。

   異なるタイプのルールアクションの構成は異なります。必要な

   構文と例の詳細については、以下の表を参照してください。
 IotInstanceId:
  Type: String
  Description: >-
   インスタンスのID。このパラメーターは、パブリックインスタンスには必要ありません。ただし、

   購入したインスタンスにはこのパラメーターが必要です。
 RuleId:
  Type: Number
  Description: >-
   アクションを作成するルールのID。

   次のいずれかの方法を使用してルールIDを表示できます。1. IoTプラットフォーム

   コンソールにログインし、ルール>データ転送を選択します。2. ListRuleオペレーションを呼び出します。
Resources:
 RuleAction:
  Type: 'ALIYUN::IOT::RuleAction'
  Properties:
   ErrorActionFlag:
    Ref: ErrorActionFlag
   Type:
    Ref: Type
   Configuration:
    Ref: Configuration
   IotInstanceId:
    Ref: IotInstanceId
   RuleId:
    Ref: RuleId
Outputs:
 ActionId:
  Description: 'ルールアクションの ID。'
  Value:
   'Fn::GetAtt':
    - RuleAction
    - ActionId