查询批处理作业列表
功能介绍
该API用于查询Project下某队列批处理作业的列表。
URI
- URI格式：
- 参数说明
表1 URI参数 参数名称
是否必选
参数类型
说明
project_id
是
String
参数解释：
项目编号，用于资源隔离。获取方式请参考获取项目ID。
示例: 48cc2c48765f481480c7db940d6409d1
约束限制：
无
取值范围：
只能由英文字母和数字组成，且长度为[1-64]个字符。
默认取值：
无
表2 query参数说明 参数名称
是否必选
参数类型
说明
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
参数解释：
提交作业的用户。
约束限制：
无
取值范围：
无
默认取值：
无
请求消息
无请求参数。
响应消息
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
from |
否 |
Integer |
参数解释： 起始批处理作业的索引号。 取值范围： 无 |
|
total |
否 |
Integer |
参数解释： 返回批处理作业的总数。 取值范围： 无 |
|
sessions |
否 |
Array of objects |
参数解释： 批处理作业信息。详细说明请参见表4。 取值范围： 无 |
|
create_time |
否 |
Long |
参数解释： 批处理作业的创建时间。 取值范围： 无 |
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
duration |
否 |
Long |
参数解释： 作业运行时长，单位毫秒。 取值范围： 无 |
|
id |
否 |
String |
参数解释： 批处理作业的ID。 取值范围： 无 |
|
state |
否 |
String |
参数解释： 批处理作业的状态。 取值范围：
|
|
appId |
否 |
String |
参数解释： 批处理作业的后台app ID。 取值范围： 无 |
|
log |
否 |
Array of Strings |
参数解释： 显示当前批处理作业的最后10条记录。 取值范围： 无 |
|
sc_type |
否 |
String |
参数解释： 计算资源类型。目前可接受参数A, B, C。用户自定义时返回CUSTOMIZED。 取值范围：
|
|
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
}
]
}
错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见错误码。
