Help Center/ Cloud Container Engine_Autopilot/ API Reference/ APIs/ Autopilot Cluster Upgrade/ Obtaining Details About a Pre-upgrade Check Task of a Cluster
Updated on 2024-09-30 GMT+08:00

Obtaining Details About a Pre-upgrade Check Task of a Cluster

Function

This API is used to obtain details about a pre-upgrade check task of a cluster. The task ID is obtained from the uid field in the response body after the cluster check API is called.

Calling Method

For details, see Calling APIs.

URI

GET /autopilot/v3/projects/{project_id}/clusters/{cluster_id}/operation/precheck/tasks/{task_id}

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.

task_id

Yes

String

Upgrade task ID, obtained from the uid field in the response body after the cluster upgrade API is called.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

apiVersion

String

API version, which defaults to v3

kind

String

Resource type, which defaults to PreCheckTask

metadata

PrecheckTaskMetadata object

Metadata of a pre-upgrade check task

spec

PrecheckCluserResponseSpec object

Information of a pre-upgrade check task

status

PrecheckStatus object

Status of a pre-upgrade check task

Table 3 PrecheckTaskMetadata

Parameter

Type

Description

uid

String

Task ID

creationTimestamp

String

Time when the task was created

updateTimestamp

String

Time when the task was updated

Table 4 PrecheckCluserResponseSpec

Parameter

Type

Description

clusterID

String

Cluster ID

clusterVersion

String

Current cluster version

targetVersion

String

Target version

skippedCheckItemList

Array of skippedCheckItemListResponse objects

Skipped check items

Table 5 skippedCheckItemListResponse

Parameter

Type

Description

name

String

Name of the item that is skipped to be checked

resourceSelector

resourceSelectorResponse object

Resource tag selector. This parameter is available only for node check, but not for cluster check or add-on check.

Table 6 resourceSelectorResponse

Parameter

Type

Description

key

String

Tag key

values

Array of strings

Tag value list

operator

String

Tag value

Table 7 PrecheckStatus

Parameter

Type

Description

phase

String

Status. Options:

  • Init: initializing

  • Running

  • Success

  • Failed

  • Error

expireTimeStamp

String

Check result expiration time

message

String

Information, which typically indicates the log for execution errors

clusterCheckStatus

clusterCheckStatus object

Status of a cluster restrictions check

addonCheckStatus

addonCheckStatus object

Status of an add-on check

nodeCheckStatus

nodeCheckStatus object

Node check status

Table 8 clusterCheckStatus

Parameter

Type

Description

phase

String

Status. Options:

  • Init: initializing

  • Running

  • Success

  • Failed

itemsStatus

Array of PreCheckItemStatus objects

Compliance set by check item

Table 9 addonCheckStatus

Parameter

Type

Description

phase

String

Status. Options:

  • Init: initializing

  • Running

  • Success

  • Failed

itemsStatus

Array of PreCheckItemStatus objects

Compliance set by check item

Table 10 nodeCheckStatus

Parameter

Type

Description

phase

String

Status. Options:

  • Init: initializing

  • Running

  • Success

  • Failed

nodeStageStatus

Array of NodeStageStatus objects

Node check status

Table 11 NodeStageStatus

Parameter

Type

Description

nodeInfo

NodeInfo object

Node information

itemsStatus

Array of PreCheckItemStatus objects

Compliance set by check item

Table 12 NodeInfo

Parameter

Type

Description

uid

String

Node UID

name

String

Node name

status

String

Status

nodeType

String

Node type

Table 13 PreCheckItemStatus

Parameter

Type

Description

name

String

Check item

kind

String

Check item type. Options:

  • Exception: exceptions that need to be resolved by you

  • Risk: risks that can be skipped after you confirm them

group

String

Check item group. Options:

  • LimitCheck: cluster limit check

  • MasterCheck: master node check

  • NodeCheck: worker node check

  • AddonCheck: add-on check

  • ExecuteException: process error check

level

String

Check item severity. Options:

  • Info: information

  • Warning

  • Fatal: critical

phase

String

Status. Options:

  • Init: initializing

  • Running

  • Success

  • Failed

message

String

