通过GetTaskInstance接口获取任务实例详细信息-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

get

*全部资源

*

无

请求参数

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

返回参数

名称	类型	描述	示例值
	object	返回值
RequestId	string	请求的 ID，用于定位日志，排查问题。	22C97E95-F023-56B5-8852-B1A77****
TaskInstance	object	任务实例的详细信息。
TaskId	integer	对应任务的 ID。	1234
TaskType	string	对应任务的类型。	ODPS_SQL
TaskName	string	对应任务的名称。	SQL node
Description	string	描述信息。	test
WorkflowId	integer	所属工作流的 ID。	1234
WorkflowName	string	所属工作流的名称。	Test workflow
TriggerType	string	触发方式类型。可通过调用 GetTask 接口的返回参数 Trigger.Type 获取触发方式类型。 Scheduler：调度周期触发 Manual：手动触发	Scheduler
TriggerRecurrence	string	触发时的运行模式。TriggerType=Scheduler 时生效。 Normal: 正常调度任务，被日常调度。 Manual: 手动任务，不会被日常调度。 Pause: 暂停任务，被日常调度，但启动调度时直接被置为失败。 Skip: 空跑任务，被日常调度，但启动调度时直接被置为成功。 SkipUnchoose: 临时工作流中未选择的任务，仅存在于临时工作流中，启动调度时直接被置为成功。 SkipCycle: 未到运行周期的周月任务，被日常调度，但启动调度时直接被置为成功。 ConditionUnchoose: 上游实例中有分支（IF）节点，但是该下游节点未被分支节点选中，直接变成空跑。 RealtimeDeprecated: 实时生成的已经过期的周期实例，遇到该类型的直接置成功。 PauseCalendar: 引用了日历导致实例暂停。 SkipCalendar: 引用了日历导致实例空跑。	Normal
WorkflowInstanceId	integer	所属工作流实例的 ID。	1234
WorkflowInstanceType	string	所属工作流实例的类型。 SmokeTest：测试 SupplementData：补数据 Manual：手动任务 ManualWorkflow：手动工作流 Normal：周期调度 ManualFlow：手动执行的业务流程	Normal
UnifiedWorkflowInstanceId	integer	统一工作流实例 Id，某次触发下某业务日期内的所有任务实例的该字段值相等。	1234
Timeout	integer	任务执行超时时间，单位为秒。注意：调度系统会对任务的设定值按小时取整。	3600
RerunMode	string	任务是否允许重跑的配置。 AllDenied：失败或成功都不可重跑 AllAllowed：失败或成功均可重跑 FailureAllowed：只有失败可重跑	AllAllowed
RunNumber	integer	当前运行的次数，默认从 1 开始。	1
PeriodNumber	integer	周期序号。表示任务实例处于当天的第几轮周期。	1
BaselineId	integer	基线 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>	变量定义列表。
	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
Tags	array<object>	任务标签列表。
	object	任务标签列表。
Key	string	标签键。	key1
Value	string	标签值。	value1
Status	string	实例运行状态。 NotRun：未运行 Running：运行中 WaitTime：等待 TriggerTime 到来 CheckingCondition：分支条件校检 WaitResource：等待资源 Failure：执行失败 Success：执行成功 Checking：下发给数据质量校检 WaitTrigger（等待外部触发，触发式节点会在等待时间后变成等待触发）	Success
TriggerTime	integer	定时触发时间。	1710239005403
Bizdate	integer	业务日期。	1710239005403
StartedTime	integer	开始运行时间。	1710239005403
FinishedTime	integer	完成时间。	1710239005403
Id	integer	任务实例的唯一标识符。	1234
ProjectId	integer	项目 ID。	100
ProjectEnv	string	项目环境。 Prod：生产 Dev：开发	Prod
Owner	string	任务的责任人的账号 ID。	1000
CreateTime	integer	创建时间。	1710239005403
ModifyTime	integer	修改时间。	1710239005403
CreateUser	string	创建用户的账号 ID。	1000
ModifyUser	string	修改用户的账号 ID。	1000
WaitingResourceTime	integer	进入等资源的时刻。	1710239005403
WaitingTriggerTime	integer	进入等定时时间的时刻。	1710239005403
OperationType	string	实例最近一次操作的类型	TriggerDqc

示例

正常返回示例

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",
    "UnifiedWorkflowInstanceId": 1234,
    "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",
    "WaitingResourceTime": 1710239005403,
    "WaitingTriggerTime": 1710239005403,
    "OperationType": "TriggerDqc"
  }
}

错误码

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

变更历史

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