Retrieve Paginated Task Lists via ListTasks API - DataWorks - Alibaba Cloud - DataWorks

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

Operation description

DataWorks Basic Edition or higher is required.

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

dataworks:*

get

*Task

acs:dataworks:{#regionId}:{#accountId}:task/*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectEnv	string	No	The workspace environment. Valid values: Prod Dev Valid values: Prod : Dev :	Prod
ProjectId	integer	Yes	The workspace ID.	100
Name	string	No	The name of the task. Fuzzy match is supported.	SQL node
Ids	array	No	The ID of the task.
	integer	No	The account ID of the owner of the task.	1234
Owner	string	No	The account ID of the task owner.	1000
TaskType	string	No	The type of the task. Valid values: ODPS_SQL SPARK PY_ODPS PY_ODPS3 ODPS_SCRIPT ODPS_MR COMPONENT_SQL EMR_HIVE EMR_MR EMR_SPARK_SQL EMR_SPARK EMR_SHELL EMR_PRESTO EMR_IMPALA SPARK_STREAMING EMR_KYUUBI EMR_TRINO HOLOGRES_SQL HOLOGRES_SYNC_DDL HOLOGRES_SYNC_DATA	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	integer	No	The ID of the workflow to which the task belongs.	1234
TriggerType	string	No	The trigger type. Valid values: Scheduler: Triggered by schedule. Manual: Triggered manually. Valid values: Scheduler : Manual :	Scheduler
TriggerRecurrence	string	No	The run mode when triggered. Valid only if TriggerType is Scheduler. Valid values: Pause Skip Normal 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 elements

Element	Type	Description	Example
	object	ResultModel
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.
	array<object>
Name	string	The name of the task.	SQL node
Description	string	The description of the task.	test
WorkflowId	integer	The ID of the workflow to which the task belongs.	1234
InstanceMode	string	The instance generation mode. Valid values: T+1 Immediately	T+1
Type	string	The type of the task.	ODPS_SQL
BaselineId	integer	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. Valid values: AllDenied : FailureAllowed : AllAllowed :	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 Valid values: Scheduler : Manual :	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 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	integer	The task ID.	1234
ProjectId	integer	The workspace ID.	100
ProjectEnv	string	The environment of the workspace. Valid values: Prod: production environment Dev: development environment Valid values: Prod : Dev :	Prod
Owner	string	The account ID of the task owner.	1000
CreateTime	integer	The creation time.	1710239005403
ModifyTime	integer	The modification time.	1710239005403
CreateUser	string	The account ID of the creator.	1000
ModifyUser	string	The account ID of the modifier.	1000
ScriptParameters	string	The list of script parameters.	para1=$bizdate para2=$[yyyymmdd]

Examples

Success response

JSON format

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX\n",
  "PagingInfo": {
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1,
    "Tasks": [
      {
        "Name": "SQL node\n",
        "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,
        "ProjectId": 100,
        "ProjectEnv": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000",
        "ScriptParameters": "para1=$bizdate para2=$[yyyymmdd] "
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.