Upgrading a Graph (1.0.5)

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

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints N/A Range The value can contain up to 64 characters. Only letters and digits are allowed. Default Value N/A
graph_id	Yes	String	Definition Graph ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It is used to obtain the permission to call APIs. For how to obtain the token, see Authentication. (The token is the value of X-Subject-Token in the response header.) Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
upgrade_version	Yes	String	Definition Target version, which must be later than the current version. Constraints N/A Range N/A Default Value N/A
force_upgrade	No	Boolean	Definition Whether to enable forced upgrade. Constraints N/A Range 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. Default Value false

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Definition ID of an asynchronous job. Range N/A 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	Definition 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. Range N/A
error_msg	String	Definition 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. Range N/A

Upgrade a graph to version 1.1.8 as needed.

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

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

Status code: 200

Example response for a successful request

{
  "job_id" : "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
}

Status code: 404

Example response for a failed request

{
    "error_msg": "Cluster does not exist or has been deleted.",
    "error_code": "GES.0047"
}