全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：GetTask - 获取任务的详情

    文档中心

    大数据开发治理平台 DataWorks：GetTask - 获取任务的详情

    更新时间：Sep 03, 2026

    获取指定的任务的详细信息。

    接口说明

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

    调试

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

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    dataworks:*

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    Id

    integer

    是

    任务的唯一标识符。

    1234
    ProjectEnv

    string

    否

    项目环境。

    • Prod：生产

    • Dev：开发

    Prod

    返回参数

    名称

    类型

    描述

    示例值

    object

    RequestId

    string

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

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

    object

    任务的详细信息。

    Name

    string

    名称。

    SQL node
    Description

    string

    描述信息。

    test
    WorkflowId

    integer

    工作流 ID。

    1234
    InstanceMode

    string

    实例生成模式。

    • T+1（第二天生成）

    • Immediately（立即生成）

    T+1
    Type

    string

    任务类型。

    ODPS_SQL
    BaselineId

    integer

    基线 ID。

    1234
    Priority

    integer

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

    1
    Timeout

    integer

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

    3600
    RerunMode

    string

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

    • AllDenied：失败或成功都不可重跑

    • FailureAllowed：只有失败可重跑

    • AllAllowed：失败或成功均可重跑

    AllAllowed
    RerunTimes

    integer

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

    3
    RerunInterval

    integer

    重试时间间隔，单位秒。

    60
    Script

    object

    运行脚本信息。

    Content

    string

    脚本内容。

    echo "helloWorld"
    Parameters

    string

    脚本参数列表。

    para1=$bizdate
    Trigger

    object

    任务触发方式。

    Type

    string

    触发方式类型。

    • Scheduler：调度周期触发

    • Manual：手动触发

    Scheduler
    Recurrence

    string

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

    • Pause：暂停

    • Skip：空跑

    • Normal：正常运行

    Normal
    Cron

    string

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

    00 00 00 * * ?
    StartTime

    string

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

    1970-01-01 00:00:00
    EndTime

    string

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

    9999-01-01 00:00:00
    RuntimeResource

    object

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

    ResourceGroupId

    string

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

    S_res_group_524258031846018_1684XXXXXXXXX
    Image

    string

    任务运行配置的镜像 ID。

    i-xxxxxx

    Cu

    string

    任务运行配置 CU 消耗。

    0.25
    DataSource

    object

    关联数据源信息。

    Name

    string

    数据源名称。

    mysql_test
    Inputs

    object

    输入信息。

    Variables

    array<object>

    变量定义列表。

    object

    Name

    string

    变量名称。

    key1
    Type

    string

    类型。

    • Constant：常量

    • PassThrough：参数节点输出

    • System：变量

    • NodeOutput：脚本输出

    Constant

    Value

    string

    变量值。

    Value1

    Outputs

    object

    输出信息。

    TaskOutputs

    array<object>

    任务输出定义列表。

    object

    Output

    string

    输出标识符。

    pre.odps_sql_demo_0
    Variables

    array<object>

    变量定义列表。

    object

    Name

    string

    变量名称。

    key1
    Type

    string

    类型。

    • Constant：常量

    • PassThrough：参数节点输出

    • System：变量

    • NodeOutput：脚本输出

    Constant

    Value

    string

    变量值。

    value1
    Dependencies

    array<object>

    依赖信息。

    object

    Type

    string

    依赖类型。

    • CrossCycleDependsOnChildren：跨周期依赖一级子节点

    • CrossCycleDependsOnSelf：跨周期依赖自己

    • CrossCycleDependsOnOtherNode：跨周期依赖其他节点

    • Normal：同周期依赖

    Normal
    UpstreamOutput

    string

    上游任务的输出标识符。（同周期依赖且设置 input 内容时，返回此字段）。

    pre.odps_sql_demo_0
    UpstreamTaskId

    string

    上游任务的 Id。（跨周期依赖其他节点与同周期依赖未设置 input 内容时，返回此字段，其他情况不返回）。

    1234
    SubTasks

    object

    复杂任务嵌套配置，如循环节点等。

    SubTasks

    array<object>

    子任务列表。

    array<object>

    Name

    string

    任务的名称。

    SQL node

    Description

    string

    描述信息。

    test
    WorkflowId

    integer

    所属工作流的 ID。

    1234
    Type

    string

    任务类型。

    ODPS_SQL

    BaselineId

    integer

    基线 ID。

    The baseline ID.

    Priority

    integer

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

    1
    Timeout

    integer

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

    3600
    RerunMode

    string

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

    • AllDenied：失败或成功都不可重跑

    • FailureAllowed：只有失败可重跑

    • AllAllowed：失败或成功均可重跑

    AllAllowed
    RerunTimes

    integer

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

    3
    RerunInterval

    integer

    重试时间间隔，单位秒。

    180
    Trigger

    object

    任务触发方式。

    Type

    string

    触发方式类型。

    • Scheduler：调度周期触发

    • Manual：手动触发

    Scheduler
    Recurrence

    string

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

    • Pause：暂停

    • Skip：空跑

    • Normal：正常运行

    Normal

    Cron

    string

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

    00 00 00 * * ?

    StartTime

    string

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

    1970-01-01 00:00:00

    EndTime

    string

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

    9999-01-01 00:00:00

    RuntimeResource

    object

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

    ResourceGroupId

    string

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

    S_res_group_524258031846018_1684XXXXXXXXX
    Image

    string

    任务运行配置的镜像 ID。

    i-xxxxxx
    Cu

    string

    任务运行配置 CU 消耗。

    0.25
    DataSource

    object

    关联数据源信息。

    Name

    string

    数据源名称。

    mysql_test

    Id

    integer

    任务的唯一标识符。

    1234
    ProjectId

    integer

    项目 ID。

    100
    ProjectEnv deprecated

    string

    项目环境。该字段已废弃，请使用 EnvType。

    • Prod：生产

    • Dev：开发

    Prod
    EnvType

    string

    项目环境。

    • Prod：生产

    • Dev：开发

    Prod
    Owner

    string

    任务的责任人的账号 ID。

    1000

    CreateTime

    integer

    创建时间。

    1710239005403

    ModifyTime

    integer

    修改时间。

    1710239005403

    CreateUser

    string

    创建用户的账号 ID。

    1000

    ModifyUser

    string

    修改用户的账号 ID。

    1000

    Type

    string

    子任务类型。

    • DoWhile：do-while 节点

    • Combined：组合节点

    • ForEach：for-each 节点

    Combined
    Tags

    array<object>

    任务标签列表。

    object

    Key

    string

    标签键。

    key1
    Value

    string

    标签值。

    value1
    Id

    integer

    任务的唯一标识符。

    1234
    ProjectId

    integer

    项目 ID。

    100
    ProjectEnv deprecated

    string

    项目环境。项目环境。该字段已废弃，请使用 EnvType。

    • Prod：生产

    • Dev：开发

    Prod
    EnvType

    string

    项目环境。

    • Prod：生产

    • Dev：开发

    Prod
    Owner

    string

    任务的责任人的账号 ID。

    1000
    CreateTime

    integer

    创建时间。

    1710239005403

    ModifyTime

    integer

    修改时间。

    1710239005403

    CreateUser

    string

    创建用户的账号 ID。

    1000

    ModifyUser

    string

    修改用户的账号 ID。

    1000

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Task": {
    "Name": "SQL node",
    "Description": "test",
    "WorkflowId": 1234,
    "InstanceMode": "T+1",
    "Type": "ODPS_SQL",
    "BaselineId": 1234,
    "Priority": 1,
    "Timeout": 3600,
    "RerunMode": "AllAllowed",
    "RerunTimes": 3,
    "RerunInterval": 60,
    "Script": {
      "Content": "echo \"helloWorld\"",
      "Parameters": "para1=$bizdate"
    },
    "Trigger": {
      "Type": "Scheduler",
      "Recurrence": "Normal",
      "Cron": "00 00 00 * * ?",
      "StartTime": "1970-01-01 00:00:00",
      "EndTime": "9999-01-01 00:00:00"
    },
    "RuntimeResource": {
      "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
      "Image": "i-xxxxxx\n",
      "Cu": "0.25"
    },
    "DataSource": {
      "Name": "mysql_test"
    },
    "Inputs": {
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant\n",
          "Value": "Value1\n"
        }
      ]
    },
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ],
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant\n",
          "Value": "value1"
        }
      ]
    },
    "Dependencies": [
      {
        "Type": "Normal",
        "UpstreamOutput": "pre.odps_sql_demo_0",
        "UpstreamTaskId": "1234"
      }
    ],
    "SubTasks": {
      "SubTasks": [
        {
          "Name": "SQL node\n",
          "Description": "test",
          "WorkflowId": 1234,
          "Type": "ODPS_SQL\n",
          "BaselineId": 0,
          "Priority": 1,
          "Timeout": 3600,
          "RerunMode": "AllAllowed",
          "RerunTimes": 3,
          "RerunInterval": 180,
          "Trigger": {
            "Type": "Scheduler",
            "Recurrence": "Normal\n",
            "Cron": "00 00 00 * * ?\n",
            "StartTime": "1970-01-01 00:00:00\n",
            "EndTime": "9999-01-01 00:00:00\n"
          },
          "RuntimeResource": {
            "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
            "Image": "i-xxxxxx",
            "Cu": "0.25"
          },
          "DataSource": {
            "Name": "mysql_test\n"
          },
          "Id": 1234,
          "ProjectId": 100,
          "ProjectEnv": "Prod",
          "EnvType": "Prod",
          "Owner": "1000\n",
          "CreateTime": 1710239005403,
          "ModifyTime": 1710239005403,
          "CreateUser": "1000\n",
          "ModifyUser": "1000\n"
        }
      ],
      "Type": "Combined"
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "Id": 1234,
    "ProjectId": 100,
    "ProjectEnv": "Prod",
    "EnvType": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000\n",
    "ModifyUser": "1000"
  }
}

    错误码

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

    变更历史

    更多信息，参考变更详情。