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

Deleting a Label

Function

This API is used to delete a label as well as the vertices and edges associated with the label.

URI

  • URI format
    DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{labelName}
  • 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

    label_name

    Yes

    String

    Name of a label

Request

  • Request example
    DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{labelName}

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

Response

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

    data

    No

    Json

    Query results. This parameter is left blank when the request fails.

    Table 3 data parameter description

    Parameter

    Type

    Description

    outputs

    int

    Number of deleted vertices or edges when a label is deleted.

  • Response example (successful request)
    Http Status Code: 200
    {
        "data": {
            "outputs": 3
        },
        "status": "success"
    }
    
  • Response example (failed request)
    Http Status Code: 400
    {
      "errorMessage": "graph [demo] is not found",
      "errorCode": "GES.8003"
    }
    

Return Value

  • Normal

    200

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