分页获取任务实例列表，也可以通过条件进行筛选查询。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:ListTaskInstances | get | *TaskInstance acs:dataworks:{#regionId}:{#accountId}:taskinstance/* |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectId | long | 是 | 项目 ID。 | 100 |
| Bizdate | long | 是 | 业务日期。一般是周期实例定时时间的前一天的 0 点 0 分 0 秒，格式为毫秒级时间戳，如 1743350400000。 | 1710239005403 |
| TaskId | long | 否 | 对应任务的 ID。 | 1234 |
| TaskIds | array | 否 | 对应任务的 ID 列表，可根据任务 Id 批量查询任务实例。 | |
| long | 否 | 任务 ID。 | 1234 | |
| TaskName | string | 否 | 对应任务的名称，支持模糊查询。 | SQL node |
| Owner | string | 否 | 任务的责任人的账号 ID。 | 1000 |
| TaskType | string | 否 | 任务类型。各节点的 TaskType 取值，请参见 DataWorks 节点合集。 | ODPS_SQL |
| RuntimeResource | string | 否 | 资源组信息，这里请填入调度资源组标识符。 | S_res_group_524258031846018_1684XXXXXXXXX |
| WorkflowId | long | 否 | 所属工作流的 ID。 | 1234 |
| WorkflowInstanceType | string | 否 | 所属工作流实例的类型。
| Normal |
| WorkflowInstanceId | long | 否 | 所属工作流实例的 ID。 | 1234 |
| ProjectEnv | string | 否 | 项目环境。
| Prod |
| Id | long | 否 | 任务实例 ID。任务实例存在重跑的情况，假如设置该参数，则返回包含重跑的历史信息，通过 RunNumber 区分每个历史信息。 | 1234 |
| Ids | array | 否 | 任务实例 ID 列表，可根据任务实例 Id 批量查询多个任务实例信息。 | |
| long | 否 | 任务实例 ID。 | 1234 | |
| TriggerType | string | 否 | 触发方式类型。
| Normal |
| TriggerRecurrence | string | 否 | 触发时的运行模式，TriggerType=Scheduler 时生效。
| Normal |
| SortBy | string | 否 | 排序字段。支持定时时间、开始时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（Asc 可以缺省）。排序字段的枚举值如下：
| Id Desc |
| PageSize | integer | 否 | 每页的条目数，默认为 10，最大为 500。 | 10 |
| PageNumber | integer | 否 | 页码，从 1 开始，默认为 1。 | 1 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
"PagingInfo": {
"TaskInstances": [
{
"TaskId": 1234,
"TaskType": "ODPS_SQL\n",
"TaskName": "SQL node\n",
"Description": "test\n",
"WorkflowId": 1234,
"WorkflowName": "Test workflow\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
},
"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,
"ProjectId": 100,
"ProjectEnv": "Prod",
"Owner": 1000,
"CreateTime": 1710239005403,
"ModifyTime": 1710239005403,
"CreateUser": 1000,
"ModifyUser": 1000
}
],
"TotalCount": 100,
"PageSize": 10,
"PageNumber": 1
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-01-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-11-21 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2024-11-20 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |