ListTaskInstances
Retrieve and filter task instances from Alibaba Cloud DataWorks using project IDs, task types, or workflow instance details to manage and monitor data workflows efficiently.
Instructions
获取任务实例列表
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| Bizdate | No | 业务日期。一般是周期实例定时时间的前一天的0点0分0秒,格式为毫秒级时间戳,如1743350400000 | |
| Id | No | 任务实例ID。任务实例存在重跑的情况,假如设置该参数,则返回包含重跑的历史信息,通过RunNumber区分每个历史信息 | |
| Ids | No | 任务实例ID列表,可根据任务实例Id批量查询多个任务实例信息 | |
| Owner | No | 任务的责任人的账号ID | |
| PageNumber | No | 页码,从1开始,默认为1 | |
| PageSize | No | 每页的条目数,默认为10 | |
| ProjectEnv | No | 项目环境。- Prod:生产- Dev:开发 | |
| ProjectId | No | 项目ID | |
| RuntimeResource | No | 资源组信息,这里请填入调度资源组标识符 | |
| SortBy | No | 排序字段。支持定时时间、开始时间等字段,格式为"排序字段+排序方式(Desc/Asc)"(Asc可以缺省)。排序字段的枚举值如下:- `TriggerTime (Desc/Asc)`- `StartedTime (Desc/Asc)`- `FinishedTime (Desc/Asc)`- `CreateTime (Desc/Asc)`- `Id (Desc/Asc)` 默认值:`Id Desc` | |
| TaskId | No | 对应任务的ID | |
| TaskIds | No | 对应任务的ID列表,可根据任务Id批量查询任务实例 | |
| TaskName | No | 对应任务的名称,支持模糊查询 | |
| TaskType | No | 任务类型。各节点的TaskType取值,请参见[DataWorks节点合集](~~600169~~) | |
| TriggerRecurrence | No | 触发时的运行模式,TriggerType=Scheduler时生效。- Pause:暂停- Skip:空跑- Normal:正常运行 | |
| TriggerType | No | 触发方式类型。- Scheduler:周期调度触发- Manual:手动触发 | |
| WorkflowId | No | 所属工作流的ID | |
| WorkflowInstanceId | No | 所属工作流实例的ID | |
| WorkflowInstanceType | No | 所属工作流实例的类型。- SmokeTest:测试- Manual:手动任务- SupplementData:补数据- ManualWorkflow:手动工作流- Normal:周期调度 |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"Bizdate": {
"description": "业务日期。一般是周期实例定时时间的前一天的0点0分0秒,格式为毫秒级时间戳,如1743350400000"
},
"Id": {
"description": "任务实例ID。任务实例存在重跑的情况,假如设置该参数,则返回包含重跑的历史信息,通过RunNumber区分每个历史信息"
},
"Ids": {
"description": "任务实例ID列表,可根据任务实例Id批量查询多个任务实例信息",
"type": "array"
},
"Owner": {
"description": "任务的责任人的账号ID",
"type": "string"
},
"PageNumber": {
"description": "页码,从1开始,默认为1"
},
"PageSize": {
"description": "每页的条目数,默认为10"
},
"ProjectEnv": {
"description": "项目环境。- Prod:生产- Dev:开发",
"type": "string"
},
"ProjectId": {
"description": "项目ID"
},
"RuntimeResource": {
"description": "资源组信息,这里请填入调度资源组标识符",
"type": "string"
},
"SortBy": {
"description": "排序字段。支持定时时间、开始时间等字段,格式为\"排序字段+排序方式(Desc/Asc)\"(Asc可以缺省)。排序字段的枚举值如下:- `TriggerTime (Desc/Asc)`- `StartedTime (Desc/Asc)`- `FinishedTime (Desc/Asc)`- `CreateTime (Desc/Asc)`- `Id (Desc/Asc)` 默认值:`Id Desc`",
"type": "string"
},
"TaskId": {
"description": "对应任务的ID"
},
"TaskIds": {
"description": "对应任务的ID列表,可根据任务Id批量查询任务实例",
"type": "array"
},
"TaskName": {
"description": "对应任务的名称,支持模糊查询",
"type": "string"
},
"TaskType": {
"description": "任务类型。各节点的TaskType取值,请参见[DataWorks节点合集](~~600169~~)",
"type": "string"
},
"TriggerRecurrence": {
"description": "触发时的运行模式,TriggerType=Scheduler时生效。- Pause:暂停- Skip:空跑- Normal:正常运行",
"type": "string"
},
"TriggerType": {
"description": "触发方式类型。- Scheduler:周期调度触发- Manual:手动触发",
"type": "string"
},
"WorkflowId": {
"description": "所属工作流的ID"
},
"WorkflowInstanceId": {
"description": "所属工作流实例的ID"
},
"WorkflowInstanceType": {
"description": "所属工作流实例的类型。- SmokeTest:测试- Manual:手动任务- SupplementData:补数据- ManualWorkflow:手动工作流- Normal:周期调度",
"type": "string"
}
},
"type": "object"
}