更新时间:2025-08-06 GMT+08:00

查询批处理作业详情

功能介绍

该API用于根据批处理作业的id查询作业详情。

URI

  • URI格式:

    GET /v2.0/{project_id}/batches/{batch_id}

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

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    参数解释:

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    示例: 48cc2c48765f481480c7db940d6409d1

    约束限制:

    取值范围:

    只能由英文字母和数字组成,且长度为[1-64]个字符。

    默认取值:

    batch_id

    String

    参数解释:

    批处理作业的ID。获取方式请参考查询批处理作业列表响应参数中的appId。

    示例: 0a324461-d9d9-45da-a52a-3b3c7a3d809e

    约束限制:

    匹配正则表达式'^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'的字符串

    取值范围:

    默认取值:

请求消息

无请求参数。

响应消息

表2 响应参数

参数名称

是否必选

参数类型

说明

id

String

参数解释:

批处理作业的ID,采用UUID(通用唯一识别码)格式。

取值范围:

appId

String

参数解释:

批处理作业的后台app id。

取值范围:

name

String

参数解释:

批处理作业名称。

取值范围:

owner

String

参数解释:

批处理作业所属用户。

取值范围:

proxyUser

String

参数解释:

批处理作业所属代理用户(资源租户)。

取值范围:

state

String

参数解释:

批处理作业的状态,请参见创建批处理作业中的表7

取值范围:

kind

String

参数解释:

批处理作业类型,只支持spark类型参数。

取值范围:

log

Array of Strings

参数解释:

显示当前批处理作业的最后10条记录。

取值范围:

sc_type

String

参数解释:

计算资源类型。用户自定义时返回CUSTOMIZED。

取值范围:

cluster_name

String

参数解释:

批处理作业所在队列。

取值范围:

queue

String

参数解释:

批处理作业所在队列。

取值范围:

create_time

Long

参数解释:

批处理作业的创建时间。是单位为“毫秒”的时间戳。

取值范围:

update_time

Long

参数解释:

批处理作业的更新时间。是单位为“毫秒”的时间戳。

取值范围:

feature

String

参数解释:

作业特性。表示用户作业使用的Spark镜像类型。

取值范围:

  • basic:表示使用DLI提供的基础Spark镜像。
  • custom:表示使用用户自定义的Spark镜像。
  • ai:表示使用DLI提供的AI镜像。

spark_version

String

参数解释:

作业使用spark组件的版本号,在“feature”为“basic”或“ai”时填写,若不填写,则使用默认的spark组件版本号2.3.2。

取值范围:

image

String

参数解释:

自定义镜像。格式为:组织名/镜像名:镜像版本。

取值范围:

当用户设置“feature”“custom”时,该参数生效。用户可通过与“feature”参数配合使用,指定作业运行使用自定义的Spark镜像。关于如何使用自定义镜像,请参考《数据湖探索用户指南》。

req_body

String

参数解释:

请求参数详情。

取值范围:

请求示例

响应示例

{
    "id": "0a324461-d9d9-45da-a52a-3b3c7a3d809e",
    "appId": "",
    "name": "",
    "owner": "",
    "proxyUser": "",
    "state": "starting",
    "kind":"",
    "log": [
           "stdout: ",
            "stderr: ",
            "YARN Diagnostics: "
    ],
    "sc_type": "A",
    "cluster_name": "test",
    "queue": "test",
    "create_time": 1531906043036,
    "update_time": 1531906043036
}

状态码

状态码如表3所示。

表3 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码