Help Center> Graph Engine Service> API Reference> Service Plane APIs> Vertex Operation APIs> Deleting Filtered Vertices (2.2.7)
View PDF

Deleting Filtered Vertices (2.2.7)

Function

This API is used to delete the vertex set that meets the filter criteria.

URI

  • URI format 
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=delete

Request

  • Request example (Only the asynchronous mode is supported.) 
    POST https://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=delete
  {
	"labels": [
		"movies",
		"user"
	],
	"vertexFilters": [
		{
			"propertyName": "Age",
			"predicate": "=",
			"values": [
				"18-24"
			]
		}
	]
  }
  • Parameter description
    Table 1 Request body parameter description

    Parameter

    Mandatory

    Type

    Description

    labels

    Either labels or vertexFilters is mandatory.

    String

    Filter criteria of the vertex type

    vertexFilters

    Either labels or vertexFilters is mandatory.

    Json

    Filter criteria, in JSONArray format. Vertices are filtered by property.

    For details, see Table 4.

Response

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.

job_id

No

String

ID of the vertex query job. This parameter is left blank when the request fails.

NOTE:

You can view the job execution status and obtain the return result by querying the job ID. For details, see Querying Job Status on the Service Plane (1.0.0).
  • Response example (successful request) 
    Http Status Code: 200
{
    "jobId": "03e774f5-29ea-4187-9508-5435f3892ead016886200",
    "jobType": 1
}
  • Response example (failed request) 
    Http Status Code: 400
{
    "errorMessage": "Bad Request, parameter labels and vertexFilters cannot all be null",
    "errorCode": "GES.8203"
}

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

    Service internal error.

    503 Service Unavailable

    Service unavailable.
Parent topic: Vertex Operation APIs