Querying a List of Jobs - ShowSingleJob

Function

This API is used to query jobs submitted on the job management page in a specified MRS cluster.

Constraints

None

Debugging

You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and supports sample SDK code debugging.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

• If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
• If you are using identity policy-based authorization, the following identity policy-based permissions are required.

  Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependency
  mrs:cluster:getJob	Read	cluster *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	mrs:job:get	-

URI

• Format

  GET /v2/{project_id}/clusters/{cluster_id}/job-executions

• Parameter description

  Table 1 URI parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Explanation Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Value range The value must consist of 1 to 64 characters. Only letters and digits are allowed. Default value N/A
  cluster_id	Yes	String	Explanation Cluster ID. If this parameter is specified, the latest metadata of the cluster that has been patched will be obtained. For details about how to obtain the cluster ID, see Obtaining a Cluster ID. Constraints N/A Value range The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). Default value N/A

  Table 2 Query parameters

  Parameter	Mandatory	Type	Description
  job_name	No	String	Explanation Job name. Constraints N/A Value range The value can contain 1 to 128 characters, including only letters, digits, underscores (_), and hyphens (-). Default value N/A
  job_id	No	String	Explanation Job ID. Constraints N/A Value range The value can contain 1 to 64 characters, including only letters, digits, and hyphens (-). Default value N/A
  user	No	String	Explanation Username. Constraints N/A Value range The value can contain 1 to 32 characters, including only letters, digits, hyphens (-), underscores (_), and periods (.), and cannot start with a digit. Default value N/A
  job_type	No	String	Explanation Job type. Constraints N/A Value range MapReduce: provides a distributed data processing model and execution environment capable of rapidly handling large-scale data in parallel. With MRS, you can submit MapReduce JAR programs. SparkSubmit: allows you to submit Spark JAR and Spark Python programs and run Spark applications to compute and process user data. SparkPython: SparkPython jobs are converted to SparkSubmit jobs for submission. On the MRS console, the job type is displayed as SparkSubmit. When calling an API to query the job list, select SparkSubmit. HiveScript: an open-source data warehouse that runs on Hadoop. With MRS, you can submit HiveScript scripts for execution. HiveSql: an open-source data warehouse that runs on Hadoop. With MRS, you can directly execute Hive SQL statements. DistCp: a Hadoop tool used to efficiently import and export data between distributed file systems (such as HDFS). SparkScript: allows you to submit SparkScript scripts and batch execute Spark SQL statements. SparkSql: allows you to run SQL-like statements provided by Spark to query and analyze user data in real time. Flink: a distributed big data processing engine that can perform stateful computations over both unbounded and bounded data streams. Default value N/A
  job_state	No	String	Explanation The job execution status. Constraints N/A Value range FAILED: indicates that the job fails to be executed. KILLED: indicates that the job is terminated. New: indicates that the job is created. NEW_SAVING: indicates that the job has been created and is being saved. SUBMITTED: indicates that the job is submitted. ACCEPTED: indicates that the job is accepted. RUNNING: indicates that the job is running. FINISHED: indicates that the job is completed. Default value N/A
  job_result	No	String	Explanation Job execution result. Constraints N/A Value range FAILED: indicates that the job fails to be executed. KILLED: indicates that the job is manually terminated during execution. UNDEFINED: indicates that the job is being executed. SUCCEEDED: indicates that the job has been successfully executed. Default value N/A
  queue	No	String	Explanation Resource queue type of a job. Constraints N/A Value range The value can contain a maximum of 64 characters, including only letters, digits, hyphens (-), and underscores (_). The default value is default. Default value N/A
  limit	No	String	Explanation Number of records displayed on each page in the returned result. Constraints N/A Value range N/A Default value 10
  offset	No	String	Explanation Offset from which the job list starts to be queried. Constraints N/A Value range N/A Default value 1
  sort_by	No	String	Explanation Sorting method of the returned result. Constraints N/A Value range asc: indicates that the returned results are sorted in ascending order. desc: indicates that the returned results are sorted in descending order. Default value desc
  submitted_time_begin	No	Long	Explanation UTC timestamp after which a job is submitted, in milliseconds, for example, 1562032041362. Constraints N/A Value range N/A Default value N/A
  submitted_time_end	No	Long	Explanation UTC timestamp before which a job is submitted, in milliseconds, for example, 1562032041362. Constraints N/A Value range N/A Default value N/A

Request Parameters

None

Response Parameters

Status code: 202

Status code: 400

Example Response

Status code: 202

Querying a list of jobs is successful.

{
  "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" : { }
  } ]
}

Status code: 400

Failed to query a list of jobs.

{
  "error_msg": "Failed to query the job list."
  "error_code" : "0166"
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.