Updated on 2024-09-30 GMT+08:00

Obtaining the Cluster Upgrade Information

Function

This API is used to obtain the cluster upgrade information.

Calling Method

For details, see Calling APIs.

URI

GET /autopilot/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"
  }
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cce.v3.region.CceRegion;
import com.huaweicloud.sdk.cce.v3.*;
import com.huaweicloud.sdk.cce.v3.model.*;


public class ShowAutopilotClusterUpgradeInfoSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CceClient client = CceClient.newBuilder()
                .withCredential(auth)
                .withRegion(CceRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowAutopilotClusterUpgradeInfoRequest request = new ShowAutopilotClusterUpgradeInfoRequest();
        request.withClusterId("{cluster_id}");
        try {
            ShowAutopilotClusterUpgradeInfoResponse response = client.showAutopilotClusterUpgradeInfo(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcce.v3.region.cce_region import CceRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcce.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CceClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CceRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowAutopilotClusterUpgradeInfoRequest()
        request.cluster_id = "{cluster_id}"
        response = client.show_autopilot_cluster_upgrade_info(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := cce.NewCceClient(
        cce.CceClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowAutopilotClusterUpgradeInfoRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ShowAutopilotClusterUpgradeInfo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The cluster upgrade information is obtained.

Error Codes

See Error Codes.