Canceling a Job

Function

This API is used to cancel a job that has been submitted.

Note

Only jobs returned by the following APIs can be canceled: exporting a graph, importing a graph, querying vertices that meet filter criteria, querying edges that meet filter criteria, edge filtering query, Filtered-query V2, executing an algorithm, and adding an index.

URI

DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}

Table 1 URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
job_id	Yes	String	Job ID
graph_name	Yes	String	Graph name

Request Parameters

For details, see the URI parameters.

Response Parameters

Table 2 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 code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.

Example Request

Cancel a job that has been submitted.

DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}

Note

SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.

Example Response

Status code: 200

Example response (successful request)

Http Status Code: 200
{ }

Status code: 400

Example response for a failed request

Http Status Code: 400
{
 
"errorMessage": "can not find job to cancel, id is 9440a7ebXXXXXXXXXXXXXXXXXXXX2d079a67001679122",
 
"errorCode": "GES.8303"
}

Status Code

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authorization failed.
403 Forbidden	No operation permissions.
404 Not Found	No resources found.
500 Internal Server Error	Internal server error.
503 Service Unavailable	Service unavailable.

Error Code

See Error Code.

Parent topic: Job Management APIs

Предыдущая статья

Querying Job Status on the Service Plane

Следующая статья

Exporting Job Execution Results to Files

Была ли эта статья полезна?

Поддержка Юридические документы