5.2 作业管理接口
5.2.3 查询单个作业信息
}
状态码： 500
查询作业列表信息失败
{ "error_msg" : "查询作业列表失败", "error_code" : "0166"
}
状态码
状态码 描述
200 查询作业列表信息成功 500 查询作业列表信息失败
错误码
请参见错误码。
5.2.3 查询单个作业信息
功能介绍
在MRS集群中查询指定作业的详细信息。
接口约束
无
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}
表5-25 路径参数
参数 是否必选 参数类型 描述
job_execution
_id 是 String 作业ID。获取方法，请参见获取
作业ID。
project_id 是 String 项目编号。获取方法，请参见获 取项目ID。
cluster_id 是 String 集群ID。获取方法，请参见获取 集群ID。
请求参数
无
响应参数
状态码： 200
表5-26 响应 Body 参数
参数 参数类型 描述
job_detail JobQueryBea
n object 作业详细信息。
表5-27 JobQueryBean
参数 参数类型 描述
job_id String 作业ID。
user String 提交作业的用户名称。
job_name String 作业名称。
job_result String 作业最终结果。
● FAILED：执行失败的作业
● KILLED：执行中被手动终止的作业。
● UNDEFINED：正在执行的作业。
● SUCCEEDED：执行成功的作业。
参数 参数类型 描述
job_state String 作业执行状态。
● FAILED：失败
● KILLED：已终止
● NEW：已创建
● NEW_SAVING：已创建保存中
● SUBMITTED：已提交
● ACCEPTED：已接受
● RUNNING：运行中
● FINISHED：已完成 job_progress Float 作业执行进度。
job_type String 作业类型。
● MapReduce
● SparkSubmit：SparkPython类型的作业在查 询时作业类型请选择SparkSubmit。
● HiveScript
● HiveSql
● DistCp，导入、导出数据。
● SparkScript
● SparkSql
● Flink
● FlinkSql
started_time Long 作业开始执行时间。单位：毫秒。
submitted_ti
me Long 作业提交时间。单位：毫秒。
finished_time Long 作业完成时间。单位：毫秒。
elapsed_time Long 作业执行时长。单位：毫秒。
arguments String 运行参数。
launcher_id String 实际作业编号。
properties String 配置参数，用于传-d参数。最多为2048字符，不 能包含><|'`&!\特殊字符，可为空。
app_id String 实际作业编号。
参数 参数类型 描述
tracking_url String 日志链接地址。当前仅SparkSubmit作业支持该 参数。
该参数基于集群的EIP访问集群中的YARN WebUI 页面，用户如果在VPC界面解绑EIP，MRS服务侧 数据会因为未更新导致该参数引用旧EIP导致访问 失败，可通过对集群重新进行EIP的绑定来修复该 问题。
queue String 作业的资源对列类型。
状态码： 500
表5-28 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
查询单个作业请求示例
GET https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}
响应示例
状态码： 200
查询单个作业信息成功
{ "job_detail" : {
"job_id" : "431b135e-c090-489f-b1db-0abe3822b855", "user" : "xxxx",
"job_name" : "pyspark1", "job_result" : "SUCCEEDED", "job_state" : "FINISHED", "job_progress" : "100", "job_type" : "SparkSubmit", "started_time" : "1564626578817", "submitted_time" : "1564626561541", "finished_time" : "1564626664930", "elapsed_time" : "86113",
"queue" : "default",
"arguments" : "[--class, org.apache.spark.examples.SparkPi, --driver-memory, 512MB, --num-executors, 1, --executor-cores, 1, --master, yarn-cluster, s3a://obs-test/jobs/spark/spark-examples_2.11-2.1.0.jar, 10000]", "launcher_id" : "application_1564622673393_0006",
"app_id" : "application_1564622673393_0007", "properties" : "{}"
}}
状态码： 500
查询单个作业信息失败
{ "error_msg" : "查询作业失败", "error_code" : "0162"
}
状态码
状态码 描述
200 查询单个作业信息成功 500 查询单个作业信息失败
错误码
请参见错误码。
5.2.4 终止作业
功能介绍
在MRS集群中终止指定作业。
接口约束
无
调试
您可以在API Explorer中调试该接口。
URI
POST /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}/kill
表5-29 路径参数
参数 是否必选 参数类型 描述
job_execution
_id 是 String 作业ID。获取方法，请参见获取
作业ID。
project_id 是 String 项目编号。获取方法，请参见获 取项目ID。
cluster_id 是 String 集群ID。获取方法，请参见获取 集群ID。
请求参数
无
响应参数
无
请求示例
终止作业请求示例
POST https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}/kill
响应示例
状态码： 500
在MRS集群中终止指定作业失败
{ "error_msg" : "终止作业失败", "error_code" : "0175"
}
状态码
状态码 描述
500 在MRS集群中终止指定作业失败
错误码
请参见错误码。