Updated on 2024-11-12 GMT+08:00

Obtaining a Cluster Upgrade Path

Function

This API is used to obtain the cluster upgrade path.

Calling Method

For details, see Calling APIs.

URI

GET /autopilot/v3/clusterupgradepaths

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Details:

Request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

Default value:

N/A

X-Auth-Token

Yes

String

Details:

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.

Constraints:

None

Options:

N/A

Default value:

N/A

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

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
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 ListAutopilotClusterUpgradePathsSolution {

    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");

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

        CceClient client = CceClient.newBuilder()
                .withCredential(auth)
                .withRegion(CceRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAutopilotClusterUpgradePathsRequest request = new ListAutopilotClusterUpgradePathsRequest();
        try {
            ListAutopilotClusterUpgradePathsResponse response = client.listAutopilotClusterUpgradePaths(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
# 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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = ListAutopilotClusterUpgradePathsRequest()
        response = client.list_autopilot_cluster_upgrade_paths(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
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")

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

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

    request := &model.ListAutopilotClusterUpgradePathsRequest{}
	response, err := client.ListAutopilotClusterUpgradePaths(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 path is obtained.

Error Codes

See Error Codes.