GetInstance - 获取实例的详情

更新时间:
复制 MD 格式

调用GetInstance接口,获取实例的详细信息。

调试

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

调试

授权信息

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

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

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

InstanceId

integer

是

实例的 ID。您可以调用 ListInstances 获取。

1234

ProjectEnv

string

是

工作空间的环境,包括 PROD(生产环境)和 DEV(开发环境)。

枚举值:

  • PROD :

    生产环境

  • DEV :

    开发环境

PROD

返回参数

名称

类型

描述

示例值

object

返回实体。

HttpStatusCode

integer

HTTP 状态码。

200

RequestId

string

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

E6F0DBDD-5AD****

ErrorMessage

string

调度实例失败时的异常信息。

test

Success

boolean

调用是否成功。

true

ErrorCode

string

错误码。

0

Data

object

实例的详细信息。

Status

string

任务的状态,取值如下:

  • NOT_RUN(1):未运行

  • WAIT_TIME(2): 等待时间。等待定时时间到来

  • WAIT_RESOURCE(3):等待资源。已经下发到执行引擎,在等待资源排队调度执行

  • RUNNING(4):运行中

  • CHECKING(7):校验中。执行完毕,下发给数据质量进行数据校检

  • CHECKING_CONDITION(8): 条件检测中。执行完毕,正在做分支条件校验

  • WAIT_TRIGGER(9):等待触发。触发式节点会在等待时间后变成等待触发

  • FAILURE(5):运行失败

  • SUCCESS(6):运行成功

NOT_RUN

CycTime

integer

实例的定时时间。

格式示例为 13 位数字,例如 1590422400000。

1590422400000

BeginRunningTime

integer

实例开始运行的时间。

格式示例为 13 位数字,例如 1590416703313。

1590416703313

FinishTime

integer

实例运行的结束时间。

格式示例为 13 位数字,例如 1590416703313。

1590416703313

CreateTime

integer

实例的创建时间。

格式示例为 13 位数字,例如 1590416703313。

1590416703313

DagId

integer

工作流的 ID。

338450167

Priority

integer

实例运行优先级,取值分为 1、3、5、7 和 8。取值越大,优先级越高。默认优先级为 1。

1

TaskType

string

实例的调度类型,取值如下:

  • NORMAL(0):正常调度任务。该任务被日常调度。

  • MANUAL(1):手动任务。该任务不会被日常调度。

  • PAUSE(2):冻结任务。该任务被日常调度,但启动调度时直接被置为失败状态。

  • SKIP(3):空跑任务。该任务被日常调度,但启动调度时直接被置为成功状态。

  • SKIP_UNCHOOSE(4):临时工作流中未选择的任务,仅存在于临时工作流中,启动调度时直接被置为成功状态。

  • SKIP_CYCLE(5):未到运行周期的周或月任务。该任务被日常调度,但启动调度时直接被置为成功状态。

  • CONDITION_UNCHOOSE(6):上游实例中有分支(IF)节点,但是该下游节点未被分支节点选中,直接置为空跑任务。

  • REALTIME_DEPRECATED(7):实时生成的已经过期的周期实例,该类型的任务直接被置为成功状态。

NORMAL(0)

ParamValues

string

参数信息。

bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif

Connection

string

连接串。

odps_source

BaselineId

integer

基线 ID。

123123

DqcType

integer

数据质量 DQC 类型,取值如下:

  • 0 表示有关联 dqc。

  • 1 表示没有关联 dqc。

1

DagType

string

工作流的类型,取值如下:

  • DAILY(0):日常调度工作流

  • MANUAL(1):手动任务工作流

  • SMOKE_TEST(2):冒烟测试工作流

  • SUPPLY_DATA(3):补数据工作流

  • MANUAL_FLOW(4):手动运行的 dataflow pai 业务流程等(如 IDE 上点击运行业务流程)

  • BUSINESS_PROCESS_DAG(5):手动业务流程工作流

DAILY

BusinessId

integer

业务流程 ID。

123

TaskRerunTime

integer

实例还可以运行的次数。取值可以为空、以及大于等于 0 的整数。

  • 取值为空,表示该实例对应的节点没有设置自动重跑次数。

  • 取值为 0,表示该实例不能再重跑。

  • 取值为大于 0 的整数(假设为 n),表示该实例可重跑次数为 n。例如,该参数取值为 1,则剩余重跑次数为 1,取值为 2,则剩余重跑次数为 2,以此类推。初始值为对应节点定义的自动重跑次数+1。

0

PeriodNumber

integer

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

1

ModifyTime

integer

实例的最新修改时间。

格式示例为 13 位数字,例如 1590416703313。

1590416703313

Repeatability

boolean

实例是否可以重复执行。

true

RepeatInterval

integer

调度任务运行出错后,重新调整调度频率,单位为毫秒(ms)。

60000

InstanceId

integer

实例的 ID。

11713307578

BeginWaitResTime

integer

实例开始等待资源的时间。

格式示例为 13 位数字,例如 1590416703313。

1590416703313

RelatedFlowId

integer

关联的业务流程 ID。

123123

Bizdate

integer

业务日期。通常为该任务运行时间的前一天。

格式示例为 13 位数字,例如 1590336000000。

1590336000000

NodeName

string

节点的名称。

kzh

BeginWaitTimeTime

integer

实例开始等待调度的时间。

格式示例为 13 位数字,例如 1590416703313。

1590416703313

DqcDescription

string

DQC 分区规则串。

[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]

NodeId

integer

节点的 ID。

33115

CreateUser

string

实例创建人。

111

Owner

string

实例责任人。

111

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "test",
  "Success": true,
  "ErrorCode": "0",
  "Data": {
    "Status": "NOT_RUN",
    "CycTime": 1590422400000,
    "BeginRunningTime": 1590416703313,
    "FinishTime": 1590416703313,
    "CreateTime": 1590416703313,
    "DagId": 338450167,
    "Priority": 1,
    "TaskType": "NORMAL(0)",
    "ParamValues": "bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif",
    "Connection": "odps_source",
    "BaselineId": 123123,
    "DqcType": 1,
    "DagType": "DAILY",
    "BusinessId": 123,
    "TaskRerunTime": 0,
    "PeriodNumber": 1,
    "ModifyTime": 1590416703313,
    "Repeatability": true,
    "RepeatInterval": 60000,
    "InstanceId": 11713307578,
    "BeginWaitResTime": 1590416703313,
    "RelatedFlowId": 123123,
    "Bizdate": 1590336000000,
    "NodeName": "kzh",
    "BeginWaitTimeTime": 1590416703313,
    "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
    "NodeId": 33115,
    "CreateUser": "111",
    "Owner": "111"
  }
}

错误码

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

变更历史

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