全部产品
Search
文档中心

运维编排服务:StartExecution - 启动一个执行

更新时间:Nov 21, 2022

调用StartExecution启动一个执行。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oos:StartExecutionWRITE
  • OOS
    acs:oos:{#regionId}:{#accountId}:execution/*
  • OOS
    acs:oos:{#regionId}:{#accountId}:template/{#templateName}
  • oos:tag

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID

cn-hangzhou
TemplateNamestring

模板名称。内容限制为字母、数字、中划线、下划线,长度200字符。

vmeixme
TemplateVersionstring

版本号,如不填默认为最新的版本号。

v1
Modestring

执行模式。取值:

  • Automatic(默认值):自动执行
  • FailurePause:失败暂停
  • Debug:单步执行
Automatic
LoopModestring

循环模式。取值:

  • Automatic(默认值):不暂停
  • FirstBatchPause:第一批暂停
  • EveryBatchPause:每批暂停
Automatic
ParentExecutionIdstring

父执行ID

exec-xxx
SafetyCheckstring

安全检查模式。取值:

  • Skip:此选项表示客户了解风险,无需确认即可执行任何Action,无论什么风险等级。Mode=Automatic时有效。
  • ConfirmEveryHighRiskAction(默认值):此选项会要求客户确认每一个高风险的Action。客户通过调用NotifyExecution接口进行确认或取消。
Skip
Parametersstring

由参数集合组成的Json字符串,默认为{}。

{"Status":"Running"}
ClientTokenstring

访问令牌

123e56767-e89b-12d3-a456-426655440000
Tagsobject

要给执行打的标签

Descriptionstring

要给执行添加的描述信息

test execution.
TemplateContentstring

模板内容,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" } } } ] }
ResourceGroupIdstring

资源组ID

rg-acfmxsn4m4******
TemplateURLstring

阿里云对象存储OSS中存放OOS模板内容的URL(只支持公共读的URL)。用户传入此字段可直接根据行TemplateURL中存储的模板内容创建执行任务,无需提前创建模板再创建执行任务(当用户选择已有的Template创建执行任务时不需传入此字段)。

http://oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-test-template.json

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID

14A07460-EBE7-47CA-9757-12CC4761D47A
Executionobject

执行数据

Outputsstring

执行输出结果

{ "InstanceId":"i-xxx" }
Statusstring

执行状态

Success
EndDatestring

结束时间

2019-05-16T10:26:14Z
ExecutedBystring

执行模板者

root(13092080xx12344)
IsParentboolean

是否包含子任务

false
Tagsobject

执行的标签

StartDatestring

开始时间

2019-05-16T10:26:14Z
SafetyCheckstring

安全检查模式

Skip
Modestring

执行模式

Automatic
TemplateNamestring

模板名称

MyTemplate
CreateDatestring

执行创建时间

2019-05-16T10:26:14Z
TemplateVersionstring

模板版本号

v1
ExecutionIdstring

执行的唯一标识

exec-xxxyyy
Parametersstring

执行的输入参数

{ "Status":"Running" }
Descriptionstring

执行的描述信息

test execution.
Countersobject

执行数

UpdateDatestring

更新时间

2019-05-16T10:26:14Z
ResourceGroupIdstring

资源组ID

rg-acfmxsn4m4******
ParentExecutionIdstring

父执行ID

exec-xxxx
RamRolestring

执行当前模板的角色

OOSServiceRole
TemplateIdstring

模板ID

t-1bd341007f
StatusMessagestring

状态信息

""
LoopModestring

循环模式

Automatic
CurrentTasksarray

当前正在运行的Tasks

object
TaskExecutionIdstring

任务执行ID

exec-dsadasdawq
TaskNamestring

任务名称

testTask
TaskActionstring

任务的动作

ACS::TimerTrigger

示例

正常返回示例

JSON格式

{
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "Execution": {
    "Outputs": "{ \"InstanceId\":\"i-xxx\" }",
    "Status": "Success",
    "EndDate": "2019-05-16T10:26:14Z",
    "ExecutedBy": "root(13092080xx12344)",
    "IsParent": true,
    "Tags": {
      "test": "test",
      "test2": 1
    },
    "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": {
      "test": "test",
      "test2": 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"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-11-07OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:TemplateURL