# 查询批处理作业列表 - ListSparkJobs #### 功能介绍 该API用于查询Project下某队列批处理作业的列表。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DLI&api=ListSparkJobs)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限及授权项说明](https://support.huaweicloud.com/api-dli/dli_02_0375.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | 条件键 Condition Key | 别名 Alias | 依赖的授权项 Dependencies | |:---|:---|:---|:---|:---|:---| | dli:jobs:list | list | jobs \* | - | - | - | | dli:jobs:list | list | - | - [g:RequestTag/\](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) - [g:TagKeys](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) | - | - | #### URI - URI格式： GET /v2.0/{project_id}/batches - 参数说明 表1URI参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目编号，用于资源隔离。获取方式请参考[获取项目ID](https://support.huaweicloud.com/api-dli/dli_02_0183.html)。 示例: 48cc2c48765f481480c7db940d6409d1 **约束限制：** 无 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 无 | 表2query参数说明 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | job_name | 否 | String | **参数解释：** 批处理作业的名称。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | job-id | 否 | String | **参数解释：** 根据作业ID查询批作业。示例: 03923a72-5ace-466a-a573-e8c7b08b8cf3 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | cluster_name | 否 | String | **参数解释：** DLI队列名称，不填写则获取当前Project下所有批处理作业(不推荐使用)。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | queue_name | 否 | String | **参数解释：** DLI队列名称，根据队列查询批作业（推荐使用）。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | from | 否 | Integer | **参数解释：** 起始批处理作业的索引号，默认从0开始。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | size | 否 | Integer | **参数解释：** 查询批处理作业的数量。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | | state | 否 | String | **参数解释：** 根据作业状态查询批作业。 **约束限制：** 无 **取值范围：** - starting：正在启动 - running：正在执行任务 - dead：session已退出 - success：session停止成功 - recovering：正在恢复 **默认取值：** 无 | | owner | 否 | String | **参数解释：** 提交作业的用户。 **约束限制：** 无 **取值范围：** 无 **默认取值：** 无 | #### 请求消息 无请求参数。 #### 响应消息 表3响应参数说明 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | from | 否 | Integer | **参数解释：** 起始批处理作业的索引号。 **取值范围：** 无 | | total | 否 | Integer | **参数解释：** 返回批处理作业的总数。 **取值范围：** 无 | | sessions | 否 | Array of objects | **参数解释：** 批处理作业信息。详细说明请参见[表4]。 **取值范围：** 无 | | create_time | 否 | Long | **参数解释：** 批处理作业的创建时间。 **取值范围：** 无 | 表4sessions参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | duration | 否 | Long | **参数解释：** 作业运行时长，单位毫秒。 **取值范围：** 无 | | id | 否 | String | **参数解释：** 批处理作业的ID。 **取值范围：** 无 | | state | 否 | String | **参数解释：** 批处理作业的状态。 **取值范围：** - starting：正在启动 - running：正在执行任务 - dead：session已退出 - success：session停止成功 - recovering：正在恢复 | | appId | 否 | String | **参数解释：** 批处理作业的后台app ID。 **取值范围：** 无 | | log | 否 | Array of Strings | **参数解释：** 显示当前批处理作业的最后10条记录。 **取值范围：** 无 | | sc_type | 否 | String | **参数解释：** 计算资源类型。目前可接受参数A, B, C。用户自定义时返回CUSTOMIZED。 **取值范围：** - A：物理资源：8核32G内存， - driverCores：2； - executorCores：1； - driverMemory：7G； - executorMemory：4G； - numExecutor：6。 - B：物理资源：16核64G内存 - driverCores：2； - executorCores：2； - driverMemory：7G； - executorMemory：8G； - numExecutor：7。 - C：物理资源：32核128G内存 - driverCores：4； - executorCores：2； - driverMemory：15G； - executorMemory：8G； - numExecutor：14。 | | cluster_name | 否 | String | **参数解释：** 批处理作业所在队列。 **取值范围：** 无 | | create_time | 否 | Long | **参数解释：** 批处理作业的创建时间。是单位为"毫秒"的时间戳。 **取值范围：** 无 | | name | 否 | String | **参数解释：** 批处理作业名称。 **取值范围：** 无 | | owner | 否 | String | **参数解释：** 批处理作业所属用户。 **取值范围：** 无 | | proxyUser | 否 | String | **参数解释：** 批处理作业所属代理用户（资源租户）。 **取值范围：** 无 | | kind | 否 | String | **参数解释：** 批处理作业类型，只支持spark类型参数。 **取值范围：** 无 | | queue | 否 | String | **参数解释：** 批处理作业所在队列。 **取值范围：** 无 | | image | 否 | String | **参数解释：** 自定义镜像。**格式为：组织名/镜像名:镜像版本。** 当用户设置"feature"为"custom"时，该参数生效。用户可通过与"feature"参数配合使用，指定作业运行使用自定义的Spark镜像。 **取值范围：** 无 | | req_body | 否 | String | **参数解释：** 请求参数详情。 **取值范围：** 无 | | update_time | 否 | Long | **参数解释：** 批处理作业的更新时间。是单位为"毫秒"的时间戳。 **取值范围：** 无 | #### 请求示例 无 #### 响应示例 ``` { "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 } ] } ``` #### 状态码 状态码如[表5]所示。 表5状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功。 | | 400 | 请求错误。 | | 500 | 内部服务器错误。 | #### 错误码 调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见[错误码](https://support.huaweicloud.com/api-dli/dli_02_0056.html)。