Forcibly Restarting a Graph (2.2.21)

Function

This API is used to forcibly start a graph, especially for running graphs or those are being imported, exported, and cleared. If a graph is forcibly restarted, asynchronous tasks of the graph are failed state and the graph is stopped and started.

URI

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

**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	Definition Graph ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
job_id	String	Definition ID of a forced restart job. This parameter is left blank when the request fails. Range N/A NOTE: You can view the job execution status and obtain the return result by querying the job ID. For details, see Task Center APIs.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
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
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

Example Request

Forcibly start a graph.

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

{ }

Example Response

Status code: 200

Example response for a successful request

{
  "job_id" : "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
}

Status code: 400

Example response for a failed request

{
  "error_msg" : "The request is invalid.",
  "error_code" : "GES.7016"
}

Status Codes

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.