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	Definition Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints N/A Range The value can contain up to 64 characters. Only letters and digits are allowed. Default Value N/A
graph_id	Yes	String	Graph ID

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It is used to obtain the permission to call APIs. For how to obtain the token, see Authentication. (The token is the value of X-Subject-Token in the response header.) Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
job_id	String	Definition ID of the graph stopping job. This parameter is left blank when the request fails. Range N/A

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Definition 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. Range N/A
error_code	String	Definition 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. Range N/A

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