查询作业列表信息
功能介绍
在MRS指定集群中查询作业列表信息。
接口约束
无
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/clusters/{cluster_id}/job-executions
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目编号。获取方法,请参见获取项目ID。 |
cluster_id |
是 |
String |
集群ID。获取方法,请参见获取集群ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
job_name |
否 |
String |
作业名称,只能由字母、数字、中划线和下划线组成,并且长度为1~128个字符。 |
job_id |
否 |
String |
作业ID,只能由字母、数字、中划线(-)组成,并且长度为1~64字符。 |
user |
否 |
String |
用户名称、只能由字母、数字、特殊字符(-_.)组成,且不能以数字开头,并且长度为1~32字符。 |
job_type |
否 |
String |
作业类型。
|
job_state |
否 |
String |
作业运行状态。
|
job_result |
否 |
String |
作业运行结果。
|
queue |
否 |
String |
作业的资源对列类型名称,作业的资源对列类型名称,只能由数字、字母和特殊字符(-_)组成, 并且长度为1~64字符。 |
limit |
否 |
String |
返回结果中每页显示条数。缺省值:10 |
offset |
否 |
String |
表示作业列表从该偏移量开始查询。缺省值:1 |
sort_by |
否 |
String |
返回结果的排序方式,默认值为desc。
|
submitted_time_begin |
否 |
Long |
查询该时间之后提交的作业,UTC的毫秒时间戳。例如:1562032041362。 |
submitted_time_end |
否 |
Long |
查询该时间之前提交的作业UTC的毫秒时间戳。例如:1562032041362。 |
请求参数
无
响应参数
状态码: 202
参数 |
参数类型 |
描述 |
---|---|---|
total_record |
Integer |
总记录数 |
job_list |
Array of JobQueryBean objects |
作业列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
作业ID。 |
user |
String |
提交作业的用户名称。 |
job_name |
String |
作业名称。 |
job_result |
String |
作业最终结果。
|
job_state |
String |
作业执行状态。
|
job_progress |
Float |
作业执行进度。 |
job_type |
String |
作业类型。
|
started_time |
Long |
作业开始执行时间。单位:毫秒。 |
submitted_time |
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 |
作业的资源对列类型。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
查询作业列表信息请求示例
GET https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/job-executions
响应示例
状态码: 202
查询作业列表信息成功
{ "total_record" : 2, "job_list" : [ { "job_id" : "981374c1-85da-44ee-be32-edfb4fba776c", "user" : "xxxx", "job_name" : "SparkSubmitTset", "job_result" : "UNDEFINED", "job_state" : "ACCEPTED", "job_progress" : 0, "job_type" : "SparkSubmit", "started_time" : 0, "submitted_time" : 1564714763119, "finished_time" : 0, "elapsed_time" : 0, "queue" : "default", "arguments" : "[--class, --driver-memory, --executor-cores, --master, yarn-cluster, s3a://obs-test/hadoop-mapreduce-examples-3.1.1.jar, dddd]", "launcher_id" : "application_1564622673393_0613", "properties" : { } }, { "job_id" : "c54c8aa0-c277-4f83-8acc-521d85cfa32b", "user" : "xxxx", "job_name" : "SparkSubmitTset2", "job_result" : "UNDEFINED", "job_state" : "ACCEPTED", "job_progress" : 0, "job_type" : "SparkSubmit", "started_time" : 0, "submitted_time" : 1564714020099, "finished_time" : 0, "elapsed_time" : 0, "queue" : "default", "arguments" : "[--conf, yujjsjhe, --driver-memory, yueujdjjd, --master,\nyarn-cluster,\ns3a://obs-test/hadoop-mapreduce-examples-3.1.1.jar]", "launcher_id" : "application_1564622673393_0611", "properties" : { } } ] }
状态码: 400
查询作业列表信息失败
{ "error_msg" : "查询作业列表失败", "error_code" : "0166" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.mrs.v2.region.MrsRegion; import com.huaweicloud.sdk.mrs.v2.*; import com.huaweicloud.sdk.mrs.v2.model.*; public class ShowJobExeListNewSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); MrsClient client = MrsClient.newBuilder() .withCredential(auth) .withRegion(MrsRegion.valueOf("<YOUR REGION>")) .build(); ShowJobExeListNewRequest request = new ShowJobExeListNewRequest(); request.withJobName("<job_name>"); request.withJobId("<job_id>"); request.withUser("<user>"); request.withJobType("<job_type>"); request.withJobState(ShowJobExeListNewRequest.JobStateEnum.fromValue("<job_state>")); request.withJobResult(ShowJobExeListNewRequest.JobResultEnum.fromValue("<job_result>")); request.withQueue("<queue>"); request.withLimit("<limit>"); request.withOffset("<offset>"); request.withSortBy("<sort_by>"); request.withSubmittedTimeBegin(<submitted_time_begin>L); request.withSubmittedTimeEnd(<submitted_time_end>L); try { ShowJobExeListNewResponse response = client.showJobExeListNew(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkmrs.v2.region.mrs_region import MrsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmrs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = MrsClient.new_builder() \ .with_credentials(credentials) \ .with_region(MrsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowJobExeListNewRequest() request.job_name = "<job_name>" request.job_id = "<job_id>" request.user = "<user>" request.job_type = "<job_type>" request.job_state = "<job_state>" request.job_result = "<job_result>" request.queue = "<queue>" request.limit = "<limit>" request.offset = "<offset>" request.sort_by = "<sort_by>" request.submitted_time_begin = <submitted_time_begin> request.submitted_time_end = <submitted_time_end> response = client.show_job_exe_list_new(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" mrs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := mrs.NewMrsClient( mrs.MrsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowJobExeListNewRequest{} jobNameRequest:= "<job_name>" request.JobName = &jobNameRequest jobIdRequest:= "<job_id>" request.JobId = &jobIdRequest userRequest:= "<user>" request.User = &userRequest jobTypeRequest:= "<job_type>" request.JobType = &jobTypeRequest jobStateRequest:= model.GetShowJobExeListNewRequestJobStateEnum().<JOB_STATE> request.JobState = &jobStateRequest jobResultRequest:= model.GetShowJobExeListNewRequestJobResultEnum().<JOB_RESULT> request.JobResult = &jobResultRequest queueRequest:= "<queue>" request.Queue = &queueRequest limitRequest:= "<limit>" request.Limit = &limitRequest offsetRequest:= "<offset>" request.Offset = &offsetRequest sortByRequest:= "<sort_by>" request.SortBy = &sortByRequest submittedTimeBeginRequest:= int64(<submitted_time_begin>) request.SubmittedTimeBegin = &submittedTimeBeginRequest submittedTimeEndRequest:= int64(<submitted_time_end>) request.SubmittedTimeEnd = &submittedTimeEndRequest response, err := client.ShowJobExeListNew(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
202 |
查询作业列表信息成功 |
400 |
查询作业列表信息失败 |
错误码
请参见错误码。