Help Center/ MapReduce Service/ API Reference/ API V2/ Job Management APIs/ Querying Information About a Job
Updated on 2024-12-10 GMT+08:00
View PDF
Share

Querying Information About a Job

Function

This API is used to query information about a specified job in an 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 provide the sample SDK code debugging.

URI

  • Format

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

  • 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

    job_execution_id

    Yes

    String

    Explanation

    The job ID. For details about how to obtain the job ID, see Obtaining a Job ID.

    Constraints

    N/A

    Value range

    N/A

    Default value

    N/A

Request Parameters

None

Response Parameters

Status code: 202

Table 2 Response parameter

Parameter

Type

Description

job_detail

JobQueryBean object

Explanation

Job details. For details about the parameter, see Table 3.

Constraints

N/A

Value range

N/A

Default value

N/A
Table 3 Job parameters

Parameter

Type

Description

job_id

String

Explanation

The job ID.

Constraints

N/A

Value range

N/A

Default value

N/A

user

String

Explanation

Name of the user who submits a job.

Constraints

N/A

Value range

N/A

Default value

N/A

job_name

String

Explanation

Job name.

Constraints

N/A

Value range

N/A

Default value

N/A

job_result

String

Explanation

Final result of a job.

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

job_state

String

Explanation

Job execution status.

Constraints

N/A

Value range

  • FAILED: indicates that the job failed.
  • 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_progress

Float

Explanation

Job execution progress.

Constraints

N/A

Value range

N/A

Default value

N/A

job_type

String

Explanation

Job type.

Constraints

N/A

Value range

  • MapReduce
  • SparkSubmit: Select this value when you call an API to query SparkPython jobs.
  • HiveScript
  • HiveSql
  • DistCp: imports and exports data.
  • SparkScript
  • SparkSql
  • Flink

Default value

N/A

started_time

Long

Explanation

Time when a job starts to execute. Unit: milliseconds

Constraints

N/A

Value range

N/A

Default value

N/A

submitted_time

Long

Explanation

Time when a job is submitted. Unit: milliseconds

Constraints

N/A

Value range

N/A

Default value

N/A

finished_time

Long

Explanation

Time when a job was completed. Unit: milliseconds

Constraints

N/A

Value range

N/A

Default value

N/A

elapsed_time

Long

Explanation

Running duration of a job. Unit: milliseconds

Constraints

N/A

Value range

N/A

Default value

N/A

arguments

String

Explanation

Running parameter.

Constraints

N/A

Value range

N/A

Default value

N/A

properties

String

Explanation

Configuration parameter, which is used to configure -d parameters.

Constraints

N/A

Value range

N/A

Default value

N/A

launcher_id

String

Explanation

Real-life job ID.

Constraints

N/A

Value range

N/A

Default value

N/A

app_id

String

Explanation

Actual job ID.

Constraints

N/A

Value range

N/A

Default value

N/A

tracking_url

String

Explanation

The URL for accessing logs. Currently, only SparkSubmit jobs support this parameter. This parameter accesses the Yarn Web UI via the EIP bound to the cluster. If the EIP is unbound from the cluster on the VPC console, the MRS service data is not updated in a timely manner and the access fails. In this case, you can bind the EIP to the cluster again to rectify the fault.

Constraints

N/A

Value range

N/A

Default value

N/A

queue

String

Explanation

The type of the resource queue used by a job.

Constraints

N/A

Value range

N/A

Default value

N/A

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Explanation

Error code.

Constraints

N/A

Value range

N/A

Default value

N/A

error_msg

String

Explanation

Error message.

Constraints

N/A

Value range

N/A

Default value

N/A

Example Request

Query information about a job.

GET https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}

Example Response

Status code: 202

Job information successful queried.

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

Status code: 400

Failed to query information about a job.

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

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Job Management APIs