Batch Deleting Vertices (2.1.9)

Function

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

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-delete

**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.
graph_name	Yes	String	Graph name

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
vertices	Yes	String	Vertex ID array to be deleted
ignoreError (2.2.28)	No	Boolean	Whether to ignore errors, for example, the vertices you want to delete does not exist. The value can be true or false. The default value is false, indicating that errors will not be ignored. Note that JSON format errors will not be ignored.

Response Parameters

**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 code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
result	String	Request result. If the request is successful, the value is success. If the request fails, the value is failed.

Example Request

Delete nodes in batches by node ID. The vertex IDs to be deleted are Vivian and 46.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-delete  
{
    "vertices": [
        "Vivian",
        "46"
    ],
    "ignoreError": true
}

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

Http Status Code: 400
{
  "errorMessage": " Bad Request, parameter vertices cannot be null",
  "errorCode": "GES.8214"
}

Status Code

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