GetTaskInstance - 获取任务实例的详情 - 大数据开发治理平台 DataWorks

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

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Id	long	是	任务实例的唯一标识符	1234

返回参数

名称	类型	描述	示例值
	object	返回值
RequestId	string	请求的 ID，用于定位日志，排查问题。	22C97E95-F023-56B5-8852-B1A77A17XXXX
TaskInstance	object	任务实例的详细信息。
TaskId	long	对应任务的 ID。	1234
TaskType	string	对应任务的类型。	ODPS_SQL
TaskName	string	对应任务的名称。	SQL节点
Description	string	描述信息。	test
WorkflowId	long	所属工作流的 ID。	1234
WorkflowName	string	所属工作流的名称。	Test工作流
TriggerType	string	触发方式类型。可通过调用 GetTask 接口的返回参数 Trigger.Type 获取触发方式类型。 Scheduler：调度周期触发 Manual：手动触发	Scheduler
TriggerRecurrence	string	触发时的运行模式。TriggerType=Scheduler 时生效。 Pause：暂停 Skip：空跑 Normal：正常运行	Normal
WorkflowInstanceId	long	所属工作流实例的 ID。	1234
WorkflowInstanceType	string	所属工作流实例的类型。 SmokeTest：测试 SupplementData：补数据 Manual：手动任务 ManualWorkflow：手动工作流 Normal：周期调度 ManualFlow：手动执行的业务流程	Normal
Timeout	integer	任务执行超时时间，单位为秒。注意：调度系统会对任务的设定值按小时取整。	3600
RerunMode	string	任务是否允许重跑的配置。 AllDenied：失败或成功都不可重跑 AllAllowed：失败或成功均可重跑 FailureAllowed：只有失败可重跑	AllAllowed
RunNumber	integer	当前运行的次数，默认从 1 开始。	1
PeriodNumber	integer	周期序号。表示任务实例处于当天的第几轮周期。	1
BaselineId	long	基线 ID。	1234
Priority	integer	任务运行优先级，最小值 1，最大值 8。取值越大，优先级越高。默认优先级为 1。	1
Script	object	运行脚本信息。
Content	string	脚本内容。	echo "helloWorld"
Parameters	string	脚本参数列表。	para1=$bizdate
RuntimeResource	object	实例关联资源组信息。
ResourceGroupId	string	任务运行配置的调度资源组标识符。	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	任务运行配置的镜像 ID。	i-xxxxxx
Cu	string	任务运行配置 CU 消耗。	0.25
Runtime	object	实例运行时信息。
ProcessId	string	运行唯一 ID。	T3_123
Gateway	string	运行机器。	cn-shanghai.1.2
DataSource	object	实例关联数据源信息。
Name	string	数据源名称。	mysql_test
Inputs	object	输入信息。
Variables	array<object>	变量定义列表。
Variable	object
Name	string	变量名称。	Key1
Type	string	类型。 Constant：常量 PassThrough：参数节点输出 System：变量 NodeOutput：脚本输出	Constant
Value	string	变量值。	Value1
Outputs	object	输出信息。
TaskOutputs	array<object>	任务输出定义列表。
TaskOutput	object
Output	string	输出标识符。	pre.odps_sql_demo_0
Variables	array<object>	变量定义列表。
Variable	object
Name	string	变量名称。	key1
Type	string	类型。 Constant：常量 PassThrough：参数节点输出 System：变量 NodeOutput：脚本输出	Constant
Value	string	变量值。	value1
Tags	array<object>	任务标签列表。
Tag	object
Key	string	标签键。	key1
Value	string	标签值。	value1
Status	string	实例运行状态。 NotRun：未运行 Running：运行中 WaitTime：等待 TriggerTime 到来 CheckingCondition：分支条件校检 WaitResource：等待资源 Failure：执行失败 Success：执行成功 Checking：下发给数据质量校检	Success
TriggerTime	long	定时触发时间。	1710239005403
Bizdate	long	业务日期。	1710239005403
StartedTime	long	开始运行时间。	1710239005403
FinishedTime	long	完成时间。	1710239005403
Id	long	任务实例的唯一标识符。	1234
TenantId	long	租户 ID。	1
ProjectId	long	项目 ID。	100
ProjectEnv	string	项目环境。 Prod：生产 Dev：开发	Prod
Owner	string	任务的责任人的账号 ID。	1000
CreateTime	long	创建时间。	1710239005403
ModifyTime	long	修改时间。	1710239005403
CreateUser	string	创建用户的账号 ID。	1000
ModifyUser	string	修改用户的账号 ID。	1000

示例

正常返回示例

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX\n",
  "TaskInstance": {
    "TaskId": 1234,
    "TaskType": "ODPS_SQL",
    "TaskName": "SQL节点",
    "Description": "test",
    "WorkflowId": 1234,
    "WorkflowName": "Test工作流",
    "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,
    "TenantId": 1,
    "ProjectId": 100,
    "ProjectEnv": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000"
  }
}

错误码

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

变更历史

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