Obtaining the Cluster Upgrade Information

Function

This API is used to obtain the cluster upgrade information.

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/projects/{project_id}/clusters/{cluster_id}/upgradeinfo

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Details: Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Project IDs of the account Default value: N/A
cluster_id	Yes	String	Details: Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Cluster IDs Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
kind	String	Definition: Type Range: N/A
apiVersion	String	Definition: API version Range: N/A
metadata	Metadata object	Definition: Basic information. Metadata is a collection of attributes. Range: N/A
spec	UpgradeInfoSpec object	Definition: Upgrade configurations Range: N/A
status	UpgradeInfoStatus object	Definition: Upgrade status 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** UpgradeInfoSpec
Parameter	Type	Description
lastUpgradeInfo	UpgradeInfoStatus object	Definition: Last cluster upgrade Range: N/A
versionInfo	UpgradeVersionInfo object	Definition: Version Information Range: N/A
upgradeFeatureGates	UpgradeFeatureGates object	Definition: Cluster upgrade feature gates Range: N/A

**Table 5** UpgradeVersionInfo
Parameter	Type	Description
release	String	Definition: Official version, for example, v1.19.10 Range: N/A
patch	String	Definition: Patch version, for example, r0 Range: N/A
suggestPatch	String	Definition: Recommended target patch version, for example, r0 Range: N/A
targetVersions	Array of strings	Definition: Target versions that can be upgraded to Range: N/A

**Table 6** UpgradeFeatureGates
Parameter	Type	Description
supportUpgradePageV4	Boolean	Definition: Whether the cluster upgrade console supports v4. This field is used by the CCE console. Range: true: v4 is supported. false: v4 is not supported.

**Table 7** UpgradeInfoStatus
Parameter	Type	Description
phase	String	Definition: Upgrade task status Range: Init: initializing Running Pause Success Failed
progress	String	Definition: Upgrade task progress Range: N/A
completionTime	String	Definition: End time of an upgrade task Range: N/A

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"
  }
}