Use ListTaskExecutions to query task executions - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Queries task executions with support for multiple filter options.

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:ListTaskExecutions

get

*Execution

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

oos:tag
oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
ExecutionId	string	No	The execution ID.	exec-xxx
Status	string	No	The execution status. Valid values: Running, Started, Success, Failed, Waiting, Cancelled, Pending, Skipped.	Running
StartDateBefore	string	No	The executions whose start time is less than or equal to the specified time.	2019-05-16T10:26:14Z
StartDateAfter	string	No	The executions whose start time is greater than or equal to the specified time.	2019-05-16T10:26:14Z
EndDateBefore	string	No	The executions whose end time is less than or equal to the specified time.	2019-05-16T10:26:14Z
EndDateAfter	string	No	The executions whose end time is greater than or equal to the specified time.	2019-05-16T10:26:14Z
TaskExecutionId	string	No	The task execution ID.	task-exec-xxx
TaskName	string	No	The task name.	describeInstance
TaskAction	string	No	The task action.	ACS::Sleep
ParentTaskExecutionId	string	No	The parent task execution ID. Used in loop scenarios, typically the TaskExecutionId of the parent of a loop task.	task-exec-xxx
IncludeChildTaskExecution	boolean	No	Specifies whether to display child tasks generated by a loop task. Default value: False.	false
MaxResults	integer	No	The page size. Valid values: 20 to 100. Default value: 50.	50
NextToken	string	No	The pagination token used to retrieve the next page of results.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB
SortField	string	No	The sort field. Valid values: StartDate (default): creation time EndDate: end time Status: status	StartDate
SortOrder	string	No	The sort order. Valid values: Ascending: ascending order Descending (default): descending order	Ascending
AccountId	string	No		123456789

Response elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token used to retrieve the next page of results.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB
RequestId	string	The request ID.	CDABABABAB-FC28-4D9C-8FB5-68DC6F0486FC
MaxResults	integer	The page size.	50
TaskExecutions	array<object>	The task execution data.
	array<object>
ChildExecutionId	string	The child task execution ID.	exec-xxx
Outputs	string	The execution output results.	{ "InstanceId":"i-xxx" }
Status	string	The task status.	Running
EndDate	string	The end time.	2019-05-16T10:26:14Z
ParentTaskExecutionId	string	The parent task execution ID.	task-exec-xxx
TaskName	string	The task name.	describeInstance
StartDate	string	The start time.	2019-05-16T10:26:14Z
LoopItem	string	The element in the loop.	i-1234566zxcvvb
CreateDate	string	The time when the task execution was created.	2019-05-16T10:26:14Z
ExecutionId	string	The execution ID.	exec-44d32b45d2a449e49899
TaskAction	string	The task action.	ACS::Sleep
TaskExecutionId	string	The task execution ID.	task-exec-xxx
UpdateDate	string	The time when the task execution was last updated.	2019-05-16T10:26:14Z
Loop	object	The loop configuration and statistics information. This field is available only for loop parent nodes.	{}
TemplateId	string	The template ID.	xxx
LoopBatchNumber	integer	The loop batch number.	2
StatusMessage	string	The status message.	""
ExtraData	object	The additional data.	{ "NotifyNote":"" }
Properties	string	The input parameters of the task execution.	{ "Status":"Running" }

Examples

Success response

JSON format

{
  "NextToken": "MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB",
  "RequestId": "CDABABABAB-FC28-4D9C-8FB5-68DC6F0486FC",
  "MaxResults": 50,
  "TaskExecutions": [
    {
      "ChildExecutionId": "exec-xxx",
      "Outputs": "{ \"InstanceId\":\"i-xxx\" }",
      "Status": "Running",
      "EndDate": "2019-05-16T10:26:14Z",
      "ParentTaskExecutionId": "task-exec-xxx",
      "TaskName": "describeInstance\t",
      "StartDate": "2019-05-16T10:26:14Z",
      "LoopItem": "i-1234566zxcvvb",
      "CreateDate": "2019-05-16T10:26:14Z",
      "ExecutionId": "exec-44d32b45d2a449e49899",
      "TaskAction": "ACS::Sleep",
      "TaskExecutionId": "task-exec-xxx",
      "UpdateDate": "2019-05-16T10:26:14Z",
      "Loop": {},
      "TemplateId": "xxx",
      "LoopBatchNumber": 2,
      "StatusMessage": "\"\"",
      "ExtraData": {
        "NotifyNote": ""
      },
      "Properties": "{ \"Status\":\"Running\" }"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.