文档首页/ 数据湖探索 DLI/ API参考/ Spark作业相关API/ 查询批处理作业详情
更新时间：2023-12-14 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询批处理作业详情

功能介绍

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

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式：

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

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

    参数名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

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

    batch_id

    是

    String

    批处理作业的ID。

请求消息

无请求参数。

响应消息

表2 响应参数

参数名称

是否必选

参数类型

说明

id

否

String

批处理作业的id。

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

内部服务器错误。

错误码

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

父主题： Spark作业相关API

相关文档