Help Center/ Cloud Container Engine/ API Reference/ APIs/ Cluster Upgrade/ Obtaining the Configuration of Cluster Upgrade Feature Gates
Updated on 2024-05-31 GMT+08:00

Obtaining the Configuration of Cluster Upgrade Feature Gates

Function

Obtain the configuration of cluster upgrade feature gates.

Calling Method

For details, see Calling APIs.

URI

GET /api/v3/clusterupgradefeaturegates

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.

upgradeFeatureGates

Map<String,String>

Feature gates information, which is in the format of a key-value pair.

  • Key: can be DisplayPreCheckDetail (displaying details about all cluster check items before an upgrade), EvsSnapshot (using EVS snapshots to back up clusters), LabelForSkippedNode (labeling the nodes skipped during a cluster upgrade), or UpgradeStrategy (specifying cluster upgrade policies)

  • Value: can be Support, Disable, or Default, which is determined using default CCE rules.

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.

Example Requests

None

Example Responses

Status code: 200

The cluster upgrade path is obtained.

{
  "kind" : "ClusterUpgradeFeatureGates",
  "apiVersion" : "v3",
  "metadata" : { },
  "upgradeFeatureGates" : {
    "DisplayPreCheckDetail" : "Support",
    "EvsSnapshot" : "Support",
    "LabelForSkippedNode" : "Support",
    "UpgradeStrategy" : "Support"
  }
}

Status Codes

Status Code

Description

200

The cluster upgrade path is obtained.

Error Codes

See Error Codes.