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

Obtaining a Cluster Upgrade Path

Function

This API is used to obtain the cluster upgrade path.

Calling Method

For details, see Calling APIs.

Authorization Information

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 Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /api/v3/clusterupgradepaths

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition: Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any. Constraints: GET requests are not validated. Range: N/A Default Value: N/A
X-Auth-Token	Yes	String	Details: Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token. Constraints: None Options: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
apiVersion	String	Definition: API version Range: N/A
kind	String	Definition: Resource type. Range: N/A
metadata	Metadata object	Definition: Basic information. Metadata is a collection of attributes. Range: N/A
upgradePaths	Array of UpgradePath objects	Definition: Upgrade paths Range: N/A

**Table 3** Metadata
Parameter	Type	Description
uid	String	Definition Unique ID Range N/A
name	String	Definition Resource name Range N/A
labels	Map<String,String>	Definition Resource labels in key-value pairs. This is a reserved field. Inputting values will not work. Range N/A
annotations	Map<String,String>	Definition Resource annotations in the format of key-value pairs Range N/A
updateTimestamp	String	Definition Update time Range N/A
creationTimestamp	String	Definition Creation time Range N/A

**Table 4** UpgradePath
Parameter	Type	Description
version	String	Definition: Cluster version, which can be v1.19 or earlier (for example, v1.19.16-r20) or v1.21 or later (for example, v1.21 or v1.23). For details, see CCE cluster version description. Range: N/A
platformVersion	String	Definition: CCE cluster platform version, which is an internal version under the cluster version (version). Platform versions are used to trace iterations in a major cluster version. They are unique within a major cluster version and recounted when the major cluster version changes. The format of platformVersion is cce.X.Y. X: internal feature version, which indicates changes in features, patches, or OS support in the cluster version. The value starts from 1 and increases monotonically. Y: patch version of an internal feature version. A patch version is only used for software package update after the feature version is released. No other modification is involved. The value starts from 0 and increases monotonically. Range: N/A
targetVersions	Array of strings	Definition: Target versions that can be upgraded to Range: N/A

Example Requests

None

Example Responses

Status code: 200

The cluster upgrade path is obtained.

{
  "kind" : "ClusterUpgradePaths",
  "apiVersion" : "v3",
  "metadata" : { },
  "upgradePaths" : [ {
    "version" : "v1.25",
    "platformVersion" : "cce.5.0",
    "targetVersions" : [ "v1.25.6-r0", "v1.27.3-r0" ]
  }, {
    "version" : "v1.25",
    "platformVersion" : "cce.4.0",
    "targetVersions" : [ "v1.25.6-r0", "v1.27.3-r0" ]
  }, {
    "version" : "v1.23",
    "platformVersion" : "cce.10.0",
    "targetVersions" : [ "v1.23.11-r0", "v1.25.6-r0", "v1.27.3-r0" ]
  }, {
    "version" : "v1.23",
    "platformVersion" : "cce.9.0",
    "targetVersions" : [ "v1.23.11-r0", "v1.25.6-r0", "v1.27.3-r0" ]
  } ]
}

Status Codes

Status Code	Description
200	The cluster upgrade path is obtained.

Error Codes

See Error Codes.

Parent Topic: Cluster Upgrade