Help Center/MapReduce Service/API Reference/Out-of-Date APIs/Job API Management (Deprecated)/Querying the exe Object List of Jobs (Deprecated)
Updated on 2025-04-09 GMT+08:00
View PDF

Querying the exe Object List of Jobs (Deprecated)

Function

This API is used to query the exe object list of all jobs. This API is incompatible with Sahara.

URI

  • Format

    GET /v1.1/{project_id}/job-exes

  • Parameter description
    Table 1 URI parameter

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Explanation

    The project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    Constraints

    N/A

    Value range

    N/A

    Default value

    N/A

Request Parameters

Table 2 Request parameters

Parameter

Mandatory

Type

Description

page_size

No

String

Explanation

Maximum number of jobs displayed on a page

Constraints

N/A

Value range

1 to 100

Default value

N/A

current_page

No

String

Explanation

Current page number

Constraints

N/A

Value range

N/A

Default value

N/A

job_name

No

String

Explanation

Job name

Constraints

N/A

Value range

N/A

Default value

N/A

cluster_id

Yes

String

Explanation

Cluster ID

Constraints

N/A

Value range

N/A

Default value

N/A

state

No

String

Explanation

Job status code

Constraints

N/A

Value range

  • -1: Terminated
  • 2: Running
  • 3: Completed
  • 4: Abnormal

Default value

N/A

id

No

String

Explanation

Job execution object ID

Constraints

N/A

Value range

N/A

Default value

N/A

Response Parameters

Table 3 Response parameters

Parameter

Type

Description

totalRecord

Integer

Explanation

The total number of jobs in the job list.

Constraints

N/A

Value range

N/A

Default value

N/A

job_executions

Array

Explanation

Job list parameter

For details, see Table 4.

Constraints

N/A

Value range

N/A

Default value

N/A

Table 4 job_executions parameters

Parameter

Type

Description

id

String

Explanation

Job ID.

Constraints

N/A

Value range

N/A

Default value

N/A

create_at

Long

Explanation

Creation time, which is a 13-bit timestamp.

Constraints

N/A

Value range

N/A

Default value

N/A

update_at

Long

Explanation

Update time, which is a 13-bit timestamp.

Constraints

N/A

Value range

N/A

Default value

N/A

tenant_id

String

Explanation

The project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Value range

N/A

Default value

N/A

job_id

String

Explanation

Job ID

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

start_time

Long

Explanation

Start time of job execution, which is a 13-bit timestamp.

Constraints

N/A

Value range

N/A

Default value

N/A

end_time

Long

Explanation

End time of job execution, which is a 13-bit timestamp.

Constraints

N/A

Value range

N/A

Default value

N/A

cluster_id

String

Explanation

Cluster ID of a job

Constraints

N/A

Value range

N/A

Default value

N/A

group_id

String

Explanation

Group ID of a job

Constraints

N/A

Value range

N/A

Default value

N/A

jar_path

String

Explanation

Path of the .jar file or .sql file for program execution

Constraints

N/A

Value range

N/A

Default value

N/A

input

String

Explanation

Address for inputting data

Constraints

N/A

Value range

N/A

Default value

N/A

output

String

Explanation

Address for outputting data

Constraints

N/A

Value range

N/A

Default value

N/A

job_log

String

Explanation

Address for storing job logs

Constraints

N/A

Value range

N/A

Default value

N/A

job_type

Integer

Explanation

Job type code

Constraints

N/A

Value range

  • 1: MapReduce
  • 2: Spark
  • 3: Hive Script
  • 4: HiveSQL (not supported currently)
  • 5: DistCp
  • 6: Spark Script
  • 7: Spark SQL (not supported in this API currently)

Default value

N/A

file_action

String

Explanation

Data import and export

Constraints

N/A

Value range

N/A

Default value

N/A

arguments

String

Explanation

Key parameters for program execution.

Constraints

This parameter is specified by a function in your program. MRS is responsible for passing the parameter only.

Value range

This parameter can be empty.

Default value

N/A

hql

String

Explanation

HiveQL statement

Constraints

N/A

Value range

