啟動一個執行。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| oos:StartExecution | update | *Execution acs:oos:{#regionId}:{#accountId}:execution/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 地域 ID | cn-hangzhou |
| TemplateName | string | 否 | 模板名稱。內容限制為字母、數字、中劃線、下劃線，長度 200 字符。 | vmeixme |
| TemplateVersion | string | 否 | 版本號，如不填默認為最新的版本號。 | v1 |
| Mode | string | 否 | 執行模式。取值：
| Automatic |
| LoopMode | string | 否 | 循環模式。取值：
| Automatic |
| ParentExecutionId | string | 否 | 父執行 ID | exec-xxx |
| SafetyCheck | string | 否 | 安全檢查模式。取值：
| 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 API 請求參數中的 Content 字段）。用戶傳入此字段可直接執行 TemplateContent 中的任務，而無需提前創建模板再創建執行任務（當用戶選擇已有的 Template 創建執行任務時不需傳入此字段）。 | { "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 | 否 | 阿里云對象存儲 OSS 中存放 OOS 模板內容的 URL(只支持公共讀的 URL)。用戶傳入此字段可直接根據行 TemplateURL 中存儲的模板內容創建執行任務，無需提前創建模板再創建執行任務（當用戶選擇已有的 Template 創建執行任務時不需傳入此字段）。 | http://oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-test-template.json |
返回參數
示例
正常返回示例
JSON格式
{
"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"
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-19 | OpenAPI 描述信息更新 | 查看變更詳情 |
| 2022-11-07 | OpenAPI 入參發生變更 | 查看變更詳情 |