Updated on 2023-04-10 GMT+08:00

Forcibly Restarting a Graph (2.2.21)

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. For details about how to obtain the project ID, 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

Set this parameter to restart, which means that the target graph will be restarted.

Request Parameters

Table 3 Parameters in the request header

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

Table 4 Response body parameters

Parameter

Type

Description

errorMessage

String

System prompt code.

  • 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 code.

  • 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

Request sent.

400

Request error.

401

Authentication failed.

403

No operation permission.

404

No resources found.

500

Internal service error.

503

Service unavailable.