查询批处理作业详情
功能介绍
该API用于根据批处理作业的id查询作业详情。
URI
- URI格式:
- 参数说明
表1 URI参数说明 参数名称
是否必选
参数类型
说明
project_id
是
String
参数解释:
项目编号,用于资源隔离。获取方式请参考获取项目ID。
示例: 48cc2c48765f481480c7db940d6409d1
约束限制:
无
取值范围:
只能由英文字母和数字组成,且长度为[1-64]个字符。
默认取值:
无
batch_id
是
String
参数解释:
批处理作业的ID。获取方式请参考查询批处理作业列表响应参数中的appId。
示例: 0a324461-d9d9-45da-a52a-3b3c7a3d809e
约束限制:
匹配正则表达式'^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'的字符串
取值范围:
无
默认取值:
无
请求消息
无请求参数。
响应消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
id |
否 |
String |
参数解释: 批处理作业的ID,采用UUID(通用唯一识别码)格式。 取值范围: 无 |
appId |
否 |
String |
参数解释: 批处理作业的后台app id。 取值范围: 无 |
name |
否 |
String |
参数解释: 批处理作业名称。 取值范围: 无 |
owner |
否 |
String |
参数解释: 批处理作业所属用户。 取值范围: 无 |
proxyUser |
否 |
String |
参数解释: 批处理作业所属代理用户(资源租户)。 取值范围: 无 |
state |
否 |
String |
参数解释: 取值范围: 无 |
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镜像类型。 取值范围:
|
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 }
错误码
调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码。