Help Center> Graph Engine Service> API Reference> Management Plane APIs> Graph Management APIs> Clearing a Graph(2.1.2)
View PDF

Clearing a Graph(2.1.2)

Function

This API is used to clear all data in a graph.

URI

  • URI format 
    POST  /v1.0/{project_id}/graphs/{graph_id}/action?action_id=clear-graph&clear-metadata={clearMetadata}
  • 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_id

    Yes

    String

    Graph ID

    clearMetadata

    No

    Boolean

    Whether to clear the metadata associated with the graph. You are advised to clear it.

Request

  • Request example 
    POST http://Endpoint/v1.0/{project_id}/graphs/{graph_id}/action?action_id=clear-graph&clear-metadata=true
  • Parameter description

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.

    job_id

    No

    String

    ID of an asynchronous job.

    NOTE:

    You can view the job execution status and obtain the return result by querying the job ID. For details, see Job Management APIs.
  • Response example (successful request) 
    Http Status Code: 200
{
  "jobId": "ff8080816025a0a1016025a5a2700007"
}
  • Response example (failed request) 
    Http Status Code: 400
{
  "errorCode": "GES.8012",
  "errorMessage": "Failed to clear a graph."
}

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

    Internal service error.

    503 Service Unavailable

    Service unavailable.
Parent topic: Graph Management APIs