Canceling a HyG Job

Function

This API is used to cancel a submitted HyG job. (Currently, only jobs in a queue can be canceled.)

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For how to obtain the project ID, see Obtaining a Project ID.
graph_name	Yes	String	Graph name
job_id	Yes	String	Job ID of the algorithm task in the response result

Request Parameters

None

Response Parameters

**Table 2** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error message.
errorCode	String	System prompt code If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error code.
result	String	Execution results If the execution is successful, the value is success. If the execution fails, the value is failed.

Example Request

Example request 1: Cancel a submitted job.

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

Example request 2: Cancel all jobs in a queue.
```
DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/jobs
```
SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.

Example Response

Status code: 200

Example response for a successful request

Http Status Code: 200
{
    "result": "success"
}

Status code: 400

Example response for a failed request

HttpStatusCode: 400
{
"errorMessage": "Graph [
{project_id}
-movie1] does not exist, please check project_id and graph_name.",
"errorCode": "GES.8000",
"result": "failed"
}

Status Codes

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.