Use ListTaskExecutions to query task executions - CloudOps Orchestration Service

Queries task executions using 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: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 to filter by. Valid values: `Running`, `Started`, `Success`, `Failed`, `Waiting`, `Cancelled`, `Pending`, and `Skipped`.	Running
StartDateBefore	string	No	Filters for executions that started on or before the specified time. The time must be in ISO 8601 format.	2019-05-16T10:26:14Z
StartDateAfter	string	No	Filters for executions that started on or after the specified time. The time must be in ISO 8601 format.	2019-05-16T10:26:14Z
EndDateBefore	string	No	Filters for executions that ended on or before the specified time. The time must be in ISO 8601 format.	2019-05-16T10:26:14Z
EndDateAfter	string	No	Filters for executions that ended on or after the specified time. The time must be in ISO 8601 format.	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. This parameter is used in loop scenarios to specify the execution of the parent task.	task-exec-xxx
IncludeChildTaskExecution	boolean	No	Specifies whether to include child task executions that are generated by a loop. Default: `false`.	false
MaxResults	integer	No	The maximum number of items to return per page. Valid range: 20 to 100. Default: 50.	50
NextToken	string	No	The token to request the next page of results. You can get this value from the `NextToken` parameter of the previous response.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB
SortField	string	No	The sort field for the results. Valid values: StartDate (Default): Sorts the results by start date. EndDate: Sorts the results by end date. Status: Sorts the results by status.	StartDate
SortOrder	string	No	The sort order for the results. Valid values: Ascending: Sorts results in ascending order. Descending (Default): Sorts results in descending order.	Ascending

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token used to retrieve the next page of results.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB
RequestId	string	The ID of the request.	CDABABABAB-FC28-4D9C-8FB5-68DC6F0486FC
MaxResults	integer	The maximum number of entries to return on each page.	50
TaskExecutions	array<object>	The details of the task executions.
	array<object>
ChildExecutionId	string	The ID of the child execution.	exec-xxx
Outputs	string	The output of the task execution.	{ "InstanceId":"i-xxx" }
Status	string	The status of the task execution.	Running
EndDate	string	The time the task execution ended, in ISO 8601 format.	2019-05-16T10:26:14Z
ParentTaskExecutionId	string	The ID of the parent task execution.	task-exec-xxx
TaskName	string	The name of the task.	describeInstance
StartDate	string	The time the task execution started, in ISO 8601 format.	2019-05-16T10:26:14Z
LoopItem	string	The current item in a loop.	i-1234566zxcvvb
CreateDate	string	The time the task execution was created, in ISO 8601 format.	2019-05-16T10:26:14Z
ExecutionId	string	The ID of the execution.	exec-44d32b45d2a449e49899
TaskAction	string	The action of the task.	ACS::Sleep
TaskExecutionId	string	The ID of the task execution.	task-exec-xxx
UpdateDate	string	The time the task execution was last updated, in ISO 8601 format.	2019-05-16T10:26:14Z
Loop	object	The loop configurations and statistics. This parameter is returned only for parent loop nodes.	{}
TemplateId	string	The ID of the template.	xxx
LoopBatchNumber	integer	The number of loop batches.	2
StatusMessage	string	The status message.	""
ExtraData	object	The extra data.	{ "NotifyNote":"" }
Properties	string	The input parameters of the 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.