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	いいえ	いいえ	Resource Orchestration Service (ROS) によって使用されるリソースオプション。	詳細については、ResourceOptions プロパティをご参照ください。
Parameters	Map	いいえ	いいえ	パラメーターで構成される JSON 文字列。	例: `{"Status": "Running"}`。デフォルト値: {}。
Tags	Map	いいえ	いいえ	タグ。タグはキーと値のペアです。例: {"k1":"v1", "k2":"v2"}。	最大 20 個のタグを追加できます。
TemplateName	String	いいえ	いいえ	テンプレート名。	名前は最大 200 文字まで使用できます。ALIYUN、ACS、または ALIBABA で始めることはできません。文字、数字、ハイフン（-）、およびアンダースコア（_）を含めることができます。
ParentExecutionId	String	いいえ	いいえ	親実行の ID。	なし。
SafetyCheck	String	いいえ	いいえ	安全確認モード。	有効な値: Skip: リスクレベルに関係なく、すべてのアクションの手動確認をスキップします。この値は、Mode が Automatic に設定されている場合に有効です。 ConfirmEveryHighRiskAction (デフォルト): リスクの高いすべてのアクションで手動確認が必要です。NotifyExecution オペレーションを呼び出して、アクションを確認またはキャンセルできます。
Mode	String	いいえ	いいえ	実行モード。	有効な値: Debug Automatic (デフォルト)
TemplateVersion	String	いいえ	いいえ	バージョン番号。	このプロパティを空のままにすると、システムは最新バージョンを使用します。
ResourceGroupId	String	いいえ	いいえ	リソースグループの ID。	なし。
LoopMode	String	いいえ	いいえ	ループモード。	なし。
Description	String	いいえ	いいえ	実行の説明。	なし。
TemplateContent	String	いいえ	いいえ	テンプレートコンテンツ。	テンプレートコンテンツは JSON または YAML 形式です。このプロパティは、CreateTemplate オペレーションの Content パラメーターと同じ効果があります。このプロパティを指定して、テンプレートコンテンツで定義されているタスクを直接実行できます。この方法では、テンプレートとタスクを個別に作成する必要はありません。 TemplateName を使用して既存のテンプレートを指定してタスクを作成する場合は、TemplateContent を空のままにすることができます。
TemplateURL	String	いいえ	いいえ	CloudOps Orchestration Service (OOS) テンプレートコンテンツが格納されている Object Storage Service (OSS) リソースの URL。パブリック読み取り URL のみがサポートされています。	このプロパティを指定して、テンプレートコンテンツで定義されているタスクを直接作成できます。この方法では、テンプレートとタスクを個別に作成する必要はありません。 TemplateName を使用して既存のテンプレートを指定してタスクを作成する場合は、TemplateURL を空のままにすることができます。

ResourceOptions 構文

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

ResourceOptions プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
SuccessStatuses	List	いいえ	いいえ	リソースが作成されたかどうかを指定する状態。	有効な値: Started Queued Running Waiting Success (デフォルト) Failed Cancelled 実行の状態が FailureStatuses プロパティの値に含まれている場合、リソースの作成に失敗しました。実行の状態が SuccessStatuses プロパティの値に含まれている場合、リソースは作成されます。上記の条件のいずれも満たされない場合、システムはリクエストがタイムアウトするまで待機します。
Timeout	Number	いいえ	いいえ	タイムアウト期間。	単位: 秒。デフォルト値: 1800。
CancelOnDelete	Boolean	いいえ	いいえ	リソースの削除時に完了していない実行をキャンセルするかどうかを指定します。	有効な値: true false (デフォルト)
FailureStatuses	List	いいえ	いいえ	リソースの作成に失敗したかどうかを指定する状態。 FailureStatuses プロパティは SuccessStatuses プロパティよりも優先されます。	有効な値: Started Queued Running Waiting Success Failed Cancelled デフォルト値: `["Failed", "Cancelled"]`。

戻り値

Fn::GetAtt

Status: 実行の状態。
WindowsCurlCli: Windows 用に提供される cURL CLI コマンドプレフィックスです。 WindowsCurlCli を使用すると、実行が完了したか失敗したかを示すシグナルを送信できます。詳細については、「NotifyExecution」をご参照ください。
PowerShellCurlCli: PowerShell 用に提供される cURL CLI コマンドプレフィックス。 PowerShellCurlCli を使用して、実行が完了したか失敗したかを示すシグナルを送信できます。
Outputs: 実行の出力。
ExecutionId: 実行の一意の ID。
CurlCli: cURL コマンド。
StatusMessage: 状態情報。
Counters: 実行の数。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TemplateName:
    Type: String
    Description: テンプレート名。コンテンツは文字、数字、下線、下線、200 文字の長さに制限されており、ALIYUN、ACS、ALIBABA で始めることはできません。
    Label: テンプレート名
    ConstraintDescription: '[2, 128] 英語または中国語の文字'
    MinLength: 2
    MaxLength: 128
    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

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TemplateName": {
      "Type": "String",
      "Description": "テンプレート名。コンテンツは文字、数字、下線、下線、200 文字の長さに制限されており、ALIYUN、ACS、ALIBABA で始めることはできません。",
      "Label": "テンプレート名",
      "ConstraintDescription": "[2, 128] 英語または中国語の文字",
      "MinLength": 2,
      "MaxLength": 128,
      "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"
        ]
      }
    }
  }
}