Deleting a Graph

This API is used to delete a graph.

DELETE /v2/{project_id}/graphs/{graph_id}

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_id	Yes	String	Graph ID

Table 2 Query parameters
Parameter	Mandatory	Type	Description
keep_backup	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.

Table 3 Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It is used to obtain the permission to call APIs. For details about how to obtain the token, see Authentication. The value of X-Subject-Token in the response header is the token.

Status code: 200

Table 4 Response body parameters
Parameter	Type	Description
job_id	String	ID of the graph deletion job. This parameter is left blank when the request fails.

Status code: 400

Table 5 Response body parameters
Parameter	Type	Description
error_code	String	System prompt code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
error_msg	String	System prompt code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.

Delete a graph.

DELETE https://Endpoint/v2/{project_id}/graphs/{graph_id}

Status code: 200

Example response for a successful request

{
  "job_id" : "ff8080816025a0a1016025a5a2700007"
}

Status code: 400

Example response for a failed request

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

Была ли эта статья полезна?