功能介绍

该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	提交作业的用户。

请求消息

无请求参数。

响应消息

示例

• 请求样例：

  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所示。

错误码

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