Help Center> Graph Engine Service> API Reference> Service Plane APIs> Job Management APIs> Canceling a Job (1.0.0)
View PDF

Canceling a Job (1.0.0)

Function

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

Job IDs returned by asynchronous APIs that are used to query vertices or edges that meet filter criteria, run algorithms, and add indexes can be canceled. If the job execution is complete or fails, you cannot cancel this job.

Only jobs returned by APIs used to query vertices or edges that meet filter criteria, run algorithms, and add indexes can be canceled. If you cancel jobs returned by other APIs, an error message stating Unsupported Operation is reported.

URI

  • URI format 
    DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}
  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.

    job_id

    Yes

    String

    Job ID

    graph_name

    Yes

    String

    Graph name

Request

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

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

Response

  • Parameter description
    Table 2 Parameter description

    Parameter

    Mandatory

    Type

    Description

    errorMessage

    No

    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

    No

    String

    System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
  • Response example (successful request) 
    Http Status Code: 200
{}
  • Response example (failed request) 
    Http Status Code: 400
{
 
"errorMessage": "can not find job to cancel, id is 9440a7ebXXXXXXXXXXXXXXXXXXXX2d079a67001679122",
 
"errorCode": "GES.8303"
}

Return Value

  • Normal

    200

  • Abnormal
    Table 3 Return code for failed requests

    Return Value

    Description

    400 Bad Request

    Request error.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    No operation permission.

    404 Not Found

    The requested resource was not found.

    500 Internal Server Error

    Internal service error.

    503 Service Unavailable

    Service unavailable.
Parent topic: Job Management APIs