Help Center> Graph Engine Service> API Reference> Service Plane APIs> Vertex Operation APIs> Deleting Vertices in Batches (2.1.9)
View PDF

Deleting Vertices in Batches (2.1.9)

Function

This API is used to delete vertices in batches based on the vertex IDs.

URI

  • URI format 
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-delete
  • 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.

    graph_name

    Yes

    String

    Graph name

Request

  • Request example 
    POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-delete  
{
  "vertices":
  ["27003509_CCTV Station Building",
  "39636392_Badaling Great Wall"]
}

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

  • Request body parameter description
    Table 2 Request body parameter description

    Parameter

    Mandatory

    Type

    Description

    vertices

    Yes

    String

    Vertex ID array to be deleted

Response

  • Parameter description
    Table 3 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.

    result

    No

    String

    If the execution is successful, the value of result is success.
  • Response example (successful request) 
    Http Status Code: 200
{
    "result": "success"          
}
  • Response example (failed request) 
    Http Status Code: 400
{
  "errorMessage": " Bad Request, parameter vertices cannot be null",
  "errorCode": "GES.8214"
}
Parent topic: Vertex Operation APIs