Help Center/ Graph Engine Service/ API Reference (Kuala Lumpur Region)/ Management Plane APIs/ Graph Management APIs/ Deleting a Graph
Updated on 2022-08-08 GMT+08:00
View PDF
Share

Deleting a Graph

Function

This API is used to delete a graph.

URI

DELETE /v1.0/{project_id}/graphs/{graph_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used for resource isolation.

Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.

graph_id

Yes

String

Graph ID
Table 2 Query parameters

Parameter

Mandatory

Type

Description

keepBackup

No

Boolean

Whether to retain the backups of a graph after it is deleted. By default, one automatic backup and two manual backups are retained. If this parameter is left empty, no backups are retained.

Request Parameters

Table 3 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

jobId

String

ID of the graph deletion 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 Task Center APIs.

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.

Example Request

DELETE https://Endpoint/v1.0/{project_id}/graphs/{graph_id}

Example Response

Example response with status code 200:

OK

{
  "jobId" : "ff8080816025a0a1016025a5a2700007"
}

Status code: 400

Bad Request

{
  "errorCode" : "GES.7000",
  "errorMessage" : "The graph does not exist or has been deleted."
}

Status Code

Status Code

Description

200

OK

400

Bad Request
Parent topic: Graph Management APIs