Upgrading a Graph

Function

This API is used to upgrade a graph. The GES version is periodically upgraded. You can upgrade your graphs as required.

Debugging

You can debug this API in API Explorer, which supports automatic authentication. API Explorer automatically generates sample SDK code and provides the debugging function.

URI

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

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

Request Parameters

**Table 2** Request header parameter
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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
upgrade_version	Yes	String	Target version, which must be later than the current version
force_upgrade	No	Boolean	Whether to upgrade forcibly. The value is true or false, and the default value is false. true: forcible upgrades, which will interrupt running tasks, such as long algorithm execution tasks. As a result, a small number of requests may fail. false: non-forcible upgrades, which will wait for running services to complete. The upgrade process may be slow.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	ID of an asynchronous job NOTE: You can view the job execution status and obtain the return result by querying the job ID. For details, see Job Management APIs.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	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.
error_msg	String	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.

Example Request

Upgrade a graph to version 1.1.8 as needed.

POST http://Endpoint/v2/{project_id}/graphs{graph_id}/upgrade

{
  "upgrade_version" : "1.1.8",
  "force_upgrade" : false
}

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" : "graph [demo] is not found",
  "error_code" : "GES.8011"
}

Status Code

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authentication failed.
403 Forbidden	No operation permissions.
404 Not Found	No resources found.
500 Internal Server Error	Internal server error.
503 Service Unavailable	Service unavailable.