ListTaskExecutions - CloudOps Orchestration Service - Alibaba Cloud Documentation Center

Queries task executions. Multiple methods are supported to filter task executions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:ListTaskExecutions	get	Execution acs:oos:{#regionId}:{#accountId}:execution/{#executionId}	oos:tag	none

Request syntax

POST /ListTaskExecutions HTTP/1.1
GET /ListTaskExecutions HTTP/1.1
POST /ListTaskExecutions HTTP/1.1
GET /ListTaskExecutions HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the execution.	cn-hangzhou
ExecutionId	string	No	The status of the execution. Valid values: Running, Started, Success, Failed, Waiting, Cancelled, Pending, and Skipped.	exec-xxx
Status	string	No	Specifies to query task executions that start to run at or before the specified time.	Running
StartDateBefore	string	No	Specifies to query task executions that start to run at or later than the specified time.	2019-05-16T10:26:14Z
StartDateAfter	string	No	Specifies to query task executions that stop running at or before the specified time.	2019-05-16T10:26:14Z
EndDateBefore	string	No	Specifies to query task executions that stop running at or later than the specified time.	2019-05-16T10:26:14Z
EndDateAfter	string	No	The execution ID of the task.	2019-05-16T10:26:14Z
TaskExecutionId	string	No	The name of the task.	task-exec-xxx
TaskName	string	No	The action of the task.	describeInstance
TaskAction	string	No	The execution ID of the parent node. In a loop task, set this parameter to the execution ID of the parent node.	ACS::Sleep
ParentTaskExecutionId	string	No	Specifies whether to show the child nodes in the loop task. Default value: False.	task-exec-xxx
IncludeChildTaskExecution	boolean	No	The number of entries to return on each page. Valid values: 20 to 100. Default value: 50.	false
MaxResults	integer	No	The token that is used to retrieve the next page of results.	50
NextToken	string	No	Sorts the task executions to query. Valid values: StartDate: specifies that the task executions are sorted based on the time when they are created. This is the default value. EndDate: specifies that the task executions are sorted based on the time when the time when they stop running. Status: specifies that the task executions are sorted based on their statuses.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB
SortField	string	No	The order in which you want to sort the task executions to query. Valid values: Ascending: ascending order. Descending: descending order. This is the default value.	StartDate
SortOrder	string	No	The token that is used to retrieve the next page of results.	Ascending

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	The ID of the request.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB
RequestId	string	The number of entries returned on each page.	CDABABABAB-FC28-4D9C-8FB5-68DC6F0486FC
MaxResults	integer	The details of the task executions.	50
TaskExecutions	array<object>	The execution ID of the child node.
TaskExecution	object
ChildExecutionId	string	The output of the execution.	exec-xxx
Outputs	string	The status of the task.	{ "InstanceId":"i-xxx" }
Status	string	The time when the task execution stopped running.	Running
EndDate	string	The execution ID of the parent node.	2019-05-16T10:26:14Z
ParentTaskExecutionId	string	The name of the task.	task-exec-xxx
TaskName	string	The time when the execution started.	describeInstance
StartDate	string	The elements in the loop task.	2019-05-16T10:26:14Z
LoopItem	string	The time when the execution was created.	i-1234566zxcvvb
CreateDate	string	The ID of the execution.	2019-05-16T10:26:14Z
ExecutionId	string	The action of the task.	exec-44d32b45d2a449e49899
TaskAction	string	The execution ID of the task.	ACS::Sleep
TaskExecutionId	string	The time when the execution was last updated.	task-exec-xxx
UpdateDate	string	The configuration and statistics information of the loop task. This parameter is returned only for the parent node of the loop task.	2019-05-16T10:26:14Z
Loop	object	The ID of the template.	{}
TemplateId	string	The number of times for which the loop task is run.	xxx
LoopBatchNumber	integer	The status information of the task execution.	2
StatusMessage	string	The additional information.	""
ExtraData	object	The Input parameters of the task execution.	{ "NotifyNote":"" }
Properties	string	Queries task executions. Multiple methods are supported to filter task executions.	{ "Status":"Running" }

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-08-15	The internal configuration of the API is changed, but the call is not affected	View Change Details