Querying Job Status on the Management Plane

Function

This API is used to query the execution status of a job. Asynchronous APIs that are used to create, stop, start, delete, and import graphs will return job IDs after commands are sent. You can query the job execution status according to the job IDs.

URI

GET /v1.0/{project_id}/graphs/{graph_id}/jobs/{job_id}/status

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.
graph_id	Yes	String	Graph ID
job_id	Yes	String	Job ID

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
jobId	String	Job ID
status	String	Job status: pending running success failed
jobType	String	Job type
jobName	String	Job name
relatedGraph	String	Associated graph name
beginTime	String	Job start time (UTC). The format is (yyyy-MM-dd HH:mm:ss).
endTime	String	Job end time (UTC). The format is (yyyy-MM-dd HH:mm:ss).
jobDetail	JobDetail object	This parameter is returned only when jobName is set to ImportGraph and is used to display graph import details.
failReason	String	Job failure cause
jobProgress	Double	Job execution progress. It is a reserved field, and not used currently.

**Table 4** JobDetail
Parameter	Type	Description
schemaPath	Array of schemaPath objects	Path for storing metadata
edgesetPath	Array of edgesetPath objects	Path for storing the edge data set
vertexsetPath	Array of vertexsetPath objects	Path for storing the vertex data set

**Table 5** schemaPath
Parameter	Type	Description
path	String	OBS storage path
log	String	Import log
status	String	OBS file status: success: Imported successfully. Failed: Failed to import the file. partFailed: Partially failed.
cause	String	Import failure cause

**Table 6** edgesetPath
Parameter	Type	Description
path	String	OBS storage path
log	String	Import log
status	String	OBS file status: success: Imported successfully. Failed: Failed to import the file. partFailed: Partially failed.
cause	String	Import failure cause
totalLines	Long	Total number of imported lines. The value -1 indicates that this field is not returned in the current version.
failedLines	Long	Lines failed to be imported. The value -1 indicates that this field is not returned in the current version.
successfulLines	Long	Lines imported successfully. The value -1 indicates that this field is not returned in the current version.

**Table 7** vertexsetPath
Parameter	Type	Description
path	String	OBS storage path
log	String	Import log
status	String	OBS file status: success: Imported successfully. Failed: Failed to import the file. partFailed: Partially failed.
cause	String	Import failure cause
totalLines	Long	Total number of imported lines. The value -1 indicates that this field is not returned in the current version.
failedLines	Long	Lines failed to be imported. The value -1 indicates that this field is not returned in the current version.
successfulLines	Long	Lines imported successfully. The value -1 indicates that this field is not returned in the current version.

Example Request

GET    https://Endpoint/v1.0/{project_id}/graphs/{graph_id}/jobs/{job_id}/status

Example Response

Status code: 200

Http Status Code: 200
{
  "jobId": "ff80808167f09aaa0167f19b35ec0305",
  "status": "success",
  "jobType": "GraphManagement",
  "jobName": "ImportGraph",
  "relatedGraph": "GES_UI_AUTO",
  "beginTime": "2018-11-27T21:39:00",
  "endTime": "2018-11-27T21:39:56",
  "jobDetail": {
    "vertexsetPath": [
      {
        "path": "ges-ui/auDatas/list_set_vertex.csv",
        "log": null,
        "cause": null,
        "status": "success"
      }
    ],
    "edgesetPath": [
      {
        "path": "ges-ui/auDatas/list_set_edge.csv",
        "log": null,
        "cause": null,
        "status": "success"
      }
    ],
    "schemaPath": [
      {
        "path": "ges-ui/auDatas/list_set_schema.xml",
        "log": null,
        "cause": null,
        "status": "success"
      }
    ]
  },
  "jobProgress": 0
}

Status code: 400

Bad Request

{
  "errorMessage" : "can not find job, jobId is ff808081646e81d40164c5fb414b2b1a1",
  "errorCode" : "GES.8301"
}

Status Code

Status Code	Description
200	OK
400	Bad Request

Parent topic: Task Center APIs

Previous topic: Task Center APIs

Next topic: Querying Job Details in the Job Center

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