調用ALIYUN::IOT::RuleAction在指定的規則下建立一個規則動作 -

ALIYUN::IOT::RuleAction類型用於在指定的規則下建立一個規則動作。

文法

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

屬性

屬性名稱	類型	必須	允許更新	描述	約束
ErrorActionFlag	Boolean	否	否	規則動作是否轉寄錯誤操作資料（轉寄流轉到其他雲產品失敗且重試失敗的資料）。	取值： true：轉寄錯誤操作資料。 false（預設值）：不轉寄錯誤操作資料。
Type	String	是	是	規則動作類型。資料格式為二進位的規則，即規則的DataType參數是BINARY。不支援將資料轉寄至Table Store（Table Store）。	取值： REPUBLISH：將根據規則處理後的Topic資料轉寄至另一個物聯網平台Topic。 AMQP：資料流轉到AMQP消費組。 DATAHUB：將根據規則處理後的Topic資料轉寄至阿里雲DataHub，進行流式資料處理。 ONS：將根據規則處理後的Topic資料轉寄至阿里雲訊息佇列RocketMQ，進行訊息分發。 SMQ：將根據規則處理後的Topic資料發送至阿里雲Message Service中，進行訊息傳輸。 FC：將根據規則處理後的Topic資料發送至阿里雲Function Compute服務，進行事件計算。 OTS：將根據規則處理後的Topic資料發送至阿里雲Table Store（Tablestore），進行NoSQL資料存放區。
IotInstanceId	String	否	否	執行個體ID。	公用執行個體和企業版執行個體需要指定該參數。
Configuration	String	是	是	規則動作的配置資訊。	格式為JSON字串。不同規則動作類型所需內容不同。更多資訊，請參見CreateRuleAction。
RuleId	Integer	是	否	要為其建立動作的規則ID。	無

傳回值

Fn::GetAtt

ActionId：規則動作ID。

樣本

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ErrorActionFlag": {
      "Type": "Boolean",
      "Description": "Indicates whether the rule action forwarded error operation data. Error operation\ndata indicates that the rule engine failed to forward data from the IoT Platform topic\nto the destination cloud service. A data forwarding failure indicates that forwarding\nretries also failed. Valid values:\ntrue: forwards error operation data.\nfalse: forwards normal data instead of error operation data.\nDefault value: false.",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "Type": {
      "Type": "String",
      "Description": "The type of the rule action. Valid values:\nSMQ: forwards data in the topics that have been processed by the rule engine to Message\nService (SMQ) for message transmission.\nFC: forwards data in the topics that have been processed by the rule engine to Function\nCompute for event computing.\nREPUBLISH: forwards data in the topics that have been processed by the rule engine to another\nIoT Platform topic.\nAMQP: forwards data to AMQP consumer groups.\nOTS: forwards data in the topics that have been processed by the rule engine to Table\nStore for NoSQL data storage.\nNote\nRules of the binary data format (the DataType parameter is set toBINARY) do not support forwarding data to Table Store.\nDestination Alibaba Cloud services that are supported by the rule engine vary based\non regions. For more information about the regions and destination cloud services\nthat are supported by the rule engine, see Regions and zones.",
      "AllowedValues": [
        "AMQP",
        "DATAHUB",
        "FC",
        "SMQ",
        "ONS",
        "OTS",
        "REPUBLISH"
      ]
    },
    "Configuration": {
      "Type": "String",
      "Description": "The configurations of the rule action. You must specify a JSON string. The configurations\nfor different types of rule actions are different. For more information about required\nsyntax and examples, see the following tables."
    },
    "IotInstanceId": {
      "Type": "String",
      "Description": "The ID of the instance. This parameter is not required for public instances. However,\nthe parameter is required for the instances that you have purchased."
    },
    "RuleId": {
      "Type": "Number",
      "Description": "The ID of the rule for which you want to create an action. You can use either of the\nfollowing methods to view the rule ID: 1. Log on to the IoT Platform console and choose Rules>Data Forwarding. 2. Call the ListRule operation."
    }
  },
  "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": "The ID of the rule action. ",
      "Value": {
        "Fn::GetAtt": [
          "RuleAction",
          "ActionId"
        ]
      }
    }
  }
}

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
 ErrorActionFlag:
  Type: Boolean
  Description: >-
   Indicates whether the rule action forwarded error operation data. Error
   operation

   data indicates that the rule engine failed to forward data from the IoT
   Platform topic

   to the destination cloud service. A data forwarding failure indicates that
   forwarding

   retries also failed. Valid values:

   true: forwards error operation data.

   false: forwards normal data instead of error operation data.

   Default value: false.
  AllowedValues:
   - 'True'
   - 'true'
   - 'False'
   - 'false'
 Type:
  Type: String
  Description: >-
   The type of the rule action. Valid values:

   SMQ: forwards data in the topics that have been processed by the rule
   engine to Message

   Service (SMQ) for message transmission.

   FC: forwards data in the topics that have been processed by the rule
   engine to Function

   Compute for event computing.

   REPUBLISH: forwards data in the topics that have been processed by the
   rule engine to another

   IoT Platform topic.

   AMQP: forwards data to AMQP consumer groups.

   OTS: forwards data in the topics that have been processed by the rule
   engine to Table

   Store for NoSQL data storage.

   Note

   Rules of the binary data format (the DataType parameter is set toBINARY)
   do not support forwarding data to Table Store.

   Destination Alibaba Cloud services that are supported by the rule engine
   vary based

   on regions. For more information about the regions and destination cloud
   services

   that are supported by the rule engine, see Regions and zones.
  AllowedValues:
   - AMQP
   - DATAHUB
   - FC
   - SMQ
   - ONS
   - OTS
   - REPUBLISH
 Configuration:
  Type: String
  Description: >-
   The configurations of the rule action. You must specify a JSON string. The
   configurations

   for different types of rule actions are different. For more information
   about required

   syntax and examples, see the following tables.
 IotInstanceId:
  Type: String
  Description: >-
   The ID of the instance. This parameter is not required for public
   instances. However,

   the parameter is required for the instances that you have purchased.
 RuleId:
  Type: Number
  Description: >-
   The ID of the rule for which you want to create an action. You can use
   either of the

   following methods to view the rule ID: 1. Log on to the IoT Platform
   console and choose Rules>Data Forwarding. 2. Call the ListRule operation.
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: 'The ID of the rule action. '
  Value:
   'Fn::GetAtt':
    - RuleAction
    - ActionId