Updated on 2025-09-23 GMT+08:00

Obtaining an Automatic Upgrade Plan

Function

This API is used to obtain an automatic cluster upgrade plan.

Calling Method

For details, see Calling APIs.

URI

GET /autopilot/v3/projects/{project_id}/clusters/{cluster_id}/upgradeplans

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

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Details:

The request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data (used when the FormData parameter is present)

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 3 Response body parameters

Parameter

Type

Description

kind

String

API type. The value is fixed at List and cannot be changed.

apiVersion

String

API version. The value is fixed at v3 and cannot be changed.

items

UpgradePlan object

Automatic upgrade plan

Table 4 UpgradePlan

Parameter

Type

Description

kind

String

API type. The value is fixed at UpgradePlan and cannot be changed.

apiVersion

String

API version. The value is fixed at v3 and cannot be changed.

metadata

Metadata object

Metadata of an automatic upgrade plan

spec

UpgradePlanSpec object

Subject of an automatic upgrade plan

status

UpgradePlanStatus object

Current status of an automatic upgrade plan

Table 5 Metadata

Parameter

Type

Description

uid

String

Definition

Unique ID

Constraints

N/A

Range

N/A

Default Value

N/A

name

String

Definition

Resource name

Constraints

N/A

Range

N/A

Default Value

N/A

labels

Map<String,String>

Definition

Resource labels in key-value pairs. This is a reserved field. Inputting values will not work.

Constraints

N/A

Range

N/A

Default Value

N/A

annotations

Map<String,String>

Definition

Resource annotations in the format of key-value pairs

Constraints

N/A

Range

N/A

Default Value

N/A

updateTimestamp

String

Definition

Update time

Constraints

N/A

Range

N/A

Default Value

N/A

creationTimestamp

String

Definition

Creation time

Constraints

N/A

Range

N/A

Default Value

N/A

Table 6 UpgradePlanSpec

Parameter

Type

Description

clusterID

String

Cluster ID

clusterVersion

String

Current cluster version

targetVersion

String

Target cluster version

notBefore

String

The earliest time for executing an automatic upgrade plan (UTC time). It must be earlier than the time specified for notBeforeDeadline.

notAfter

String

The latest time for executing an automatic upgrade plan (UTC time)

notBeforeDeadline

String

The latest time to start an automatic upgrade plan (UTC time)

Table 7 UpgradePlanStatus

Parameter

Type

Description

phase

String

Status of an automatic upgrade plan

Example Requests

None

Example Responses

Status code: 200

The automatic cluster upgrade plan has been obtained.

{
  "kind" : "List",
  "apiVersion" : "v3",
  "items" : [ {
    "kind" : "UpgradePlan",
    "apiVersion" : "v3",
    "metadata" : {
      "uid" : "5ddfddfe-87db-11ec-b5e5-0255ac111914"
    },
    "spec" : {
      "clusterID" : "b4b9e60f-8aa2-11ee-af09-0255ac10004f",
      "currentVersion" : "v1.27.6-r0",
      "targetVersion" : "v1.27.9-r0",
      "notBefore" : "2025-01-06 16:00:00 +0000 UTC",
      "notAfter" : "2025-01-06 20:00:00 +0000 UTC",
      "notBeforeDeadline" : "2025-01-30 20:00:00 +0000 UTC"
    },
    "status" : {
      "phase" : "Pending"
    }
  } ]
}

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

    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();
        ListAutopilotUpgradePlansRequest request = new ListAutopilotUpgradePlansRequest();
        request.withClusterId("{cluster_id}");
        try {
            ListAutopilotUpgradePlansResponse response = client.listAutopilotUpgradePlans(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 = ListAutopilotUpgradePlansRequest()
        request.cluster_id = "{cluster_id}"
        response = client.list_autopilot_upgrade_plans(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.ListAutopilotUpgradePlansRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ListAutopilotUpgradePlans(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 automatic cluster upgrade plan has been obtained.

Error Codes

See Error Codes.