Updated on 2026-08-18 GMT+08:00

Querying Version Upgrade Paths

Function

This API is used to query all upgrade paths from the current version to the target version. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

Authorization

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the permissions listed below are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

gaussdb:instance:listUpgradePaths

List

Instance

-

gaussdb:instance:listUpgradePaths

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdb:instance:listUpgradePaths	List	Instance	-	gaussdb:instance:listUpgradePaths	-

URI

GET /v3/{project_id}/instances/upgrade-paths

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
source_version	Yes	String	Definition Engine version of the source instance, for example, 8.210.0. Constraints N/A Range N/A Default Value N/A
target_version	No	String	Definition Engine version of the target instance, for example, 8.218.0. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After a response is returned, the value of X-Subject-Token in the response header is the token. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language of the information returned by the API. Constraints N/A Range zh-cn: Chinese en-us: English Default Value en-us

Response Parameters

**Table 4** Response parameters
Parameter	Type	Description
version_infos	Array of Table 5 objects	Definition Version details.
version_edges	Array of Table 6 objects	Definition Supported upgrade paths.

**Table 5** VersionInfosResult
Parameter	Type	Description
version	String	Definition Service engine version, for example, 8.210.0. Range N/A
kernel_version	String	Definition Kernel engine version, for example, 505.2.1. Range N/A
recommend	Boolean	Definition Whether the version is the recommended one. Range true: recommended version. false: non-recommended version.

**Table 6** UpgradePathsResult
Parameter	Type	Description
start_version	String	Definition Source engine version, for example, 3.226.0. Range N/A
end_version	String	Definition Target engine version, for example, 8.218.0. Range N/A

Example Request

Querying version upgrade paths

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/upgrade-paths?source_version=8.218

Example Response

{ 
  "version_infos" : [ { 
    "version" : "3.226.0", 
    "kernel_version" : "503.1.0.SPC2300", 
    "recommended" : true 
  }, { 
    "version" : "8.218.0", 
    "kernel_version" : "505.2.1.SPC0800", 
    "recommended" : true 
  } ], 
  "version_edges" : [ { 
    "start_version" : "3.226.0", 
    "end_version" : "8.218.0" 
  } ] 
}

Status Codes

Normal
200
Abnormal
For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Version Management