全部产品
Search
文档中心

大数据开发治理平台 DataWorks:ListUpstreamTasks - 获取上游任务列表

更新时间:Dec 09, 2024

分页获取指定任务的上游任务列表。

接口说明

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
ProjectEnvstring

项目环境。

枚举值:
  • Prod生产
  • Dev开发
Prod
Idlong

任务 ID。

1234
PageSizeinteger

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

10
PageNumberinteger

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

1

返回参数

名称类型描述示例值
object
RequestIdstring

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

22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfoobject

分页信息。

Tasksarray<object>

任务列表。

Taskobject
Namestring

名称。

SQL节点
Descriptionstring

描述信息。

test
WorkflowIdlong

所属工作流的 ID。

1234
InstanceModestring

实例生成模式。

T+1(第二天生成)

Immediately(立即生成)

T+1
Typestring

任务类型。

ODPS_SQL
BaselineIdlong

基线 ID。

1234
Priorityinteger

任务优先级,最小值 1,最大值 8。取值越大,优先级越高。默认优先级为 1。

1
Timeoutinteger

任务执行超时时间,单位秒。

3600
RerunModestring

任务是否允许重跑的配置。

枚举值:
  • AllDenied失败或成功都不可重跑
  • FailureAllowed只有失败可重跑
  • AllAllowed失败或成功均可重跑
AllAllowed
RerunTimesinteger

重试次数,当任务设置为可重跑时生效。

3
RerunIntervalinteger

重试时间间隔,单位秒。

60
Triggerobject

任务触发方式。

Typestring

触发方式类型。

枚举值:
  • Scheduler调度周期触发
  • Manual手动触发
Scheduler
Recurrencestring

触发时的运行模式,type=Scheduler 时生效。

枚举值:
  • Pause暂停
  • Skip空跑
  • Normal正常运行
Normal
Cronstring

Cron 表达式,type=Scheduler 时生效。

00 00 00 * * ?
StartTimestring

周期触发生效时间,type=Scheduler 时生效。

1970-01-01 00:00:00
EndTimestring

周期触发失效时间,type=Scheduler 时生效。

9999-01-01 00:00:00
Timezonestring

时区。

Asia/Shanghai
RuntimeResourceobject

运行环境配置,如资源组信息。

ResourceGroupIdstring

任务运行配置的调度资源组标识符。

S_res_group_524258031846018_1684XXXXXXXXX
Imagestring

任务运行配置的镜像 ID。

i-xxxxxx
Custring

任务运行配置 CU 消耗。

0.25
DataSourceobject

关联数据源信息。

Namestring

数据源名称。

mysql_test
Idlong

任务的唯一标识符。

1234
TenantIdlong

租户 ID。

1
ProjectIdlong

项目 ID。

100
ProjectEnvstring

项目环境。

枚举值:
  • Prod生产
  • Dev开发
Prod
Ownerstring

任务的责任人的账号 ID。

1000
StepTypestring

依赖类型。

Normal(同周期依赖)

CrossCycle(跨周期依赖)

Normal
CreateTimelong

创建时间。

1710239005403
ModifyTimelong

修改时间

1710239005403
CreateUserstring

创建用户的账号 ID。

1000
ModifyUserstring

修改用户的账号 ID。

1000
TotalCountinteger

数据总条数。

100
PageSizeinteger

每页的条目数。

10
PageNumberinteger

页码。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX\n",
  "PagingInfo": {
    "Tasks": [
      {
        "Name": "SQL节点\n",
        "Description": "test",
        "WorkflowId": 1234,
        "InstanceMode": "T+1",
        "Type": "ODPS_SQL\n",
        "BaselineId": 1234,
        "Priority": 1,
        "Timeout": 3600,
        "RerunMode": "AllAllowed",
        "RerunTimes": 3,
        "RerunInterval": 60,
        "Trigger": {
          "Type": "Scheduler",
          "Recurrence": "Normal",
          "Cron": "00 00 00 * * ?\n",
          "StartTime": "1970-01-01 00:00:00\n",
          "EndTime": "9999-01-01 00:00:00\n",
          "Timezone": "Asia/Shanghai"
        },
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx",
          "Cu": "0.25"
        },
        "DataSource": {
          "Name": "mysql_test\n"
        },
        "Id": 1234,
        "TenantId": 1,
        "ProjectId": 100,
        "ProjectEnv": "Prod",
        "Owner": "1000",
        "StepType": "Normal",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000"
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-11-20OpenAPI 返回结构发生变更查看变更详情