StartExecution - 运维编排服务

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	StartExecution	系统规定参数。取值：StartExecution。
RegionId	String	否	cn-hangzhou	地域ID
TemplateName	String	是	vmeixme	模板名称。内容限制为字母、数字、中划线、下划线，长度200字符。
TemplateVersion	String	否	v1	版本号，如不填默认为最新的版本号。
Mode	String	否	Automatic	执行模式。取值： Debug Automatic（默认值）
LoopMode	String	否	Automatic	循环模式
ParentExecutionId	String	否	exec-xxx	父执行ID
SafetyCheck	String	否	Skip	安全检查模式。取值： Skip：此选项表示客户了解风险，无需确认即可执行任何Action，无论什么风险等级。`Mode=Automatic`时有效。 ConfirmEveryHighRiskAction（默认值）：此选项会要求客户确认每一个高风险的Action。客户通过调用NotifyExecution接口进行确认或取消。
Parameters	String	否	{"Status":"Running"}	由参数集合组成的Json字符串，默认为{}。
ClientToken	String	否	123e56767-e89b-12d3-a456-426655440000	访问令牌
Tags	Map	否	{"k1":"v2","k2":"v2"}	要给执行打的标签
Description	String	否	test execution.	要给执行添加的描述信息
TemplateContent	String	否	{ "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" } } } ] }	模板内容，JSON或YAML格式（同CreateTemplate API 请求参数中的Content字段）。用户传入此字段可直接执行TemplateContent中的任务，而无需提前创建模板再创建执行任务（当用户选择已有的Template创建执行任务时不需传入此字段）。
ResourceGroupId	String	否	rg-acfmxsn4m4******	资源组ID

返回数据


名称	类型	示例值	描述
RequestId	String	14A07460-EBE7-47CA-9757-12CC4761D47A	请求ID
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	Map		执行的标签
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	exec-xxxyyy	执行的唯一标识
Parameters	String	{ "Status":"Running" }	执行的输入参数
Description	String	test execution.	执行的描述信息
Counters	Map		执行数
UpdateDate	String	2019-05-16T10:26:14Z	更新时间
ResourceGroupId	String	rg-acfmxsn4m4******	资源组ID
ParentExecutionId	String	exec-xxxx	父执行ID
RamRole	String	OOSServiceRole	执行当前模板的角色
TemplateId	String	t-1bd341007f	模板ID
StatusMessage	String	""	状态信息
LoopMode	String	Automatic	循环模式
CurrentTasks	Array of CurrentTask		当前正在运行的Tasks
TaskExecutionId	String	exec-dsadasdawq	任务执行ID
TaskName	String	testTask	任务名称
TaskAction	String	ACS::TimerTrigger	任务的动作

示例

请求示例

http(s)://[Endpoint]/?Action=StartExecution
&RegionId=cn-hangzhou
&TemplateName=vmeixme
&TemplateVersion=v1
&Mode=Automatic
&LoopMode=Automatic
&ParentExecutionId=exec-xxx
&SafetyCheck=Skip
&Parameters={"Status":"Running"}
&ClientToken=123e56767-e89b-12d3-a456-426655440000
&Description=test execution.
&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": "ECS",         "API": "DescribeInstances",         "Parameters": {           "Status": "Running"         }       }     }   ] }
&ResourceGroupId=rg-acfmxsn4m4******
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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,
    "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.",
    "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"
    } ]
  }
}

错误码

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