Viewing Running Status of a Real-Time Job

Updated on 2022-09-15 GMT+08:00

View PDF

Function

This API is used to view running status of a real-time job.

URI

URI format
GET /v1/{project_id}/jobs/{job_name}/status

Parameter description

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Project ID and Account ID.
job_name	Yes	String	Job name.

Request

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
workspace	No	String	Workspace ID. If this parameter is not set, data in the default workspace is queried by default. To query data in other workspaces, this header must be carried.

Response

**Table 3** Response parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Name of a solution.
nodes	No	List	Node status list.
status	No	String	Job status. STARTING NORMAL EXCEPTION STOPPING STOPPED
startTime	Yes	Date	Start time.
endTime	No	Date	End time.
lastUpdateTime	No	Date	Last update time.

**Table 4** Data structure description of **nodes**
Parameter	Mandatory	Type	Description
name	Yes	String	Node name.
status	No	String	Node status. STARTING NORMAL EXCEPTION STOPPING STOPPED
logPath	No	String	Path for storing node run logs.
type	Yes	String	Node type. Hive SQL: Runs Hive SQL scripts. Spark SQL: Runs Spark SQL scripts. DWS SQL: Runs DWS SQL scripts. Shell: Runs shell SQL scripts. CDM Job: Runs CDM jobs. OBS Manager: Manages OBS paths, including creating and deleting paths. RESTAPI: Sends REST API requests. SMN: Sends short messages or emails. MRS Spark: Runs Spark jobs of MRS. MapReduce: Runs MapReduce jobs of MRS.

Example

View running status of real-time job job_sms and the running status of each node in the job. job_sms has seven nodes, as shown in the following figure:

Figure 1 job_sms

Request

GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/job_sms/status

Success response (The DLI_SMS_GES node runs abnormally during job running.)

{
	"lastUpdateTime": 1551409406000,
	"name": "job_sms",
	"nodes": [{
		"name": "CREATE_GES_DIR",
		"status": "NORMAL",
		"totalGetBytes": 0,
		"totalGetRecords": 0,
		"totalPutBytes": 0,
		"totalPutRecords": 0,
		"type": "Create OBS"
	},
	{
		"logPath": "obs://dlf-log-b384b9e9ab9b4ee8994c8633aabc9505/job_sms/2019-03-01 11_04_24.000/CS_SMS_PROCESS/CS_SMS_PROCESS-IrU8hS82_20190301_110433_183.job",
		"name": "CS_SMS_PROCESS",
		"runningData": "{\"jobName\":\"CS_SMS_PROCESS\",\"jobId\":\"107016\",\"App_dis-input\":\"app_sms_process\"}",
		"status": "NORMAL",
		"totalGetBytes": 0,
		"totalGetRecords": 165,
		"totalPutBytes": 0,
		"totalPutRecords": 165,
		"type": "ExecuteCloudStream"
	},
	{
		"name": "DELETE_GES_DIR",
		"status": "STOPPED",
		"totalGetBytes": 0,
		"totalGetRecords": 0,
		"totalPutBytes": 0,
		"totalPutRecords": 0,
		"type": "Delete OBS"
	},
	{
		"logPath": "obs://dlf-log-b384b9e9ab9b4ee8994c8633aabc9505/job_sms/2019-03-01 11_04_24.000/DIS_EVENT/DIS_EVENT-kefeNV5B_20190301_110439_984.job",
		"name": "DIS_EVENT",
		"runningData": "{\"app\":\"DLF_job_sms_DLI_SMS_PROCESS\",\"streamName\":\"dis-event\"}",
		"status": "NORMAL",
		"totalGetBytes": 0,
		"totalGetRecords": 8602,
		"totalPutBytes": 0,
		"totalPutRecords": 8596,
		"type": "ExecuteDISStream"
	},
	{
		"logPath": "obs://dlf-log-b384b9e9ab9b4ee8994c8633aabc9505/job_sms/2019-03-01 11_04_24.000/DIS_INPUT/DIS_INPUT-T18JOYTc_20190301_110428_754.job",
		"name": "DIS_INPUT",
		"runningData": "{\"streamName\":\"dis-input\"}",
		"status": "NORMAL",
		"totalGetBytes": 0,
		"totalGetRecords": 70341,
		"totalPutBytes": 0,
		"totalPutRecords": 70341,
		"type": "ExecuteDISStream"
	},
	{
		"name": "DLI_SMS_GES",
		"status": "EXCEPTION",
		"totalGetBytes": 0,
		"totalGetRecords": 0,
		"totalPutBytes": 0,
		"totalPutRecords": 0,
		"type": "DLI SQL"
	},
	{
		"name": "DLI_SMS_PROCESS",
		"status": "NORMAL",
		"totalGetBytes": 0,
		"totalGetRecords": 208,
		"totalPutBytes": 0,
		"totalPutRecords": 208,
		"type": "DLI SQL"
	}],
	"startTime": 1551409465000,
	"status": "NORMAL"
}

Failure response

HTTP status code 400

{
    "error_code":"DLF.0100",
    "error_msg":"The job does not exists."
}

Parent topic: APIs to Be Taken Offline

Previous topic: Starting a Job

Next topic: Viewing a Job Instance List

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel