Updated on 2022-08-08 GMT+08:00

Deleting an Edge

Function

This API is used to delete an edge based on the specified property value or index.

URI

  • URI format
    DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/edges?source={sourceVertex}&target={targetVertex}&index={index}&label={label}&property={name}&value={value}
  • 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

    source

    Yes

    String

    Source vertex name

    target

    Yes

    String

    Target vertex name

    index

    No

    Integer

    Edge index

    • If property has been set, ignore this parameter.
    • If property is not set, the edge is deleted based on index.
    • If neither property nor index is set, all edges between source and target are deleted.

    label

    No

    String

    Indicates the label of an edge, which can accelerate the search of property values. This parameter must be used together with property.

    property

    No

    String

    Property name of the edge to be deleted. This parameter must be used together with value.

    value

    No

    String

    Indicates the property value of the edge to be deleted. This parameter must be used together with property.

Request

  • Request example
    DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges?source=Vivian&target=Lethal Weapon&index=0&label=rate&property=Score&value=5

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

Response

  • 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": "edge source vertex [Lily] does not exist",
        "errorCode": "GES.8000"
    }

Return Value

  • Normal

    200

  • Abnormal
    Table 2 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.