ListTaskInstances - DataWorks - Alibaba Cloud Documentation Center

Queries a list of instances. You can also specify filter conditions to query specific instances.

Operation description

This API operation is available for all DataWorks editions.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The DataWorks workspace ID.	100
Bizdate	long	Yes	The data timestamp.	1710239005403
TaskId	long	No	The ID of the task for which the instance is generated.	1234
TaskIds	array	No	The IDs of the tasks. You can query multiple instances at a time by task ID.
	long	No	The task ID.	1234
TaskName	string	No	The name of the task. Fuzzy match is supported.
Owner	string	No	The account ID of the task owner.	1000
TaskType	integer	No	The type of the task for which the instance is generated.	ODPS_SQL
RuntimeResource	string	No	The information about the resource group. Set this parameter to the identifier of a resource group for scheduling.	S_res_group_524258031846018_1684XXXXXXXXX
WorkflowId	long	No	The ID of the workflow to which the instance belongs.	1234
WorkflowInstanceType	string	No	The type of the workflow instance. Valid values: SmokeTest Manual SupplementData ManualWorkflow Normal	Normal
WorkflowInstanceId	long	No	The workflow instance ID.	1234
ProjectEnv	string	No	The environment of the workspace. Valid values: Prod: production environment Dev: development environment	Prod
Id	long	No	The ID of the instance. The instance may be rerun. If the instance is rerun and you configure this parameter, the system returns the historical information of the instance, including the rerun information. You can use the RunNumber parameter to distinguish each entry in the historical information.	1234
Ids	array	No	The IDs of the instances. You can query multiple instances at a time by instance ID.
	long	No	The ID of the instance.	1234
TriggerType	string	No	The trigger type. Valid values: Scheduler: scheduling cycle-based trigger Manual: manual trigger	Normal
TriggerRecurrence	string	No	The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values: Pause Skip Normal	Normal
SortBy	string	No	The field used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values: `TriggerTime (Desc/Asc)` `StartedTime (Desc/Asc)` `FinishedTime (Desc/Asc)` `CreateTime (Desc/Asc)` `Id (Desc/Asc)` Default value: `Id Desc`.	Id Desc
PageSize	integer	No	The number of entries per page. Default value: 10.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	The pagination information.
TaskInstances	array<object>	The instances.
TaskInstance	object
TaskId	long	The ID of the task for which the instance is generated.	1234
TaskType	string	The type of the task for which the instance is generated.	ODPS_SQL
TaskName	string	The name of the task for which the instance is generated.
Description	string	The description.	test
WorkflowId	long	The ID of the workflow to which the instance belongs.	1234
WorkflowName	string	The name of the workflow to which the instance belongs.
TriggerType	string	The trigger type. Valid values: Scheduler: scheduling cycle-based trigger Manual: manual trigger	Scheduler
TriggerRecurrence	string	The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values: Pause Skip Normal	Normal
WorkflowInstanceId	long	The workflow instance ID.	1234
WorkflowInstanceType	string	The type of the workflow instance. Valid values: SmokeTest SupplementData Manual ManualWorkflow Normal ManualFlow	Normal
Timeout	integer	The timeout period of task running. Unit: seconds. Note: The value of this parameter is rounded up by hour.	1
RerunMode	string	The rerun mode Valid values: AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run. FailureAllowed: The task can be rerun only after it fails to run. AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.	AllAllowed
RunNumber	integer	The number of times the task is run. By default, the value starts from 1.	1
PeriodNumber	integer	The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.	1
BaselineId	long	The baseline ID.	1234
Priority	integer	The priority of the task. Minimum value: 1. Maximum value: 8. A larger value indicates a higher priority. Default value: 1.	1
RuntimeResource	object	The information about the resource group with which the instance is associated.
ResourceGroupId	string	The ID of the resource group for scheduling configured for task running.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	The ID of the image configured for task running.	i-xxxxxx
Cu	string	The default number of CUs configured for task running.	0.25
Runtime	object	The runtime information about the instance.
ProcessId	string	The instance run ID.	T3_123
Gateway	string	The host for running.	cn-shanghai.1.2
DataSource	object	The information about the associated data source.
Name	string	The name of the data source.	mysql_test
Status	string	The status of the instance. Valid values: NotRun: The instance is not run. Running: The instance is running. WaitTime: The instance is waiting for the scheduling time to arrive. CheckingCondition: Branch conditions are being checked for the instance. WaitResource: The instance is waiting for resources. Failure: The instance fails to be run. Success: The instance is successfully run. Checking: Data quality is being checked for the instance.	Success
TriggerTime	long	The scheduling time.	1710239005403
Bizdate	long	The data timestamp.	1710239005403
StartedTime	long	The time when the instance started to run.	1710239005403
FinishedTime	long	The time when the instance finished running.	1710239005403
Id	long	The instance ID.	1234
TenantId	long	The tenant ID.	1
ProjectId	long	The DataWorks workspace ID.	100
ProjectEnv	string	The environment of the workspace. Valid values: Prod: production environment Dev: development environment	Prod
Owner	string	The account ID of the task owner.	1000
CreateTime	long	The creation time.	1710239005403
ModifyTime	long	The modification time.	1710239005403
CreateUser	string	The account ID of the user who creates the instance.	1000
ModifyUser	string	The account ID of the user who modifies the instance.	1000
TotalCount	integer	The total number of entries returned.	100
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "PagingInfo": {
    "TaskInstances": [
      {
        "TaskId": 1234,
        "TaskType": "ODPS_SQL\n",
        "TaskName": "",
        "Description": "test\n",
        "WorkflowId": 1234,
        "WorkflowName": "",
        "TriggerType": "Scheduler\n",
        "TriggerRecurrence": "Normal\n",
        "WorkflowInstanceId": 1234,
        "WorkflowInstanceType": "Normal",
        "Timeout": 1,
        "RerunMode": "AllAllowed\n",
        "RunNumber": 1,
        "PeriodNumber": 1,
        "BaselineId": 1234,
        "Priority": 1,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx\n",
          "Cu": "0.25\n"
        },
        "Runtime": {
          "ProcessId": "T3_123\n",
          "Gateway": "cn-shanghai.1.2\n"
        },
        "DataSource": {
          "Name": "mysql_test\n"
        },
        "Status": "Success",
        "TriggerTime": 1710239005403,
        "Bizdate": 1710239005403,
        "StartedTime": 1710239005403,
        "FinishedTime": 1710239005403,
        "Id": 1234,
        "TenantId": 1,
        "ProjectId": 100,
        "ProjectEnv": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000"
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-21	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-11-20	The request parameters of the API has changed. The response structure of the API has changed	View Change Details