Help Center/ Cloud Container Engine/ API Reference/ APIs/ Cluster Upgrade/ Obtaining the Cluster Upgrade Information

Updated on 2024-05-31 GMT+08:00

Online Debugging

CLI Examples

View PDF

Obtaining the Cluster Upgrade Information

Function

Obtain the cluster upgrade information.

Calling Method

For details, see Calling APIs.

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/upgradeinfo

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.
cluster_id	Yes	String	Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
kind	String	Type
apiVersion	String	API version
metadata	Metadata object	Basic information about the object. Metadata is a collection of attributes.
spec	UpgradeInfoSpec object	Upgrade settings
status	UpgradeInfoStatus object	Upgrade status

**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** UpgradeInfoSpec
Parameter	Type	Description
lastUpgradeInfo	UpgradeInfoStatus object	Last cluster upgrade
versionInfo	UpgradeVersionInfo object	Version
upgradeFeatureGates	UpgradeFeatureGates object	Cluster upgrade feature gates

**Table 5** UpgradeVersionInfo
Parameter	Type	Description
release	String	Official version, for example, v1.19.10
patch	String	Patch version, for example, r0
suggestPatch	String	Recommended target patch version, for example, r0
targetVersions	Array of strings	Target versions for the upgrade

**Table 6** UpgradeFeatureGates
Parameter	Type	Description
supportUpgradePageV4	Boolean	Whether the cluster upgrade console supports v4. This field is used by the CCE console.

**Table 7** UpgradeInfoStatus
Parameter	Type	Description
phase	String	Status of the upgrade task Init: initializing Running Pause Success Failed
progress	String	Upgrade task progress
completionTime	String	End time of the upgrade task

Example Requests

None

Example Responses

Status code: 200

The cluster upgrade information is obtained.

{
  "kind" : "UpgradeInfo",
  "apiVersion" : "v3",
  "metadata" : { },
  "spec" : {
    "lastUpgradeInfo" : {
      "phase" : "Success",
      "completionTime" : "2023-11-25 11:18:54.478926 +0800 CST"
    },
    "versionInfo" : {
      "release" : "v1.27.2",
      "patch" : "r0",
      "suggestPatch" : "r0",
      "targetVersions" : [ "v1.27.3-r0" ]
    },
    "upgradeFeatureGates" : {
      "supportUpgradePageV4" : true
    }
  },
  "status" : {
    "phase" : "Success",
    "completionTime" : "2023-11-25 11:18:54.478926 +0800 CST"
  }
}