文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API（V1）/ 作业开发API/ 查询作业实例详情
更新时间：2024-08-27 GMT+08:00
查看PDF
分享

查询作业实例详情

功能介绍

查询指定作业实例详情信息，包括作业实例内各个节点的执行信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

  • URI格式

    GET /v1/{project_id}/jobs/{job_name}/instances/{instance_id}

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

    项目编号，获取方法请参见项目ID和账号ID。

    job_name

    是

    String

    作业名称。

    instance_id

    是

    string

    作业实例ID，获取方法请参见查询作业实例列表的响应参数。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

否

String

工作空间id。

  • 如果不设置该参数，默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据，需要带上该消息头。

响应参数

表3 参数说明

参数名

是否必选

参数类型

说明

jobName

是

String

作业名称。

instanceId

是

Long

作业实例ID。

status

是

String

作业实例状态：

  • waiting：等待运行
  • running：运行中
  • success：运行成功
  • fail：运行失败
  • running-exception：运行异常
  • pause：暂停
  • manual-stop：取消

planTime

是

Long

作业实例计划执行时间。

startTime

是

Long

作业实例实际执行开始时间。

endTime

否

Long

作业实例实际执行结束时间。

executeTime

否

Long

执行耗时，单位：毫秒。

total

是

Integer

总的节点数据条数。

nodes

是

List<Node>

节点实例状态，参考表4

instanceType

是

Integer

作业调度方式：

  • 0：正常调度
  • 2：手工调度
  • 5：补数据
  • 6：子作业调度
  • 7：单次调度

forceSuccess

否

boolean

作业实例状态筛选为强制成功。

默认值：false

ignoreSuccess

否

boolean

作业实例状态筛选为忽略失败。

默认值：false
表4 Node属性说明

参数名

是否必选

参数类型

说明

nodeName

是

String

节点名称。

status

是

String

节点状态：

  • waiting：等待运行
  • running：运行中
  • success：运行成功
  • fail：运行失败
  • skip：跳过
  • pause：暂停
  • manual-stop：取消

queue

是

String

DLI资源队列名称。

说明：

在返回响应中，仅DLI SQL或者DLI SPARK算子会返回DLI队列名称。

planTime

是

Long

作业实例计划执行时间。

startTime

是

Long

节点实际执行开始时间。

endTime

否

Long

节点实际执行结束时间。

type

是

String

节点类型：

  • HiveSQL： 执行Hive SQL脚本
  • SparkSQL： 执行Spark SQL脚本
  • DWSSQL：执行DWS SQL脚本
  • DLISQL：执行DLI SQL脚本
  • Shell：执行Shell SQL脚本
  • CDMJob：执行CDM作业
  • DISTransferTask：创建DIS转储任务
  • CloudTableManager：CloudTable表管理，创建和删除表。
  • OBSManager：OBS路径管理，包括创建和删除路径。
  • RestClient：REST API请求
  • SMN：发送短信或邮件
  • MRSSpark：执行MRS服务的Spark作业
  • MapReduce：执行MRS服务的MapReduce作业
  • MRSFlinkJob: 执行MRS服务的FlinkJob作业。
  • MRSHetuEngine: 执行MRS服务的HetuEngine作业。
  • DLISpark：执行DLF服务的Spark作业
  • RDSSQL：传递SQL语句到RDS中执行。
  • ModelArts Train：执行ModelArts服务的workflow作业。

retryTimes

否

Integer

失败重试次数。

instanceId

是

Long

作业实例id。

inputRowCount

否

Long

写入数据行数。

speed

否

number

写入速度(行/秒)。

logPath

否

String

节点执行的日志路径。

请求示例

查询作业job_batch实例ID为34765的实例详情。 
GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/job_batch/instances/34765

响应示例

  • 成功响应 
    {
    "jobName":"job_batch",
    "instanceId":34765,
    "instanceType": 2,
    "status":"fail",
    "planTime":1551425326540,
    "startTime":1551425327000,
    "endTime":1551425387000,
    "executeTime":1,
    "forceSuccess":false,
    "ignoreSuccess":false,
    "total":2,
    "nodes":[
        {
            "endTime":1551671590000,
            "inputRowCount":0,
            "instanceId":34765,
            "nodeName":"Dummy_8556",
            "queue":"dlf_notdelete",
            "planTime":1551671580000,
            "retryTimes":0,
            "startTime":1551671584000,
            "status":"success",
            "type":"Dummy"
        },
        {
            "endTime":1551671598000,
            "inputRowCount":0,
            "instanceId":34765,
            "logPath":"obs://dlf-test-log/job_batch/2019-03-04 11_53_00.000/error/error.job",
            "nodeName":"error",
            "planTime":1551671580000,
            "retryTimes":0,
            "startTime":1551671594000,
            "status":"success",
            "type":"DWS SQL"
        }
    ]
}
  • 失败响应

    HTTP状态码 400

    {
    "error_code":"DLF.0137",
    "error_msg":"Job instance does not exist."
}
父主题： 作业开发API

相关文档