Deleting a Graph (1.0.0)
Function
This API is used to delete a graph.
URI
DELETE /v2/{project_id}/graphs/{graph_id}
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 |
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. |
delete_eip |
No |
Boolean |
Whether the EIP is concurrently deleted |
Request Parameters
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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
ID of the graph deletion job. This parameter is left blank when the request fails. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
System prompt code.
|
error_msg |
String |
System prompt code.
|
Example Request
Delete a graph.
DELETE https://Endpoint/v2/{project_id}/graphs/{graph_id}
Example Response
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." }
Status Code
Return Value |
Description |
---|---|
400 Bad Request |
Request error |
401 Unauthorized |
Authorization failed |
403 Forbidden |
No operation permissions |
404 Not Found |
No resources found |
500 Internal Server Error |
Internal server error |
503 Service Unavailable |
Service unavailable |
Error Code
See Error Code.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot