Yang, Tong bd2b57f749 MRS API 2.0.38.SP20 version

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Yang, Tong <yangtong2@huawei.com>
Co-committed-by: Yang, Tong <yangtong2@huawei.com>

2022-11-16 15:06:08 +00:00

25 KiB

Raw Blame History

Querying exe Object Details

Function

This API is used to query detailed information about the exe object of a job. This API is incompatible with Sahara.

URI

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

Parameter description

**Table 1** URI parameter description
Parameter	Mandatory	Description
project_id	Yes	Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.
job_exe_id	Yes	Job ID

Request

Request parameters

None.

Response

**Table 2** Response parameter description
Parameter	Type	Description
job_execution	Object	For details, see Table 3.

**Table 3** **job_execution** parameter description
Parameter	Type	Description
id	String	Job ID
create_at	Integer	Creation time, which is a 13-bit timestamp.
update_at	Integer	Update time, which is a 13-bit timestamp.
tenant_id	String	Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.
job_id	String	Job ID
job_name	String	Job name
start_time	Integer	Start time of job execution, which is a 13-bit timestamp.
end_time	Integer	End time of job execution, which is a 13-bit timestamp.
cluster_id	String	Cluster ID of a job
group_id	String	Group ID of a job
jar_path	String	Path of the .jar file or .sql file for program execution
input	String	Address for inputting data
output	String	Address for outputting data
job_log	String	Address for storing job logs
job_type	Integer	Job type code 1: MapReduce 2: Spark 3: Hive Script 4: HiveQL (not supported currently) 5: DistCp 6: Spark Script 7: Spark SQL (not supported in this API currently)
file_action	String	Data import and export
arguments	String	Key parameter for program execution. The parameter is specified by the function of the user's program. MRS is only responsible for loading the parameter. This parameter can be empty.
hql	String	HiveQL statement
job_state	Integer	Job status code -1: Terminated 1: Starting 2: Running 3: Completed 4: Abnormal 5: Error
job_final_status	Integer	Final job status 0: unfinished 1: terminated due to an execution error 2: executed successfully 3: canceled
hive_script_path	String	Address of the Hive script
create_by	String	User ID for creating jobs
finished_step	Integer	Number of completed steps
job_main_id	String	Main ID of a job
job_step_id	String	Step ID of a job
postpone_at	Integer	Delay time, which is a 13-bit timestamp.
step_name	String	Step name of a job
step_num	Integer	Number of steps
task_num	Integer	Number of tasks
update_by	String	User ID for updating jobs
spend_time	Integer	Duration of job execution (unit: s)
step_seq	Integer	Step sequence of a job
progress	String	Job execution progress

Example

Example request
None.

Example response

{
    "job_execution": {
        "id": "632863d5-15d4-4691-9dc1-1a72340cb097", 
        "create_at": 1484240559176, 
        "update_at": 1484240559176, 
        "tenant_id": "3f99e3319a8943ceb15c584f3325d064", 
        "job_id": "632863d5-15d4-4691-9dc1-1a72340cb097", 
        "job_name": "hive_script", 
        "start_time": 1484240559176, 
        "end_time": null, 
        "cluster_id": "8b1d55f6-150e-45e2-8347-b2ca608d366b", 
        "group_id": "632863d5-15d4-4691-9dc1-1a72340cb097", 
        "jar_path": "s3a://jp-test1/program/Hivescript.sql", 
        "input": "s3a://jp-test1/input/", 
        "output": "s3a://jp-test1/output/", 
        "job_log": "s3a://jp-test1/joblogs/", 
        "job_type": 3, 
        "file_action": "", 
        "arguments": "wordcount", 
        "hql": null, 
        "job_state": 3, 
        "job_final_status": 1, 
        "hive_script_path": "s3a://jp-test1/program/Hivescript.sql", 
        "create_by": "3f99e3319a8943ceb15c584f3325d064", 
        "finished_step": 0, 
        "job_main_id": "", 
        "job_step_id": "", 
        "postpone_at": 1484240558705, 
        "step_name": "", 
        "step_num": 0, 
        "task_num": 0, 
        "update_by": "3f99e3319a8943ceb15c584f3325d064", 
        "spend_time": null, 
        "step_seq": 222, 
        "progress": "first progress"
    }
}

Status Code

Table 4 describes the status code of this API.

**Table 4** Status code
Status code	Description
200	The exe object details are queried successfully.

For the description about error status codes, see Status Codes.

Parent topic: Job Object APIs (V1, Not Recommended)

25 KiB Raw Blame History