Help Center/ Graph Engine Service/ API Reference (Kuala Lumpur Region)/ Management Plane APIs/ Graph Management APIs/ Restarting a Graph
Updated on 2022-08-08 GMT+08:00
View PDF
Share

Restarting a Graph

Function

This API is used to forcibly start a graph in the importing, exporting, running, or clearing state. If a graph is forcibly restarted, asynchronous tasks of the graph are failed state and the graph is stopped and started.

URI

POST /v1.0/{project_id}/graphs/{graph_id}/action

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.

graph_id

Yes

String

Graph ID
Table 2 Query parameters

Parameter

Mandatory

Type

Description

action_id

Yes

String

Graph action ID

The value can be:

  • restart

Request Parameters

Table 3 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

errorMessage

String

System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.

errorCode

String

System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.

jobId

String

ID of a forcible restart 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.

Example Request

POST https://Endpoint/v1.0/{project_id}/graphs/{graph_id}/action?action_id=restart

Example Response

Status code: 200

OK

{ }

Status code: 400

Bad Request

{
  "errorMessage" : "The request is invalid.",
  "errorCode" : "GES.7016"
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Parent topic: Graph Management APIs