ListTaskInstances_大数据开发治理平台 DataWorks_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dataworks:ListTaskInstances
Get
TaskInstance
acs:dataworks:{#regionId}:{#accountId}:taskinstance/*

请求参数

字段名称字段详情
ProjectIdinteger<int64>

项目 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:100 参考取值来源:
    CreateProject
Bizdateinteger<int64>

业务日期。一般是周期实例定时时间的前一天的 0 点 0 分 0 秒,格式为毫秒级时间戳,如 1743350400000。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1710239005403
TaskIdinteger<int64>

对应任务的 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1234参考取值来源:
    GetTask
TaskIdsarray<integer<int64>>

对应任务的 ID 列表,可根据任务 Id 批量查询任务实例。

TaskNamestring

对应任务的名称,支持模糊查询。

示例值:SQL node参考取值来源:
    GetTaskInstance
    ListUpstreamTaskInstances
Ownerstring

任务的责任人的账号 ID。

示例值:1000
TaskTypestring

任务类型。各节点的 TaskType 取值,请参见 DataWorks 节点合集

示例值:ODPS_SQL参考取值来源:
    GetTaskInstance
RuntimeResourcestring

资源组信息,这里请填入调度资源组标识符。

示例值:S_res_group_524258031846018_1684XXXXXXXXX
WorkflowIdinteger<int64>

所属工作流的 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1234 参考取值来源:
    GetWorkflow
    ListWorkflowInstances
    CreateWorkflowInstances
    ExecuteAdhocWorkflowInstance
WorkflowInstanceTypestring

所属工作流实例的类型。展开详情

示例值:Normal 枚举值:NormalManualWorkflowManualSupplementDataSmokeTest参考取值来源:
    GetTaskInstance
    ListDownstreamTaskInstances
WorkflowInstanceIdinteger<int64>

所属工作流实例的 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1234参考取值来源:
    ExecuteAdhocWorkflowInstance
    GetCreateWorkflowInstancesResult
    ListDownstreamTaskInstances
ProjectEnvstring

项目环境。展开详情

示例值:Prod枚举值:ProdDev
Idinteger<int64>

任务实例 ID。任务实例存在重跑的情况,假如设置该参数,则返回包含重跑的历史信息,通过 RunNumber 区分每个历史信息。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1234
Idsarray<integer<int64>>

任务实例 ID 列表,可根据任务实例 Id 批量查询多个任务实例信息。

TriggerTypestring

触发方式类型。展开详情

示例值:Normal 枚举值:SchedulerManual
TriggerRecurrencestring

触发时的运行模式,TriggerType=Scheduler 时生效。展开详情

示例值:Normal枚举值:NormalSkipPause
SortBystring

排序字段。支持定时时间、开始时间等字段,格式为"排序字段+排序方式(Desc/Asc)"(Asc 可以缺省)。排序字段的枚举值如下:展开详情

示例值:Id Desc
PageSizeinteger<int32>

每页的条目数,默认为 10。

示例值:10
PageNumberinteger<int32>

页码,从 1 开始,默认为 1。

示例值:1

返回参数

字段名称字段详情
RequestIdstring

请求的 ID,用于定位日志,排查问题。

示例值:22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfoobject

分页信息。

返回示例

变更历史

变更时间变更内容概要操作
2025-01-21
变更返回参数
2024-11-21
变更请求参数TaskType
2024-11-20
新增请求参数TriggerType
新增请求参数TriggerRecurrence
变更返回参数

相关示例