ALIYUN::OOS::Execution を使用して実行を開始する - Resource Orchestration Service

ALIYUN::OOS::Execution は、実行を開始します。

構文

{
  "Type": "ALIYUN::OOS::Execution",
  "Properties": {
    "ResourceOptions": Map,
    "Parameters": Map,
    "Tags": Map,
    "TemplateName": String,
    "ParentExecutionId": String,
    "SafetyCheck": String,
    "Mode": String,
    "TemplateVersion": String,
    "ResourceGroupId": String,
    "LoopMode": String,
    "Description": String,
    "TemplateContent": String,
    "TemplateURL": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ResourceOptions	Map	No	No	詳細については、「ResourceOptions プロパティ」をご参照ください。	詳細については、「ResourceOptions プロパティ」をご参照ください。
Parameters	Map	No	No	例： `{"Status": "Running"}`。デフォルト値： {}。	例： `{"Status": "Running"}`。デフォルト値： `{}`。
Tags	Map	No	No	最大 20 個のタグがサポートされます。	最大 20 個のタグがサポートされます。
TemplateName	String	No	No	テンプレート名。	名前は最大 200 文字で、ALIYUN、ACS、または ALIBABA で始めることはできません。文字、数字、ハイフン (-)、アンダースコア (_) を使用できます。
ParentExecutionId	String	No	No	親実行 ID。	なし
SafetyCheck	String	No	No	安全性チェックのモード。	有効値： Skip：安全性チェックをスキップします。リスクを理解した上で、リスクレベルに関係なく、確認なしで任意のアクションを実行できます。この値は、Mode が Automatic に設定されている場合にのみ有効です。 ConfirmEveryHighRiskAction (デフォルト)：各高リスクアクションの確認が必要です。NotifyExecution API を呼び出して、アクションを確認またはキャンセルします。
Mode	String	No	No	実行モード。	有効値： Debug Automatic (デフォルト)
TemplateVersion	String	No	No	バージョン番号。	このプロパティを空白のままにした場合、最新のバージョン番号が使用されます。
ResourceGroupId	String	No	No	リソースグループ ID。	なし
LoopMode	String	No	No	ループモード。	なし
Description	String	No	No	実行に追加する説明。	なし
TemplateContent	String	No	No	テンプレートコンテンツ。	コンテンツは JSON または YAML 形式である必要があります。コンテンツは、CreateTemplate API のリクエストパラメーターの Content フィールドと同じです。このプロパティを指定した場合、TemplateContent 内のタスクが直接実行されるため、最初にテンプレートを作成する必要はありません。既存のテンプレートから実行を作成する場合は、このプロパティは空のままにします。
TemplateURL	String	No	No	Alibaba Cloud Object Storage Service (OSS) に保存されている OOS テンプレートコンテンツの URL。パブリック読み取り権限を持つ URL のみがサポート対象です。	このプロパティを指定した場合、実行では TemplateURL に保存されているテンプレートコンテンツが実行されるため、最初にテンプレートを作成する必要はありません。既存のテンプレートから実行を作成する場合は、このプロパティは空のままにします。

ResourceOptions の構文

"ResourceOptions": {
  "SuccessStatuses": List,
  "Timeout": Number,
  "CancelOnDelete": Boolean,
  "FailureStatuses": List
}

ResourceOptions のプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
SuccessStatuses	List	No	No	ROS はこのプロパティを使用して、リソースが正常に作成されたかどうかを判断します。	有効値： Started Queued 実行中 Waiting Success (デフォルト) Failed Cancelled 実行ステータスが `FailureStatuses` にある場合は失敗と判断されます。実行ステータスが `SuccessStatuses` にある場合は成功と判断されます。上記のいずれの条件も満たされない場合は、タイムアウト (`Timeout`) するまで待機し続けます。
Timeout	Number	No	No	タイムアウト期間。	単位：秒。値：1800。
CancelOnDelete	Boolean	No	No	リソースが削除されたときに実行が完了していない場合に、実行をキャンセルするかどうかを指定します。	有効値： true：実行をキャンセルします。 false (デフォルト)：実行をキャンセルしません。
FailureStatuses	List	No	No	ROS はこのプロパティを使用して、リソースの作成に失敗したかどうかを判断します。FailureStatuses は SuccessStatuses よりも優先度が高くなります。	有効値： Started Queued Running Waiting Success Failed Cancelled デフォルト値： `["Failed", "Cancelled"]`

戻り値

Fn::GetAtt

Status：実行のステータス。
WindowsCurlCli： Windows 用の curl コマンドラインインターフェイス (CLI) コマンドプレフィックス。これを使用して、処理が完了したか失敗したかを通知できます。詳細については、「NotifyExecution」をご参照ください。
PowerShellCurlCli： PowerShell 用の curl CLI コマンドプレフィックス。これを使用して、処理が完了したか失敗したかを通知できます。
Outputs：実行の出力。
ExecutionId：実行 ID。
CurlCli： curl CLI コマンドプレフィックス。これを使用して、処理が完了したか失敗したかを通知できます。
StatusMessage：ステータスメッセージ。
Counters：実行のカウンター。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TemplateName:
    Type: String
    # テンプレート名。名前は最大 200 文字で、ALIYUN、ACS、または ALIBABA で始めることはできません。文字、数字、ハイフン (-)、アンダースコア (_) を使用できます。
    Description: The name can be up to 200 characters in length. It cannot start with ALIYUN, ACS, or ALIBABA. It can contain letters, digits, hyphens (-), and underscores (_).
    # テンプレート名
    Label: Template Name
    # 2～200 文字
    ConstraintDescription: '2 to 200 characters'
    MinLength: 2
    MaxLength: 200
    Default: mytest
Resources:
  Execution:
    Type: ALIYUN::OOS::Execution
    Properties:
      Parameters: {}
      TemplateName:
        Ref: TemplateName
      ResourceOptions:
        SuccessStatuses:
          - Running
          - Success
          - Queued
          - Waiting
        CancelOnDelete: true
Outputs:
  Status:
    # 実行ステータス。
    Description: 実行ステータス。
    Value:
      Fn::GetAtt:
        - Execution
        - Status
  WindowsCurlCli:
    # Windows 用の curl CLI コマンドプレフィックスを提供する便利な属性です。OOS API NotifyExecution の代わりに、これを使用して OOS 実行に通知できます。「--data-binary "{\"data\": {\"NotifyType\": \"Approve\"}}"」を追加することで、承認を OOS 実行に通知できます。ROS API SignalResource を介して実行に通知することもできます。API パラメーターの Status と UniqueId は無視されます。API パラメーターの Data を使用してデータを渡します。
    Description: 'Windows 用の curl CLI コマンドプレフィックスを提供する便利な属性です。OOS API NotifyExecution の代わりに、これを使用して OOS 実行に通知できます。「--data-binary "{\"data\": {\"NotifyType\": \"Approve\"}}"」を追加することで、承認を OOS 実行に通知できます。ROS API SignalResource を介して実行に通知することもできます。API パラメーターの Status と UniqueId は無視されます。API パラメーターの Data を使用してデータを渡します。'
    Value:
      Fn::GetAtt:
        - Execution
        - WindowsCurlCli
  PowerShellCurlCli:
    # PowerShell 用の curl CLI コマンドプレフィックスを提供する便利な属性です。OOS API NotifyExecution の代わりに、これを使用して OOS 実行に通知できます。「-Body ''{"data": {"NotifyType": "Approve"}}''」を追加することで、承認を OOS 実行に通知できます。ROS API SignalResource を介して実行に通知することもできます。API パラメーターの Status と UniqueId は無視されます。API パラメーターの Data を使用してデータを渡します。
    Description: 'PowerShell 用の curl CLI コマンドプレフィックスを提供する便利な属性です。OOS API NotifyExecution の代わりに、これを使用して OOS 実行に通知できます。「-Body ''{"data": {"NotifyType": "Approve"}}''」を追加することで、承認を OOS 実行に通知できます。ROS API SignalResource を介して実行に通知することもできます。API パラメーターの Status と UniqueId は無視されます。API パラメーターの Data を使用してデータを渡します。'
    Value:
      Fn::GetAtt:
        - Execution
        - PowerShellCurlCli
  Outputs:
    # 実行の出力。
    Description: 実行の出力。
    Value:
      Fn::GetAtt:
        - Execution
        - Outputs
  ExecutionId:
    # 実行 ID。
    Description: 実行 ID。
    Value:
      Fn::GetAtt:
        - Execution
        - ExecutionId
  CurlCli:
    # curl CLI コマンドプレフィックスを提供する便利な属性です。OOS API NotifyExecution の代わりに、これを使用して OOS 実行に通知できます。「--data-binary ''{"data": {"NotifyType": "Approve"}}''」を追加することで、承認を OOS 実行に通知できます。ROS API SignalResource を介して実行に通知することもできます。API パラメーターの Status と UniqueId は無視されます。API パラメーターの Data を使用してデータを渡します。
    Description: 'curl CLI コマンドプレフィックスを提供する便利な属性です。OOS API NotifyExecution の代わりに、これを使用して OOS 実行に通知できます。「--data-binary ''{"data": {"NotifyType": "Approve"}}''」を追加することで、承認を OOS 実行に通知できます。ROS API SignalResource を介して実行に通知することもできます。API パラメーターの Status と UniqueId は無視されます。API パラメーターの Data を使用してデータを渡します。'
    Value:
      Fn::GetAtt:
        - Execution
        - CurlCli
  StatusMessage:
    # 実行ステータス情報。
    Description: 実行ステータス情報。
    Value:
      Fn::GetAtt:
        - Execution
        - StatusMessage
  Counters:
    # タスク統計：FailedTasks、SuccessTasks、TotalTasks。
    Description: 'タスク統計： FailedTasks、SuccessTasks、TotalTasks。'
    Value:
      Fn::GetAtt:
        - Execution
        - Counters

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TemplateName": {
      "Type": "String",
      "Description": "テンプレート名。名前は最大 200 文字で、ALIYUN、ACS、または ALIBABA で始めることはできません。文字、数字、ハイフン (-)、アンダースコア (_) を使用できます。",
      "Label": "テンプレート名",
      "ConstraintDescription": "2～200 文字",
      "MinLength": 2,
      "MaxLength": 200,
      "Default": "mytest"
    }
  },
  "Resources": {
    "Execution": {
      "Type": "ALIYUN::OOS::Execution",
      "Properties": {
        "Parameters": {
        },
        "TemplateName": {
          "Ref": "TemplateName"
        },
        "ResourceOptions": {
          "SuccessStatuses": [
            "Running",
            "Success",
            "Queued",
            "Waiting"
          ],
          "CancelOnDelete": true
        }
      }
    }
  },
  "Outputs": {
    "Status": {
      "Description": "実行ステータス。",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "Status"
        ]
      }
    },
    "WindowsCurlCli": {
      "Description": "Windows 用の curl CLI コマンドプレフィックスを提供する便利な属性です。OOS API NotifyExecution の代わりに、これを使用して OOS 実行に通知できます。「--data-binary \"{\\\"data\\\": {\\\"NotifyType\\\": \\\"Approve\\\"}}\"」を追加することで、承認を OOS 実行に通知できます。ROS API SignalResource を介して実行に通知することもできます。API パラメーターの Status と UniqueId は無視されます。API パラメーターの Data を使用してデータを渡します。",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "WindowsCurlCli"
        ]
      }
    },
    "PowerShellCurlCli": {
      "Description": "PowerShell 用の curl CLI コマンドプレフィックスを提供する便利な属性です。OOS API NotifyExecution の代わりに、これを使用して OOS 実行に通知できます。「-Body '{\"data\": {\"NotifyType\": \"Approve\"}}'」を追加することで、承認を OOS 実行に通知できます。ROS API SignalResource を介して実行に通知することもできます。API パラメーターの Status と UniqueId は無視されます。API パラメーターの Data を使用してデータを渡します。",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "PowerShellCurlCli"
        ]
      }
    },
    "Outputs": {
      "Description": "実行の出力。",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "Outputs"
        ]
      }
    },
    "ExecutionId": {
      "Description": "実行 ID。",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "ExecutionId"
        ]
      }
    },
    "CurlCli": {
      "Description": "curl CLI コマンドプレフィックスを提供する便利な属性です。OOS API NotifyExecution の代わりに、これを使用して OOS 実行に通知できます。「--data-binary '{\"data\": {\"NotifyType\": \"Approve\"}}'」を追加することで、承認を OOS 実行に通知できます。ROS API SignalResource を介して実行に通知することもできます。API パラメーターの Status と UniqueId は無視されます。API パラメーターの Data を使用してデータを渡します。",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "CurlCli"
        ]
      }
    },
    "StatusMessage": {
      "Description": "実行ステータス情報。",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "StatusMessage"
        ]
      }
    },
    "Counters": {
      "Description": "タスク統計： FailedTasks、SuccessTasks、TotalTasks。",
      "Value": {
        "Fn::GetAtt": [
          "Execution",
          "Counters"
        ]
      }
    }
  }
}