Queries executions. Multiple methods are supported to filter executions.
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 Resources
is 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:ListExecutions | list | *Execution acs:oos:{#regionId}:{#accountId}:execution/* *Execution acs:oos:{#regionId}:{#accountId}:execution/{#executionId} |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | No | The ID of the region. | cn-hangzhou |
TemplateName | string | No | The name of the template. All templates whose names contain the specified template name are queried. | MyTemplate |
Status | string | No | The status of the execution. Valid values: Running, Started, Success, Failed, Waiting, Cancelled, Pending, and Skipped. | Running |
ExecutionId | string | No | The ID of the execution. | exec-xxx |
StartDateBefore | string | No | The latest start time. The executions that start to run at or earlier than the specified point in time are queried. | 2019-05-16T10:26:14Z |
StartDateAfter | string | No | The earliest start time. The executions that start to run at or later than the specified time are queried. | 2019-05-16T10:26:14Z |
EndDateBefore | string | No | The latest end time. The executions that stop running at or earlier than the specified time are queried. | 2019-05-16T10:26:14Z |
EndDateAfter | string | No | The earliest end time. The executions that stop running at or later than the specified time are queried. | 2019-05-16T10:26:14Z |
Mode | string | No | The execution mode. Valid values:
| Automatic |
ExecutedBy | string | No | The executor. | vme |
ParentExecutionId | string | No | The ID of the parent execution. | exec-xxx |
RamRole | string | No | The RAM role. | OOSServiceRole |
IncludeChildExecution | boolean | No | Specifies whether to include child executions. Default value: False. | true |
Category | string | No | The type of the execution template. Valid values: Other, TimerTrigger, EventTrigger, and AlarmTrigger. | Other |
Tags | object | No | The tags for the execution. | {"k1":"v2","k2":"v2"} |
MaxResults | integer | No | The number of entries to return on each page. Valid values: 10 to 100. Default value: 50. | 50 |
NextToken | string | No | The token that is used to retrieve the next page of results. | MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ |
SortField | string | No | The field that is used to sort the executions to query. Valid values:
| StartDate |
SortOrder | string | No | The order in which you want to sort the results. Valid values:
| Ascending |
ResourceId | string | No | The ID of the Elastic Compute Service (ECS) resource. | i-xxx |
ResourceTemplateName | string | No | The name of the resource template. | ACS-ECS-TEST |
ResourceGroupId | string | No | The ID of the resource group to which the instances you want to query belong. | rg-acfmxsn4m4****** |
Description | string | No | The description of the execution. | MyDescription |
Depth | string | No | The depth of execution. Valid values: RootDepth and FirstChildDepth. If you set this parameter to RootDepth, only the parent execution is returned. If you set this parameter to FirstChildDepth, only the child executions at the first level are returned. You can specify only one of the Depth and IncludeChildExecution parameters. We recommend that you specify Depth. | RootDepth |
Categories | string | No | The types of the execution template. Valid values: Other, TimerTrigger, EventTrigger, and AlarmTrigger. You can specify only one of the Categories and Category parameters. We recommend that you specify Categories. | ["TimerTrigger"、"EventTrigger"] |
Response parameters
Examples
Sample success responses
JSON
format
{
"NextToken": "MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ",
"RequestId": "14A074-47CA-9757-12CC4761D47A",
"MaxResults": 50,
"Executions": [
{
"Status": "Success",
"WaitingStatus": "\"\"",
"Targets": "\"{\"ResourceType\": \"ALIYUN::ECS::Instance\", \"Filters\": [{\"ResourceIds\": [\"i-bp14z07dg3464980x72o\"], \"RegionId\": \"cn-hangzhou\", \"Type\": \"ResourceIds\"}]}\"",
"StatusReason": "\"\"",
"Tags": {},
"LastSuccessfulTriggerTime": "2019-05-27T09:29:18Z",
"Mode": "Automatic",
"SafetyCheck": "Skip",
"TemplateName": "MyTemplate",
"TemplateVersion": "v1",
"CreateDate": "2019-05-16T10:26:14Z",
"UpdateDate": "2019-05-16T10:26:14Z",
"Description": "test execution.",
"LastTriggerTime": "2019-05-27T09:29:18Z",
"ParentExecutionId": "exec-xxx",
"LastTriggerStatus": "Success",
"StatusMessage": "“”",
"Outputs": "{ \"InstanceId\":\"i-xxx\" }",
"ExecutedBy": "1309252800",
"EndDate": "2019-05-16T10:26:14Z",
"IsParent": false,
"StartDate": "2019-05-16T10:26:14Z",
"ExecutionId": "exec-44d32b45d2a449e",
"Parameters": {
"Status": "Running"
},
"Counters": {
"Failed": 0,
"Success": 1,
"Total": 2
},
"ResourceGroupId": "rg-acfmxsn4m4******",
"Category": "Other",
"TemplateId": "123",
"RamRole": "OOSServiceRole",
"ResourceStatus": "{ \t\t\t\"Success\": 1 \t\t}",
"CurrentTasks": [
{
"TaskExecutionId": "task-exec-44d32b45d2a49899#1",
"TaskName": "installSLSILogtail",
"TaskAction": "acs::Template"
}
],
"LastTriggerStatusMessage": "\"\"",
"LastTriggerOutputs": "{\n \"InstanceId\": \"i-xxx\"\n}",
"NextScheduleTime": "2019-05-16T10:26:14Z"
}
]
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-11-28 | The response structure of the API has changed | View Change Details |
2023-04-27 | The request parameters of the API has changed | View Change Details |
2023-03-27 | The request parameters of the API has changed | View Change Details |