更新时间:2022-04-16 GMT+08:00
分享

查询批处理作业列表

功能介绍

该API用于查询Project下某队列批处理作业的列表。

调试

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

URI

  • URI格式:

    GET /v2.0/{project_id}/batches

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    表2 query参数说明

    参数名称

    是否必选

    参数类型

    说明

    job_name

    String

    批处理作业的名称。

    job_id

    String

    根据作业ID查询批作业。

    cluster_name

    String

    DLI队列名称,不填写则获取当前Project下所有批处理作业(不推荐使用)。

    queue_name

    String

    DLI队列名称,根据队列查询批作业(推荐使用)。

    from

    Integer

    起始批处理作业的索引号,默认从0开始。

    size

    Integer

    查询批处理作业的数量。

    state

    String

    根据作业状态查询批作业。

    owner

    String

    提交作业的用户。

请求消息

无请求参数。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

from

Integer

起始批处理作业的索引号。

total

Integer

返回批处理作业的总数。

sessions

Array of objects

批处理作业信息。详细说明请参见创建批处理作业中的表6

create_time

Long

批处理作业的创建时间。

示例

  • 请求样例:
    None
  • 成功响应样例:
    {
        "from": 0,
        "total": 1,
        "sessions": [
            {
                "id": "178fa687-2e8a-41ed-a439-b00de60bb176",
                "state": "dead",
                "appId": null,
                "log": [
                 "stdout: ",
                 "stderr: ",
                 "YARN Diagnostics: "
               ],
               "sc_type": "A",
               "cluster_name": "test",
               "create_time": 1531906043036
            }
        ]
    }

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

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

分享:

    相关文档

    相关产品

close