Stopping a Graph (1.0.0)
Function
This API is used to stop a graph. After a graph is created, you can stop it if it is temporarily not in use.
- Graphs of the database edition cannot be stopped by calling this API.
- Instances of stopped graphs are not charged.
URI
POST /v2/{project_id}/graphs/{graph_id}/stop
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 |
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 stopping job. Graph object. If the request fails, this parameter is left empty. |
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
System prompt code.
|
error_code |
String |
System prompt code.
|
Example Request
Close a graph.
POST https://Endpoint/v2/{project_id}/graphs/{graph_id}/stop { }
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.7001", "error_msg" : "The graph is not running." }
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