Help Center/ Cloud Container Engine/ API Reference/ APIs/ Cluster Upgrade/ Obtaining a Cluster Upgrade Path
Updated on 2024-04-23 GMT+08:00
View PDF

Obtaining a Cluster Upgrade Path

Function

Obtain the cluster upgrade path.

URI

GET /api/v3/clusterupgradepaths

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format).

X-Auth-Token

Yes

String

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.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

apiVersion

String

API version

kind

String

Resource type

metadata

Metadata object

Basic information about the object. Metadata is a collection of attributes.

upgradePaths

Array of UpgradePath objects

Upgrade paths
Table 3 Metadata

Parameter

Type

Description

uid

String

Unique ID.

name

String

Resource name

labels

Map<String,String>

Resource labels in key-value pairs. This is a reserved field and does not take effect.

annotations

Map<String,String>

Resource annotations in the format of key-value pairs.

updateTimestamp

String

Update time.

creationTimestamp

String

Creation time.
Table 4 UpgradePath

Parameter

Type

Description

version

String

Cluster version. For example, v1.19.16-r20 for clusters of v1.19 or earlier, and v1.21 for clusters of v1.21 or later. For details, see CCE Cluster Versions.

platformVersion

String

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: an internal feature version. When features or OSs in a cluster version are modified or patches are released in the cluster, the value of this parameter increases monotonically from 1.- Y: a patch version of an internal feature version. This parameter is only used for updating a software package for a released feature version. The value of this parameter increases monotonically from 0.

targetVersions

Array of strings

Target versions that can be upgraded

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