Deleting a Graph (1.0.0)
Function
This API is used to delete a graph.
URI
DELETE /v1.0/{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 |
---|---|---|---|
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
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 |
---|---|---|
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.
|
errorCode |
String |
System prompt.
|
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 |
Request sent. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
No operation permission. |
404 |
No resources found. |
500 |
Internal service error. |
503 |
Service unavailable. |
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