Stopping a Graph (1.0.0)

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.
You can stop a graph instance for a maximum of seven days. If you do not restart the instance manually within that time frame, it will automatically restart.

POST /v2/{project_id}/graphs/{graph_id}/stop

**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** 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 3** Response body parameters
Parameter	Type	Description
job_id	String	ID of the graph stopping job. Graph object. If the request fails, this parameter is left empty.

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

Close a graph.

POST https://Endpoint/v2/{project_id}/graphs/{graph_id}/stop
{ }

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."
}