GetTaskInstance - 获取任务实例的详情

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

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*get
*全部资源
*

请求参数

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

任务实例的唯一标识符

1234

返回参数

名称类型描述示例值
object

返回值

RequestIdstring

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

22C97E95-F023-56B5-8852-B1A77****
TaskInstanceobject

任务实例的详细信息。

TaskIdlong

对应任务的 ID。

1234
TaskTypestring

对应任务的类型。

ODPS_SQL
TaskNamestring

对应任务的名称。

SQL node
Descriptionstring

描述信息。

test
WorkflowIdlong

所属工作流的 ID。

1234
WorkflowNamestring

所属工作流的名称。

Test workflow
TriggerTypestring

触发方式类型。可通过调用 GetTask 接口的返回参数 Trigger.Type 获取触发方式类型。

  • Scheduler:调度周期触发
  • Manual:手动触发
Scheduler
TriggerRecurrencestring

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

  • Pause:暂停
  • Skip:空跑
  • Normal:正常运行
Normal
WorkflowInstanceIdlong

所属工作流实例的 ID。

1234
WorkflowInstanceTypestring

所属工作流实例的类型。

  • SmokeTest:测试
  • SupplementData:补数据
  • Manual:手动任务
  • ManualWorkflow:手动工作流
  • Normal:周期调度
  • ManualFlow:手动执行的业务流程
Normal
Timeoutinteger

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

注意:调度系统会对任务的设定值按小时取整。

3600
RerunModestring

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

  • AllDenied:失败或成功都不可重跑
  • AllAllowed:失败或成功均可重跑
  • FailureAllowed:只有失败可重跑
AllAllowed
RunNumberinteger

当前运行的次数,默认从 1 开始。

1
PeriodNumberinteger

周期序号。表示任务实例处于当天的第几轮周期。

1
BaselineIdlong

基线 ID。

1234
Priorityinteger

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

1
Scriptobject

运行脚本信息。

Contentstring

脚本内容。

echo "helloWorld"
Parametersstring

脚本参数列表。

para1=$bizdate
RuntimeResourceobject

实例关联资源组信息。

ResourceGroupIdstring

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

S_res_group_524258031846018_1684XXXXXXXXX
Imagestring

任务运行配置的镜像 ID。

i-xxxxxx
Custring

任务运行配置 CU 消耗。

0.25
Runtimeobject

实例运行时信息。

ProcessIdstring

运行唯一 ID。

T3_123
Gatewaystring

运行机器。

cn-shanghai.1.2
DataSourceobject

实例关联数据源信息。

Namestring

数据源名称。

mysql_test
Inputsobject

输入信息。

Variablesarray<object>

变量定义列表。

Variableobject
Namestring

变量名称。

Key1
Typestring

类型。

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

变量值。

Value1
Outputsobject

输出信息。

TaskOutputsarray<object>

任务输出定义列表。

TaskOutputobject
Outputstring

输出标识符。

pre.odps_sql_demo_0
Variablesarray<object>

变量定义列表。

Variableobject
Namestring

变量名称。

key1
Typestring

类型。

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

变量值。

value1
Tagsarray<object>

任务标签列表。

Tagobject
Keystring

标签键。

key1
Valuestring

标签值。

value1
Statusstring

实例运行状态。

  • NotRun:未运行
  • Running:运行中
  • WaitTime:等待 TriggerTime 到来
  • CheckingCondition:分支条件校检
  • WaitResource:等待资源
  • Failure:执行失败
  • Success:执行成功
  • Checking:下发给数据质量校检
  • WaitTrigger(等待外部触发,触发式节点会在等待时间后变成等待触发)
Success
TriggerTimelong

定时触发时间。

1710239005403
Bizdatelong

业务日期。

1710239005403
StartedTimelong

开始运行时间。

1710239005403
FinishedTimelong

完成时间。

1710239005403
Idlong

任务实例的唯一标识符。

1234
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-B1A77****",
  "TaskInstance": {
    "TaskId": 1234,
    "TaskType": "ODPS_SQL",
    "TaskName": "SQL node\n",
    "Description": "test",
    "WorkflowId": 1234,
    "WorkflowName": "Test workflow",
    "TriggerType": "Scheduler",
    "TriggerRecurrence": "Normal",
    "WorkflowInstanceId": 1234,
    "WorkflowInstanceType": "Normal",
    "Timeout": 3600,
    "RerunMode": "AllAllowed",
    "RunNumber": 1,
    "PeriodNumber": 1,
    "BaselineId": 1234,
    "Priority": 1,
    "Script": {
      "Content": "echo \"helloWorld\"",
      "Parameters": "para1=$bizdate"
    },
    "RuntimeResource": {
      "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
      "Image": "i-xxxxxx",
      "Cu": "0.25"
    },
    "Runtime": {
      "ProcessId": "T3_123",
      "Gateway": "cn-shanghai.1.2"
    },
    "DataSource": {
      "Name": "mysql_test"
    },
    "Inputs": {
      "Variables": [
        {
          "Name": "Key1",
          "Type": "Constant",
          "Value": "Value1"
        }
      ]
    },
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ],
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant",
          "Value": "value1"
        }
      ]
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "Status": "Success",
    "TriggerTime": 1710239005403,
    "Bizdate": 1710239005403,
    "StartedTime": 1710239005403,
    "FinishedTime": 1710239005403,
    "Id": 1234,
    "ProjectId": 100,
    "ProjectEnv": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000"
  }
}

错误码

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

变更历史

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