Query executions by using ListExecutions - CloudOps Orchestration Service

Lists query executions and supports multiple filters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oos:ListExecutions

list

*Execution

acs:oos:{#regionId}:{#accountId}:execution/*

*Execution

acs:oos:{#regionId}:{#accountId}:execution/{#executionId}

oos:tag
oos:TLSVersion

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. This parameter supports fuzzy search. The operation returns executions of templates whose names contain the value you specify.	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	Specifies a filter to return only executions that started at or before this time.	2019-05-16T10:26:14Z
StartDateAfter	string	No	Specifies a filter to return only executions that started at or after this time.	2019-05-16T10:26:14Z
EndDateBefore	string	No	Specifies a filter to return only executions that ended at or before this time.	2019-05-16T10:26:14Z
EndDateAfter	string	No	Specifies a filter to return only executions that ended at or after this time.	2019-05-16T10:26:14Z
Mode	string	No	The execution mode. Valid values: Automatic Debug	Automatic
ExecutedBy	string	No	The user who started the execution.	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 in the results. The default is False.	true
Category	string	No	The category of the template. Valid values: `Other`, `TimerTrigger`, `EventTrigger`, and `AlarmTrigger`.	Other
Tags	object	No	The tags attached to the execution.	{ "k1": "v1", "k2": "v2" }
MaxResults	integer	No	The number of entries to return on each page. Valid values: 10 to 100. The default is 50.	50
NextToken	string	No	The pagination token returned from a previous call that you can use to retrieve the next page of results.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ
SortField	string	No	The field to use for sorting the returned executions. Valid values: StartDate (default): the time when the execution was created EndDate: the end time of the execution Status: the status of the execution	StartDate
SortOrder	string	No	The sort order. Valid values: Ascending: ascending order Descending (default): descending order	Ascending
ResourceId	string	No	The ID of the ECS resource.	i-xxx
ResourceTemplateName	string	No	The name of the resource's template.	ACS-ECS-TEST
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmxsn4m4******
Description	string	No	The description of the execution.	MyDescription
Depth	string	No	The level of execution data to return. Valid values: `RootDepth` and `FirstChildDepth`. `RootDepth` returns only parent executions. `FirstChildDepth` returns only first-level child executions. You can specify either this parameter or `IncludeChildExecution`, but not both. We recommend that you use `Depth`.	RootDepth
Categories	string	No	A list of template categories. Valid values: `Other`, `TimerTrigger`, `EventTrigger`, and `AlarmTrigger`. You can specify either this parameter or `Category`, but not both. We recommend that you use `Categories`.	["TimerTrigger"、"EventTrigger"]
RdFolderIds	array	No	The IDs of folders in Resource Directory. Use this parameter to query executions within specific folders.
	string	No	The ID of a folder in Resource Directory.	rd-xxx

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token to retrieve the next page of results.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ
RequestId	string	The request ID.	14A074-47CA-9757-12CC4761D47A
MaxResults	integer	The number of entries returned per page.	50
Executions	array<object>	The list of executions.
	array<object>
Status	string	The status of the execution. Valid values: Started, Queued, Running, Waiting, Success, Failed, and Cancelled.	Success
WaitingStatus	string	The waiting status of the execution.	""
Targets	string	The execution's target resources.	"{"ResourceType": "ALIYUN::ECS::Instance", "Filters": [{"ResourceIds": ["i-bp14z07dg3464980x72o"], "RegionId": "cn-hangzhou", "Type": "ResourceIds"}]}"
StatusReason	string	The reason for the current status.	""
Tags	object	The execution's tags.	{}
LastSuccessfulTriggerTime	string	The last time the template was successfully triggered.	2019-05-27T09:29:18Z
Mode	string	The execution mode.	Automatic
SafetyCheck	string	The safety check mode. Valid values: Skip and ConfirmEveryHighRiskAction.	Skip
TemplateName	string	The name of the template.	MyTemplate
TemplateVersion	string	The version of the template.	v1
CreateDate	string	The time the execution was created.	2019-05-16T10:26:14Z
UpdateDate	string	The time the execution was last updated.	2019-05-16T10:26:14Z
Description	string	The execution's description.	MyDescription
LastTriggerTime	string	The last time the template was triggered.	2019-05-27T09:29:18Z
ParentExecutionId	string	The parent execution's ID.	exec-xxx
LastTriggerStatus	string	The status of the last triggered execution.	Success
StatusMessage	string	The status message of the execution.	“”
Outputs	string	The execution's outputs.	{ "InstanceId":"i-xxx" }
ExecutedBy	string	The user who initiated the execution.	1309252800
EndDate	string	The execution's end time.	2019-05-16T10:26:14Z
IsParent	boolean	Indicates whether the execution includes child tasks.	false
StartDate	string	The execution's start time.	2019-05-16T10:26:14Z
ExecutionId	string	The execution's unique ID.	exec-44d32b45d2a449e
Parameters	object	The execution's input parameters.	{ "Status":"Running" }
Counters	object	A collection of task counts, categorized by status.	{"Failed": 0,"Success": 1,"Total": 2}
ResourceGroupId	string	The resource group's ID.	rg-acfmxsn4m4******
Category	string	The category of the associated template. Valid values: Other, TimerTrigger, EventTrigger, and AlarmTrigger.	Other
TemplateId	string	The template's ID.	123
RamRole	string	The RAM role used to execute the template.	OOSServiceRole
ResourceStatus	string	The status of the target resources.	{ "Success": 1 }
CurrentTasks	array<object>	The tasks currently running.
	object
TaskExecutionId	string	The task execution ID.	task-exec-44d32b45d2a49899#1
TaskName	string	The task name.	installSLSILogtail
TaskAction	string	The task's action.	acs::Template
LastTriggerStatusMessage	string	The status message of the last triggered execution. For executions that are triggered by a timer, event, or alarm, this indicates the status of the most recent execution. For other types of executions, this value is the same as StatusMessage.	""
LastTriggerOutputs	string	The outputs of the last triggered execution. For executions that are triggered by a timer, event, or alarm, this indicates the outputs of the most recent execution. For other types of executions, this value is the same as Outputs.	{ "InstanceId": "i-xxx" }
NextScheduleTime	string	The next trigger time for a timer-triggered execution.	2019-05-16T10:26:14Z
AccountId	string	The ID of the owning account.	123456789
TotalCount	integer	The total number of executions.	30

Examples

Success response

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": "MyDescription",
      "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",
      "AccountId": "123456789"
    }
  ],
  "TotalCount": 30
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.