Updated on 2024-05-23 GMT+08:00

Batch Deleting Edges

Function

This API is used to delete edges in batches based on the source vertices, target vertices, and indexes of the edges.

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/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

Example Request

Delete edges in batches. The source vertices of the edges are 39631050_Landscape and 27803870_Landmark building, and the target vertices of the edges are 27803870_Landmark building and 27661363_Villa hot spring.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-delete
{
	"edges": [
		{
                "source": "39631050_Landscape",
                "target": "27803870_ Landmark building"
		},
		{
                        "label": "road",
                "source": "27803870_Landmark building",
			"target": "27661363_Villa hot spring"
		}
	],
	"ignoreError": true
}

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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

edges

Yes

Object

Edge array to be deleted

executionMode

No

String

sync indicates the synchronous mode, and async indicates the asynchronous mode. The default value is sync.

ignoreError

No

Boolean

Whether to ignore errors, for example, the edge to delete does not exist. The default value is false, indicating that errors will not be ignored. Errors in JSON format cannot be ignored.

Table 3 edges parameter description

Parameter

Mandatory

Type

Description

source

Yes

String

Source vertex of an edge

target

Yes

String

Target vertex of an edge

label

No

String

Label of an edge. If the index parameter is set, this parameter is ignored. If the index parameter is not set, an edge that meets the source, target, and label conditions is deleted. If the specified label value does not exist in the schema or the edge with the same label does not exist, no edge will be deleted.

sortKey

No

String/int/null/varString

Sort key of duplicate edges. If this parameter is set, label must also be set. The type must be the same as that of sortKey set during graph creation, except null.

Response Parameters

  • Synchronous call
    Table 4 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.

    • 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.

    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":"parameter does not contain 'source'",
     "errorCode":"GES.8000"
    }
  • Asynchronous call (2.2.14)
    Table 5 Response body parameters

    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.

    jobId

    No

    String

    ID of the deletion job.

    This parameter is left blank when the request fails. This ID can be used as a request parameter to obtain the deletion result through the API for querying the job status.

    jobType

    No

    Integer

    Job type.

    This parameter is left blank when the request fails.

    Status code: 200

    Example response for a successful request

    Http Status Code: 200
     {
     "jobId": "500dea8f-9651-41fe-8299-c20f13a032ea",
     "jobType": 3
     }

    Status code: 400

    Example response for a failed request

    Http Status Code: 400
     {
     "errorMessage": "graph [test_117d] is not found",
     "errorCode": "GES.8402"
     }

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.

Error Codes

See Error Codes.