N/A

Default value

N/A

job_state

Integer

Explanation

Job status code

Constraints

N/A

Value range

  • -1: Terminated
  • 2: Running
  • 3: Completed
  • 4: Abnormal

Default value

N/A

job_final_status

Integer

Explanation

Final job status

  • 0: unfinished
  • 1: terminated due to an execution error
  • 2: executed successfully
  • 3: canceled

Constraints

N/A

Value range

N/A

Default value

N/A

hive_script_path

String

Explanation

Address of the Hive script

Constraints

N/A

Value range

N/A

Default value

N/A

create_by

String

Explanation

User ID for creating jobs

Constraints

N/A

Value range

N/A

Default value

N/A

finished_step

Integer

Explanation

Number of completed steps

Constraints

N/A

Value range

N/A

Default value

N/A

job_main_id

String

Explanation

Main ID of a job

Constraints

N/A

Value range

N/A

Default value

N/A

job_step_id

String

Explanation

Step ID of a job

Constraints

N/A

Value range

N/A

Default value

N/A

postpone_at

Long

Explanation

Delay time, which is a 13-bit timestamp.

Constraints

N/A

Value range

N/A

Default value

N/A

step_name

String

Explanation

Step name of a job

Constraints

N/A

Value range

N/A

Default value

N/A

step_num

Integer

Explanation

Number of steps

Constraints

N/A

Value range

N/A

Default value

N/A

task_num

Integer

Explanation

Number of tasks

Constraints

N/A

Value range

N/A

Default value

N/A

update_by

String

Explanation

User ID for updating jobs

Constraints

N/A

Value range

N/A

Default value

N/A

spend_time

Float

Explanation

Duration of job execution (unit: s)

Constraints

N/A

Value range

N/A

Default value

N/A

step_seq

Integer

Explanation

Step sequence of a job

Constraints

N/A

Value range

N/A

Default value

N/A

progress

String

Explanation

Job execution progress

Constraints

N/A

Value range

N/A

Default value

N/A

Example Request

Query the exe object list of jobs.

GET https://{endpoint}/v1.1/{project_id}/job-exes?page_size=10&current_page=1&state=3&job_name=myfirstjob&clusterId=20ca8601-72a2-4570-b788-2a20fec81a95

Example Response

Status code: 200

The exe object list of jobs is queried.

{
  "totalRecord" : "14",
  "job_executions" : [ {
    "id" : "669476bd-89d2-45aa-8f1a-872d16de377e",
    "create_at" : "1484641003707",
    "update_at" : "1484641003707",
    "tenant_id" : "3f99e3319a8943ceb15c584f3325d064",
    "job_id" : "",
    "job_name" : "myfirstjob",
    "start_time" : "1484641003707",
    "end_time" : null,
    "cluster_id" : "2b460e01-3351-4170-b0a7-57b9dd5ffef3",
    "group_id" : "669476bd-89d2-45aa-8f1a-872d16de377e",
    "jar_path" : "s3a://jp-test1/program/hadoop-mapreduce-examples-2.4.1.jar",
    "input" : "s3a://jp-test1/input/",
    "output" : "s3a://jp-test1/output/",
    "job_log" : "s3a://jp-test1/joblogs/",
    "job_type" : "1",
    "file_action" : "",
    "arguments" : "wordcount",
    "hql" : "",
    "job_state" : "2",
    "job_final_status" : "1",
    "hive_script_path" : null,
    "create_by" : "3f99e3319a8943ceb15c584f3325d064",
    "finished_step" : "0",
    "job_main_id" : "",
    "job_step_id" : "",
    "postpone_at" : "1484641003174",
    "step_name" : "",
    "step_num" : "0",
    "task_num" : "0",
    "update_by" : "3f99e3319a8943ceb15c584f3325d064",
    "spend_time" : null,
    "step_seq" : "222",
    "progress" : "first progress"
  } ]
}

Status Codes

Table 5 describes the status code.

Table 5 Status code

Status Code

Description

200

The exe object list of jobs is queried.

See Status Codes.

Error Codes

For details, see Error Codes.