Help Center/ Graph Engine Service/ API Reference (Kuala Lumpur Region)/ Management Plane APIs/ Graph Management APIs/ Upgrading a Graph
Updated on 2022-08-09 GMT+08:00
View PDF
Share

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.

URI

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:

  • upgrade

Request Parameters

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

upgradeVersion

Yes

String

Target version, which must be later than the current version

forceUpgrade

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

Example Request

POST http://Endpoint/v1.0/{project_id}/graphs/{graph_id}/action?action_id=upgrade

{
  "upgradeVersion" : "1.1.8",
  "forceUpgrade" : false
}

Example Response

Status code: 200

OK

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

Status code: 400

Bad Request

{
  "errorMessage" : "graph [demo] is not found",
  "errorCode" : "GES.8011"
}

Status Code

Status Code

Description

200

OK

400

Bad Request
Parent topic: Graph Management APIs