ListTasks - DataWorks - Alibaba Cloud Documentation Center

Queries a list of tasks by page. You can also specify filter conditions to query tasks.

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
ProjectEnv	string	No	The environment of the workspace. Valid values: Prod: production environment Dev: development environment	Prod
ProjectId	long	Yes	The workspace ID.	100
Name	string	No	The name of the task. Fuzzy match is supported.
Owner	string	No	The account ID of the task owner.	1000
TaskType	string	No	The type of the task.	ODPS_SQL
RuntimeResource	string	No	The information about the resource group. Set this parameter to the ID of a resource group for scheduling.	S_res_group_524258031846018_1684XXXXXXXXX
WorkflowId	long	No	The ID of the workflow to which the task belongs.	1234
TriggerType	string	No	The trigger type. Valid values: Scheduler: scheduling cycle-based trigger Manual: manual trigger	Scheduler
TriggerRecurrence	string	No	The running mode of the task 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 that is used to sort tasks. This parameter is configured in the format of "Sorting field Sorting order". You can set the sorting order to Desc or Asc. If you do not specify the sorting order, Asc is used by default. Valid values: `ModifyTime (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	The response parameters.
RequestId	string	The request ID.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries returned.	100
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
Tasks	array<object>	The tasks.
Task	object
Name	string	The name of the task.
Description	string	The description of the task.	test
WorkflowId	long	The ID of the workflow to which the task belongs.	1234
Type	string	The type of the task.	ODPS_SQL
BaselineId	long	The baseline ID.	1234
Priority	integer	The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.	1
Timeout	integer	The timeout period of task running. Unit: seconds.	3600
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 it is successfully run or fails to run.	AllAllowed
RerunTimes	integer	The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.	3
RerunInterval	integer	The rerun interval. Unit: seconds.	60
Trigger	object	The method to trigger task scheduling.
Type	string	The trigger type. Valid values: Scheduler: scheduling cycle-based trigger Manual: manual trigger	Scheduler
Recurrence	string	The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values: Pause Skip Normal	Normal
Cron	string	The CRON expression of the task. This parameter takes effect only if the Type parameter is set to Scheduler.	00 00 00 * * ?
StartTime	string	The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.	1970-01-01 00:00:00
EndTime	string	The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.	9999-01-01 00:00:00
RuntimeResource	object	The configurations of the runtime environment, such as the resource group information.
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 compute units (CUs) configured for task running.	0.25
DataSource	object	The information about the associated data source.
Name	string	The name of the data source.	mysql_test
Id	long	The task ID.	1234
TenantId	long	The tenant ID.	1
ProjectId	long	The 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 creator.	1000
ModifyUser	string	The account ID of the modifier.	1000

Examples

Sample success responses

JSONformat

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX\n",
  "PagingInfo": {
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1,
    "Tasks": [
      {
        "Name": "",
        "Description": "test\n",
        "WorkflowId": 1234,
        "InstanceMode": "T+1",
        "Type": "ODPS_SQL",
        "BaselineId": 1234,
        "Priority": 1,
        "Timeout": 3600,
        "RerunMode": "AllAllowed\n",
        "RerunTimes": 3,
        "RerunInterval": 60,
        "Trigger": {
          "Type": "Scheduler\n",
          "Recurrence": "Normal\n",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00\n",
          "EndTime": "9999-01-01 00:00:00\n"
        },
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx\n",
          "Cu": "0.25"
        },
        "DataSource": {
          "Name": "mysql_test\n"
        },
        "Id": 1234,
        "TenantId": 1,
        "ProjectId": 100,
        "ProjectEnv": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-20	The response structure of the API has changed	View Change Details