doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0095.html

Viewing Job Instance Details

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. For details about how to obtain the ID, see the response parameters in Viewing a Job Instance List.

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.

Response Parameters

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.
forceSuccess	No	boolean	Whether the job instance status is forcibly successful Default value: false
ignoreSuccess	No	boolean	Whether the job instance status is failure ignored Default value: false

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 Request

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

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

Example Response

• Success response

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

• Failure response

  HTTP status code 400

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

Parent topic: Job Development APIs