ListTasks - 获取任务列表_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

分页获取任务列表，也可以通过条件进行筛选查询。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dataworks:*	get	Task `acs:dataworks:{#regionId}:{#accountId}:task/`	无	无

请求参数

名称	类型	必填	描述	示例值
ProjectEnv	string	否	项目环境。枚举值： Prod：生产。 Dev：开发。	Prod
ProjectId	long	是	项目 ID。	100
Name	string	否	名称，支持模糊查询。	SQL node
Ids	array	否	任务的 ID 列表，可根据任务 Id 批量查询任务。
	long	否	任务 ID。	1234
Owner	string	否	任务的责任人的账号 ID。	1000
TaskType	string	否	任务类型。例如： 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	否	资源组信息，这里请填入调度资源组标识符。	S_res_group_524258031846018_1684XXXXXXXXX
WorkflowId	long	否	所属工作流的 ID。	1234
TriggerType	string	否	触发方式类型。枚举值： Scheduler：调度周期触发。 Manual：手动触发。	Scheduler
TriggerRecurrence	string	否	触发时的运行模式，TriggerType=Scheduler 时生效。枚举值： Pause：暂停。 Skip：空跑。 Normal：正常运行。	Normal
SortBy	string	否	排序字段。支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（Asc 可以缺省）。排序字段的枚举值如下： `ModifyTime (Desc/Asc)` `CreateTime (Desc/Asc)` `Id (Desc/Asc)` 默认值：`Id Desc`	Id Desc
PageSize	integer	否	每页的条目数，默认为 10，最大为 1000。	10
PageNumber	integer	否	页码，从 1 开始，默认为 1。	1

返回参数

名称	类型	描述	示例值
	object	ResultModel
RequestId	string	请求的 ID，用于定位日志，排查问题。	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	分页信息。
TotalCount	integer	数据总条数。	100
PageSize	integer	每页的条目数。	10
PageNumber	integer	页码。	1
Tasks	array<object>	任务列表。
Task	object
Name	string	名称。	SQL node
Description	string	描述信息。	test
WorkflowId	long	所属工作流的 ID。	1234
InstanceMode	string	实例生成模式。 T+1（第二天生成） Immediately（立即生成）	T+1
Type	string	任务类型。	ODPS_SQL
BaselineId	long	基线 ID。	1234
Priority	integer	任务优先级，最小值 1，最大值 8。取值越大，优先级越高。默认优先级为 1。	1
Timeout	integer	任务执行超时时间，单位秒。	3600
RerunMode	string	任务是否允许重跑的配置。枚举值： AllDenied：失败或成功都不可重跑。 FailureAllowed：只有失败可重跑。 AllAllowed：失败或成功均可重跑。	AllAllowed
RerunTimes	integer	重试次数，当任务设置为可重跑时生效。	3
RerunInterval	integer	重试时间间隔，单位秒。	60
Trigger	object	任务触发方式。
Type	string	触发方式类型。枚举值： Scheduler：调度周期触发。 Manual：手动触发。	Scheduler
Recurrence	string	触发时的运行模式，type=Scheduler 时生效。枚举值： Pause：暂停。 Skip：空跑。 Normal：正常运行。	Normal
Cron	string	Cron 表达式，type=Scheduler 时生效。	00 00 00 * * ?
StartTime	string	周期触发生效时间，type=Scheduler 时生效。	1970-01-01 00:00:00
EndTime	string	周期触发失效时间，type=Scheduler 时生效。	9999-01-01 00:00:00
RuntimeResource	object	运行环境配置，如资源组信息。
ResourceGroupId	string	任务运行配置的调度资源组标识符。	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	任务运行配置的镜像 ID。	i-xxxxxx
Cu	string	任务运行配置 CU 消耗。	0.25
DataSource	object	关联数据源信息。
Name	string	数据源名称。	mysql_test
Id	long	任务的唯一标识符。	1234
ProjectId	long	项目 ID。	100
ProjectEnv	string	项目环境。枚举值： Prod：生产。 Dev：开发。	Prod
Owner	string	任务的责任人的账号 ID。	1000
CreateTime	long	创建时间。	1710239005403
ModifyTime	long	修改时间。	1710239005403
CreateUser	string	创建用户的账号 ID。	1000
ModifyUser	string	修改用户的账号 ID。	1000
ScriptParameters	string	脚本参数列表。	para1=$bizdate para2=$[yyyymmdd]

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-01-21	OpenAPI 返回结构发生变更	查看变更详情
2025-01-15	OpenAPI 入参发生变更	查看变更详情
2025-01-06	OpenAPI 返回结构发生变更	查看变更详情
2024-11-20	OpenAPI 返回结构发生变更	查看变更详情