Viewing Job Instance Details

Updated on 2022-08-17 GMT+08:00

Function

This API is used to view job instance details, including the execution information about each node in a job instance.

URI

URI format
GET /v1/{project_id}/jobs/{job_name}/instances/{instance_id}

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.
instance_id	Yes	Long	Job instance ID.

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
jobName	Yes	String	Job name.
instanceId	Yes	Long	Job instance ID.
status	Yes	String	Job instance status. waiting running success fail running-exception pause manual-stop
planTime	Yes	Long	Planned execution time of the job instance.
startTime	Yes	Long	Actual execution start time of the job instance.
endTime	No	Long	Actual execution end time of the job instance.
executeTime	No	Long	Execution duration in milliseconds.
total	Yes	int	Total number of node records.
nodes	Yes	List<Node>	Node instance status. For details, see Table 4.

**Table 4** Node parameters
Parameter	Mandatory	Type	Description
nodeName	Yes	String	Node name.
status	Yes	String	Node status. waiting running success fail skip pause manual-stop
planTime	Yes	Long	Planned execution time of the job instance.
startTime	Yes	Long	Actual execution start time of the node.
endTime	No	Long	Actual execution end time of the node.
type	Yes	String	Node type.
retryTimes	No	Int	Number of attempts upon a failure.
instanceId	Yes	Long	Job instance ID.
inputRowCount	No	Long	Rows of input data.
speed	No	double	Write speed (row/second)
logPath	No	String	Path for storing node execution logs.

Example

View details about the instance whose ID is 34765 in job job_batch.

Request

GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/job_batch/instances/34765

Response

{
    "jobName":"job_batch",
    "instanceId":34765,
    
    "status":"fail",
    "planTime":1551425326540,
    "startTime":1551425327000,
    "endTime":1551425387000,
    "executeTime":1,
    "instanceId":30654,
    "total":2,
    "nodes":[
        {
            "endTime":1551671590000,
            "inputRowCount":0,
            "instanceId":34765,
            "nodeName":"Dummy_8556",
            
            "planTime":1551671580000,
            "retryTimes":0,
            "startTime":1551671584000,
            "status":"success",
            "submitTime":1550910278706,
            "type":"Dummy"
        },
        {
            "endTime":1551671598000,
            "inputRowCount":0,
            "instanceId":34765,
            "logPath":"obs://dlf-log-b384b9e9ab9b4ee8994c8633aabc9505/job_batch/2019-03-04 11_53_00.000/error/error.job",
            "nodeName":"error",
            
            "planTime":1551671580000,
            "retryTimes":0,
            "startTime":1551671594000,
            "status":"success",
            "submitTime":1550910278706,
            "type":"DWS SQL"
        }
    ]
}

Failure response

HTTP status code 400

{
    "error_code":"DLF.0137",
    "error_msg":"Job instance does not exist."
}

Parent topic: APIs to Be Taken Offline

Previous topic: Viewing a Job Instance List

Next topic: Querying a System Task

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