StartExecution による実行の開始 - OOS - Alibaba Cloud - CloudOps Orchestration Service

実行を開始します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oos:StartExecution

update

*Execution

acs:oos:{#regionId}:{#accountId}:execution/*

oos:tag
oos:IsOOSAssumeRole
oos:TLSVersion

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョンの ID です。	cn-hangzhou
TemplateName	string	任意	テンプレートの名前です。名前には英字、数字、ハイフン (-)、アンダースコア (_) を使用できます。最大長は 200 文字です。	vmeixme
TemplateVersion	string	任意	テンプレートのバージョン番号です。このパラメーターを指定しない場合、最新バージョンが使用されます。	v1
Mode	string	任意	実行モードです。有効な値は以下のとおりです。 Automatic (デフォルト)：実行が自動的に実施されます。 FailurePause：タスクが失敗した場合、実行が一時停止されます。 Debug：実行がステップ実行モードで実施されます。	Automatic
LoopMode	string	任意	ループモードです。有効な値は以下のとおりです。 Automatic (デフォルト)：実行は一時停止されません。 FirstBatchPause：最初のバッチタスクが完了した後、実行が一時停止されます。 EveryBatchPause：各バッチタスクが完了するたびに、実行が一時停止されます。	Automatic
ParentExecutionId `deprecated`	string	任意	親エグゼキューションの ID です。	exec-xxx
SafetyCheck	string	任意	セキュリティチェックモードです。有効な値は以下のとおりです。 Skip (デフォルト)：リスクを認識していることを示します。リスクレベルに関係なく、システムは確認なしですべての操作を実行します。このモードは、Mode が `Automatic` に設定されている場合にのみ有効です。 ConfirmEveryHighRiskAction：高リスク操作ごとに確認が必要です。NotifyExecution 操作を呼び出して、操作を承認またはキャンセルできます。	Skip
Parameters	string	任意	パラメーターのコレクションからなる JSON 文字列です。デフォルト値は {} です。	{"Status":"Running"}
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。	123e56767-e89b-12d3-a456-426655440000
Tags	object	任意	実行に追加するタグです。	{ "k1": "v1", "k2": "v2" }
Description	string	任意	実行の説明です。	test execution.
TemplateContent	string	任意	テンプレートの内容で、JSON または YAML 形式である必要があります。このパラメーターは、CreateTemplate 操作の Content リクエストパラメーターと同じです。テンプレートを作成せずにテンプレート内容内のタスクを実行するために、このパラメーターを指定できます。既存のテンプレートを使用して実行を作成する場合は、このパラメーターを指定する必要はありません。	{ "Description": "Example template, describe instances in some status", "FormatVersion": "OOS-2019-06-01", "Parameters": {}, "Tasks": [ { "Name": "describeInstances", "Action": "ACS::ExecuteAPI", "Description": "desc-en", "Properties": { "Service": "ECS", "API": "DescribeInstances", "Parameters": { "Status": "Running" } } } ] }
ResourceGroupId	string	任意	リソースグループの ID です。	rg-acfmxsn4m4******
TemplateURL	string	任意	OOS テンプレートの内容を格納する Object Storage Service (OSS) オブジェクトの URL です。URL は公開読み取りのものである必要があります。テンプレートを作成せずに OSS オブジェクトに格納されたテンプレート内容内のタスクを実行するために、このパラメーターを指定できます。既存のテンプレートを使用して実行を作成する場合は、このパラメーターを指定する必要はありません。	http://oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-test-template.json

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	14A07460-EBE7-47CA-9757-12CC4761D47A
Execution	object	実行のデータです。
Outputs	string	実行の出力です。	{ "InstanceId":"i-xxx" }
Status	string	実行のステータスです。	Success
EndDate	string	実行が終了した時刻です。	2019-05-16T10:26:14Z
ExecutedBy	string	実行を開始したユーザーです。	root(13092080xx12344)
IsParent	boolean	実行に子タスクが含まれているかどうかを示します。	false
Tags	object	実行のタグです。	{"k1":"v2","k2":"v2"}
StartDate	string	実行が開始された時刻です。	2019-05-16T10:26:14Z
SafetyCheck	string	セキュリティチェックモードです。	Skip
Mode	string	実行モードです。	Automatic
TemplateName	string	テンプレートの名前です。	MyTemplate
CreateDate	string	実行が作成された時刻です。	2019-05-16T10:26:14Z
TemplateVersion	string	テンプレートのバージョン番号です。	v1
ExecutionId	string	実行の一意な ID です。	exec-xxxyyy
Parameters	string	実行の入力パラメーターです。	{ "Status":"Running" }
Description	string	実行の説明です。	test execution.
Counters	object	実行回数です。	1
UpdateDate	string	実行が最後に更新された時刻です。	2019-05-16T10:26:14Z
ResourceGroupId	string	リソースグループの ID です。	rg-acfmxsn4m4******
ParentExecutionId	string	親エグゼキューションの ID です。	exec-xxxx
RamRole	string	テンプレートを実行するために使用される RAM ロールです。	OOSServiceRole
TemplateId	string	テンプレートの ID です。	t-1bd341007f
StatusMessage	string	ステータスメッセージです。	""
LoopMode	string	ループモードです。	Automatic
CurrentTasks	array<object>	現在実行中のタスクです。
	object
TaskExecutionId	string	タスク実行の ID です。	exec-dsadasdawq
TaskName	string	タスクの名前です。	testTask
TaskAction	string	タスクの操作です。	ACS::TimerTrigger

例

成功レスポンス

JSONJSON

{
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "Execution": {
    "Outputs": "{ \"InstanceId\":\"i-xxx\" }",
    "Status": "Success",
    "EndDate": "2019-05-16T10:26:14Z",
    "ExecutedBy": "root(13092080xx12344)",
    "IsParent": false,
    "Tags": {
      "k1": "v2",
      "k2": "v2"
    },
    "StartDate": "2019-05-16T10:26:14Z",
    "SafetyCheck": "Skip",
    "Mode": "Automatic",
    "TemplateName": "MyTemplate",
    "CreateDate": "2019-05-16T10:26:14Z",
    "TemplateVersion": "v1",
    "ExecutionId": "exec-xxxyyy",
    "Parameters": "{ \"Status\":\"Running\" }",
    "Description": "test execution.",
    "Counters": 1,
    "UpdateDate": "2019-05-16T10:26:14Z",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "ParentExecutionId": "exec-xxxx",
    "RamRole": "OOSServiceRole",
    "TemplateId": "t-1bd341007f",
    "StatusMessage": "\"\"",
    "LoopMode": "Automatic",
    "CurrentTasks": [
      {
        "TaskExecutionId": "exec-dsadasdawq",
        "TaskName": "testTask",
        "TaskAction": "ACS::TimerTrigger"
      }
    ]
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。