ListTaskInstances - 获取任务实例列表 - 大数据开发治理平台 DataWorks

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

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ProjectId	long	是	项目 ID。	100
Bizdate	long	是	业务日期。	1710239005403
TaskId	long	否	对应任务的 ID。	1234
TaskIds	array	否	对应任务的 ID 列表，可根据任务 Id 批量查询任务实例。
	long	否	任务 ID。	1234
TaskName	string	否	对应任务的名称，支持模糊查询。	SQL节点
Owner	string	否	任务的责任人的账号 ID。	1000
TaskType	string	否	任务类型。	ODPS_SQL
RuntimeResource	string	否	资源组信息，这里请填入调度资源组标识符。	S_res_group_524258031846018_1684XXXXXXXXX
WorkflowId	long	否	所属工作流的 ID。	1234
WorkflowInstanceType	string	否	所属工作流实例的类型。枚举值： SmokeTest：测试。 Manual：手动任务。 SupplementData：补数据。 ManualWorkflow：手动工作流。 Normal：周期调度。	Normal
WorkflowInstanceId	long	否	所属工作流实例的 ID。	1234
ProjectEnv	string	否	项目环境。枚举值： Prod：生产。 Dev：开发。	Prod
Id	long	否	任务实例 ID。任务实例存在重跑的情况，假如设置该参数，则返回包含重跑的历史信息，通过 RunNumber 区分每个历史信息。	1234
Ids	array	否	任务实例 ID 列表，可根据任务实例 Id 批量查询多个任务实例信息。
	long	否	任务实例 ID。	1234
TriggerType	string	否	触发方式类型。枚举值： Scheduler：周期调度触发。 Manual：手动触发。	Normal
TriggerRecurrence	string	否	触发时的运行模式，TriggerType=Scheduler 时生效。枚举值： Pause：暂停。 Skip：空跑。 Normal：正常运行。	Normal
SortBy	string	否	排序字段。支持定时时间、开始时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（Asc 可以缺省）。排序字段的枚举值如下： `TriggerTime (Desc/Asc)` `StartedTime (Desc/Asc)` `FinishedTime (Desc/Asc)` `CreateTime (Desc/Asc)` `Id (Desc/Asc)` 默认值：`Id Desc`	Id Desc
PageSize	integer	否	每页的条目数，默认为 10。	10
PageNumber	integer	否	页码，从 1 开始，默认为 1。	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求的 ID，用于定位日志，排查问题。	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	分页信息。
TaskInstances	array<object>	任务实例列表。
TaskInstance	object
TaskId	long	对应任务的 ID。	1234
TaskType	string	对应任务的类型。	ODPS_SQL
TaskName	string	对应任务的名称。	SQL节点
Description	string	描述信息。	test
WorkflowId	long	所属工作流的 ID。	1234
WorkflowName	string	所属工作流的名称。	Test工作流
TriggerType	string	触发方式类型。枚举值： Scheduler：调度周期触发。 Manual：手动触发。	Scheduler
TriggerRecurrence	string	触发时的运行模式。TriggerType=Scheduler 时生效。枚举值： Pause：暂停。 Skip：空跑。 Normal：正常运行。	Normal
WorkflowInstanceId	long	所属工作流实例的 ID。	1234
WorkflowInstanceType	string	所属工作流实例的类型。枚举值： SmokeTest：测试。 SupplementData：补数据。 Manual：手动。 ManualWorkflow：手动工作流。 Normal：周期调度。 ManualFlow：手动执行的业务流程。	Normal
Timeout	integer	任务执行超时时间，单位为秒。注意：调度系统会对任务的设定值按小时取整。	3600
RerunMode	string	任务是否允许重跑的配置。枚举值： AllDenied：失败或成功都不可重跑。 FailureAllowed：只有失败可重跑。 AllAllowed：失败或成功均可重跑。	AllAllowed
RunNumber	integer	当前运行的次数，默认从 1 开始。	1
PeriodNumber	integer	周期序号。表示任务实例处于当天的第几轮周期。	1
BaselineId	long	基线 ID。	1234
Priority	integer	任务运行优先级，最小值 1，最大值 8。取值越大，优先级越高。默认优先级为 1。	1
RuntimeResource	object	实例关联资源组信息。
ResourceGroupId	string	任务运行配置的调度资源组标识符。	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	任务运行配置的镜像 ID。	i-xxxxxx
Cu	string	任务运行配置 CU 消耗。	0.25
Runtime	object	实例运行时信息。
ProcessId	string	运行唯一 ID。	T3_123
Gateway	string	运行机器。	cn-shanghai.1.2
DataSource	object	实例关联数据源信息。
Name	string	数据源名称。	mysql_test
Status	string	实例运行状态。枚举值： NotRun：未运行。 Running：运行中。 WaitTime：等待TriggerTime到来。 CheckingCondition：分支条件检验。 WaitResource：等待资源。 Failure：执行失败。 Success：执行成功。 Checking：下发给数据质量校检。	Success
TriggerTime	long	定时触发时间。	1710239005403
Bizdate	long	业务日期。	1710239005403
StartedTime	long	开始运行时间。	1710239005403
FinishedTime	long	完成时间。	1710239005403
Id	long	任务实例的唯一标识符。	1234
TenantId	long	租户 ID。	1
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
TotalCount	integer	数据总条数。	100
PageSize	integer	每页的条目数。	10
PageNumber	integer	页码。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "PagingInfo": {
    "TaskInstances": [
      {
        "TaskId": 1234,
        "TaskType": "ODPS_SQL\n",
        "TaskName": "SQL节点\n",
        "Description": "test\n",
        "WorkflowId": 1234,
        "WorkflowName": "Test工作流\n",
        "TriggerType": "Scheduler\n",
        "TriggerRecurrence": "Normal\n",
        "WorkflowInstanceId": 1234,
        "WorkflowInstanceType": "Normal",
        "Timeout": 3600,
        "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
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-11-21	API 内部配置变更，不影响调用	查看变更详情
2024-11-20	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情