Viewing Running Status of a Real-Time Job

Function

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

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, no identity policy-based permission required for calling this API.

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 Parameters

**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. NOTE: You need to specify a workspace for multiple DataArts Studio instances. This parameter is mandatory if no default workspace is available. If you do not set it, an error is reported.

Response Parameters

**Table 3** Response parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Solution name
nodes	No	List	Node status list
status	No	String	Job status STARTING: The job is starting. NORMAL: The job is normal. EXCEPTION: The job is abnormal. STOPPING: The job is being stopped. STOPPED: The job is stopped.
startTime	Yes	Date	Start time
endTime	No	Date	End time
lastUpdateTime	No	Date	Last update time
createUser	No	String	Creator
lastModifiyUser	No	String	Last modifier

**Table 4** Data structure description of **nodes**
Parameter	Mandatory	Type	Description
name	Yes	String	Node name
status	No	String	Node status. STARTING: The node is starting. NORMAL: The node is normal. EXCEPTION: The node is abnormal. STOPPING: The node is being stopped. STOPPED: The node is 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. DLI SQL: runs DLI SQL scripts. Shell: runs shell SQL scripts. CDM Job: runs CDM jobs. DIS Transfer Task: creates DIS dump tasks. CS Job: creates and starts CloudStream jobs. CloudTable Manager: manages CloudTable tables, including creating and deleting tables. 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.
lastInstanceStatus	Yes	String	Instance execution status of the last time
speed	No	double	Write rate
runningData	No	String	Data stored in the node during execution
totalPutBytes	No	long	Total number of written (output) bytes
bufferRecords	No	long	Number of records in the buffer
jobInstanceId	Yes	long	Node instance ID
extendCounter	No	String	Extended counter
totalGetBytes	No	long	Total number of read (input) bytes
totalPutRecords	No	long	Total number of written records
totalGetRecords	No	long	Total number of read records

Example Request

View running status of real-time job job_sms and the running status of each node in the job.

GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/job_sms/status

Example Response

Success response

{
    "name": "job_sms",
    "nodes": [
        {
            "bufferRecords": 0,
            "jobInstanceId": 0,
            "LastInstanceStatus": "waiting",
            "name": "MRS_Flink_Job_8635",
            "speed": 0,
            "totalGetBytes": 0,
            "totalGetRecords": 0,
            "totalPutBytes": 0,
            "totalPutRecords": 0
        }
    ],
    "status": "NORMAL"
}

Failure response

HTTP status code 400

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

Parent Topic: Job Development APIs

Previous topic: Rerunning a Job Instance

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.See the reply and handling status in My Cloud VOC.

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

For any further questions, feel free to contact us through the chatbot.

Chatbot