GetTask - 获取任务的详情

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

调试

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

授权信息

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

请求参数

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

任务的唯一标识符。

1234
ProjectEnvstring

项目环境。

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

返回参数

名称类型描述示例值
object
RequestIdstring

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

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

任务的详细信息。

Namestring

名称。

SQL节点
Descriptionstring

描述信息。

test
WorkflowIdlong

工作流 ID。

1234
Typestring

任务类型。

ODPS_SQL
BaselineIdlong

基线 ID。

1234
Priorityinteger

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

1
Timeoutinteger

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

3600
RerunModestring

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

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

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

3
RerunIntervalinteger

重试时间间隔,单位秒。

60
Scriptobject

运行脚本信息。

Contentstring

脚本内容。

echo "helloWorld"
Parametersstring

脚本参数列表。

para1=$bizdate
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
RuntimeResourceobject

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

ResourceGroupIdstring

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

S_res_group_524258031846018_1684XXXXXXXXX
Imagestring

任务运行配置的镜像 ID。

i-xxxxxx
Custring

任务运行配置 CU 消耗。

0.25
DataSourceobject

关联数据源信息。

Namestring

数据源名称。

mysql_test
Inputsobject

输入信息。

Variablesarray<object>

变量定义列表。

Variableobject
Namestring

变量名称。

key1
Scopestring

作用域。

枚举值:
  • TaskContext任务上下文
  • Tenant租户
  • TaskParameter任务参数
  • Workflow工作流
  • Workspace工作空间
TaskContext
Typestring

类型。

枚举值:
  • Constant常量
  • PassThrough参数节点输出
  • System变量
  • NodeOutput脚本输出
Constant
Valuestring

变量值。

Value1
Outputsobject

输出信息。

TaskOutputsarray<object>

任务输出定义列表。

TaskOutputobject
Outputstring

输出标识符。

pre.odps_sql_demo_0
Variablesarray<object>

变量定义列表。

Variableobject
Namestring

变量名称。

key1
Scopestring

作用域。

枚举值:
  • TaskContext任务上下文
  • Tenant租户
  • TaskParameter任务参数
  • Workflow工作流
  • Workspace工作空间
TaskContext
Typestring

类型。

枚举值:
  • Constant常量
  • PassThrough参数节点输出
  • System变量
  • NodeOutput脚本输出
Constant
Valuestring

变量值。

value1
Dependenciesarray<object>

依赖信息。

Dependencieobject
Typestring

依赖类型。

枚举值:
  • CrossCycleDependsOnChildren跨周期依赖一级自节点
  • CrossCycleDependsOnSelf跨周期依赖自己
  • CrossCycleDependsOnOtherNode跨周期依赖其他节点
  • Normal同周期依赖
Normal
Upstreamstring

依赖任务的输出标识符。

pre.odps_sql_demo_0
SubTasksobject

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

SubTasksarray<object>

子任务列表。

SubTaskobject
Namestring

任务的名称。

SQL节点
Descriptionstring

描述信息。

test
WorkflowIdlong

所属工作流的 ID。

1234
Typestring

任务类型。

ODPS_SQL
BaselineIdlong

基线 ID。

基线ID。
Priorityinteger

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

1
Timeoutinteger

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

3600
RerunModestring

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

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

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

3
RerunIntervalinteger

重试时间间隔,单位秒。

180
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
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
CreateTimelong

创建时间。

1710239005403
ModifyTimelong

修改时间。

1710239005403
CreateUserstring

创建用户的账号 ID。

1000
ModifyUserstring

修改用户的账号 ID。

1000
Typestring

子任务类型。

枚举值:
  • DoWhiledo-while节点
  • Combined组合节点
  • ForEachfor-each节点
Combined
Tagsarray<object>

任务标签列表。

Tagobject
Keystring

标签键。

key1
Valuestring

标签值。

value1
Idlong

任务实例的唯一标识符。

1234
TenantIdlong

租户 ID。

1
ProjectIdlong

项目 ID。

100
ProjectEnvstring

项目环境。

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

任务的责任人的账号 ID。

1000
CreateTimelong

创建时间。

1710239005403
ModifyTimelong

修改时间。

1710239005403
CreateUserstring

创建用户的账号 ID。

1000
ModifyUserstring

修改用户的账号 ID。

1000

示例

正常返回示例

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Task": {
    "Name": "SQL节点",
    "Description": "test",
    "WorkflowId": 1234,
    "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",
          "Scope": "TaskContext",
          "Type": "Constant\n",
          "Value": "Value1\n"
        }
      ]
    },
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ],
      "Variables": [
        {
          "Name": "key1",
          "Scope": "TaskContext",
          "Type": "Constant\n",
          "Value": "value1"
        }
      ]
    },
    "Dependencies": [
      {
        "Type": "Normal",
        "Upstream": "pre.odps_sql_demo_0"
      }
    ],
    "SubTasks": {
      "SubTasks": [
        {
          "Name": "SQL节点\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,
          "TenantId": 1,
          "ProjectId": 100,
          "ProjectEnv": "Prod",
          "Owner": "1000\n",
          "CreateTime": 1710239005403,
          "ModifyTime": 1710239005403,
          "CreateUser": "1000\n",
          "ModifyUser": "1000\n"
        }
      ],
      "Type": "Combined"
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "Id": 1234,
    "TenantId": 1,
    "ProjectId": 100,
    "ProjectEnv": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000\n",
    "ModifyUser": "1000"
  }
}

错误码

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