Starting a Graph

This API is used to start a graph. You can disable a graph if it is not used temporarily.

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: start

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

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
graph_backup_id	No	String	Backup ID associated during graph startup. If this parameter is configured, the graph starts from the backup. If this parameter is left blank, the graph starts from the status when it was closed last time. For details about how to back up a graph, see section Adding a Backup.

Status code: 200

**Table 5** 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 the graph startup 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.

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

{
  "graph_backup_id" : "08a898ae-3ff8-40e8-a7ed-03afe05aedbb"
}

Status code: 200

{
  "jobId" : "ff8080816025a0a1016025a5a2700007"
}

Status code: 400

Bad Request

{
  "errorCode" : "GES.7015",
  "errorMessage" : "The graph is not running or stopped."
}

Status Code	Description
200	OK
400	Bad Request

Parent topic: Graph Management APIs

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.