Function

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

URI

• URI format

  POST /v1.0/{project_id}/graphs/{graph_id}/action?action_id=start

• Parameter description

  Table 1 URI parameter description

  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

Request

• Request example

  POST https://Endpoint/v1.0/{project_id}/graphs/{graph_id}/action?action_id=start
  {
      "graph_backup_id" : "08a898ae-3ff8-40e8-a7ed-03afe05aedbb"
  }

• Parameter description

  Table 2 Request body parameter description

  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(1.0.0).

Response

• Parameter description

  Table 3 Parameter description

  Parameter	Mandatory	Type	Description
  errorMessage	No	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	No	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
  job_id	No	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.

• Response example (successful request)

  Http Status Code: 200
  {
    "jobId": "ff8080816025a0a1016025a5a2700007"
  }

• Response example (failed request)

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

Return Value

• Normal

  200

• Abnormal

  Table 4 Return code for failed requests

  Return Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authentication failed.
  403 Forbidden	No operation permission.
  404 Not Found	The requested resource was not found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	Service unavailable.