Starts an execution.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| oos:StartExecution | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | No | The ID of the region in which the execution resides. | cn-hangzhou |
| TemplateName | string | No | The name of the template. The name must be 1 to 200 characters in length, and can contain letters, digits, hyphens (-), and underscores (_). | vmeixme |
| TemplateVersion | string | No | The version number of the template. If you do not specify this parameter, the system uses the latest version. | v1 |
| Mode | string | No | The execution mode. Valid values:
| Automatic |
| LoopMode | string | No | The loop mode. Valid values:
| Automatic |
| ParentExecutionId | string | No | The ID of the parent execution. | exec-xxx |
| SafetyCheck | string | No | The security check mode. Valid values:
| Skip |
| Parameters | string | No | The JSON string that consists of a set of parameters. Default value: {}. | {"Status":"Running"} |
| ClientToken | string | No | The access token. | 123e56767-e89b-12d3-a456-426655440000 |
| Tags | object | No | The tags for the execution. | {"k1":"v2","k2":"v2"} |
| Description | string | No | The description of the execution. | test execution. |
| TemplateContent | string | No | The content of the template in the JSON or YAML format. This parameter is the same as the Content parameter that you can specify when you call the CreateTemplate operation. You can use this parameter to specify the tasks that you want to run. This way, you do not need to create a template before you start an execution. If you select an existing template, you do not need to specify this parameter. | { "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 | No | The ID of the resource group. | rg-acfmxsn4m4****** |
| TemplateURL | string | No | The Object Storage Service (OSS) URL of the object that stores the content of the Operation Orchestration Service (OOS) template. The access control list (ACL) of the object must be public-read. You can use this parameter to specify the tasks that you want to run. This way, you do not need to create a template before you start an execution. If you select an existing template, you do not need to specify this parameter. | http://oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-test-template.json |
Response parameters
Examples
Sample success responses
JSONformat
{
"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"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||
|---|---|---|---|---|---|---|
| 2022-11-07 | The request parameters of the API has changed | see changesets | ||||
|