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: ステップバイステップ実行	自動
LoopMode	string	任意	ループモード。有効な値: Automatic (デフォルト): 自動で一時停止しない FirstBatchPause: 最初のバッチ後に一時停止 EveryBatchPause: 各バッチ後に一時停止	自動
ParentExecutionId `deprecated`	string	任意	親エグゼキューションの ID。	exec-xxx
SafetyCheck	string	任意	安全チェックモード。有効な値: Skip (デフォルト): このオプションは、ユーザーがリスクを認識しており、リスクレベルに関係なく確認なしで任意の操作を実行できることを示します。このオプションは `Mode=自動` の場合にのみ有効です。 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 フィールドと同じです。このパラメーターを指定すると、テンプレートを事前に作成せずに TemplateContent で定義されたタスクを直接実行できます。既存のテンプレートを使用してタスク実行を作成する場合は、このパラメーターを指定する必要はありません。	{ "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": "サービス", "API": "DescribeInstances", "Parameters": { "Status": "Running" } } } ] }
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfmxsn4m4******
TemplateURL	string	任意	Alibaba Cloud Object Storage サービス (OSS) に保存されている OOS テンプレートコンテンツの URL。公開読み取り可能な URL のみがサポートされています。このパラメーターを指定すると、テンプレートを事前に作成せずに TemplateURL に保存されているテンプレートコンテンツに基づいてタスク実行を直接作成できます。既存のテンプレートを使用してタスク実行を作成する場合は、このパラメーターを指定する必要はありません。	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	実行モード。	自動
TemplateName	string	テンプレート名。	MyTemplate
CreateDate	string	タスク実行の作成時間。	2019-05-16T10:26:14Z
TemplateVersion	string	テンプレートのバージョン番号。	v1
ExecutionId	string	タスク実行の一意識別子。	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	ループモード。	自動
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"
      }
    ]
  }
}

エラーコード

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

変更履歴

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