Information

riskSource

riskSource object

Risk item

errorCodes

Array of strings

Error code set

Table 14 riskSource

Parameter

Type

Description

configurationRisks

Array of configurationRisks objects

Configuration risk

deprecatedAPIRisks

Array of deprecatedAPIRisks objects

Deprecated API risk

nodeRisks

Array of nodeRisks objects

Node risk

addonRisks

Array of addonRisks objects

Add-on risk

Table 15 configurationRisks

Parameter

Type

Description

package

String

Component

sourceFile

String

How to Obtain

nodeMsg

String

Node information

field

String

Parameter Value

operation

String

Change an operation type.

originalValue

String

Original Value

value

String

Current Value

Table 16 deprecatedAPIRisks

Parameter

Type

Description

url

String

Request path, for example, /apis/policy/v1beta1/podsecuritypolicies

userAgent

String

Client information

Table 17 nodeRisks

Parameter

Type

Description

NodeID

String

Worker node ID

Table 18 addonRisks

Parameter

Type

Description

addonTemplateName

String

Name of the add-on template

alias

String

Add-on alias

Example Requests

None

Example Responses

Status code: 200

The details about a pre-upgrade check task of a cluster are obtained.

{
  "kind" : "PreCheckTask",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "f61e008c-1600-41c0-9bde-121de5a30660",
    "creationTimestamp" : "2023-11-25 07:20:04.592972 +0000 UTC",
    "updateTimestamp" : "2023-11-25 07:21:05.518966 +0000 UTC"
  },
  "spec" : {
    "clusterVersion" : "v1.19.16-r4",
    "targetVersion" : "v1.23.5-r0"
  },
  "status" : {
    "phase" : "Success",
    "expireTimeStamp" : "2023-11-25 08:21:05.518966 +0000 UTC",
    "clusterCheckStatus" : {
      "phase" : "Success",
      "itemsStatus" : [ {
        "name" : "DeprecatedApiCheck",
        "kind" : "Risk",
        "group" : "LimitCheck",
        "level" : "Info",
        "phase" : "Success",
        "message" : "check item succeed",
        "riskSource" : { }
      }, {
        "name" : "NodeContainerdPodRestartRisk",
        "kind" : "Risk",
        "group" : "LimitCheck",
        "level" : "Warning",
        "phase" : "Success",
        "message" : "check item succeed",
        "riskSource" : { }
      }, {
        "name" : "ResiduePackageVersion",
        "kind" : "Exception",
        "group" : "LimitCheck",
        "level" : "Fatal",
        "phase" : "Success",
        "message" : "check item succeed",
        "riskSource" : { }
      } ]
    },
    "addonCheckStatus" : {
      "phase" : "Success",
      "itemsStatus" : [ {
        "name" : "AddonLimit",
        "kind" : "Exception",
        "group" : "AddonCheck",
        "level" : "Warning",
        "phase" : "Success",
        "message" : "check item succeed",
        "riskSource" : { }
      }, {
        "name" : "CoreDNSConfLimit",
        "kind" : "Exception",
        "group" : "AddonCheck",
        "level" : "Fatal",
        "phase" : "Success",
        "message" : "check item succeed",
        "riskSource" : { }
      } ]
    },
    "nodeCheckStatus" : {
      "phase" : "Success"
    }
  }
}

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
49
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 ShowAutopilotPreCheckSolution {

    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();
        ShowAutopilotPreCheckRequest request = new ShowAutopilotPreCheckRequest();
        request.withClusterId("{cluster_id}");
        request.withTaskId("{task_id}");
        try {
            ShowAutopilotPreCheckResponse response = client.showAutopilotPreCheck(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
33
# 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 = ShowAutopilotPreCheckRequest()
        request.cluster_id = "{cluster_id}"
        request.task_id = "{task_id}"
        response = client.show_autopilot_pre_check(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
39
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.ShowAutopilotPreCheckRequest{}
	request.ClusterId = "{cluster_id}"
	request.TaskId = "{task_id}"
	response, err := client.ShowAutopilotPreCheck(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 details about a pre-upgrade check task of a cluster are obtained.

Error Codes

See Error Codes.