Performing a Pre-upgrade Check for a Cluster
Function
This API is used to perform a pre-upgrade check for a cluster.
Calling Method
For details, see Calling APIs.
URI
POST /autopilot/v3/projects/{project_id}/clusters/{cluster_id}/operation/precheck
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
apiVersion |
Yes |
String |
API version, which defaults to v3 |
kind |
Yes |
String |
Resource type, which defaults to PreCheckTask |
spec |
Yes |
PrecheckSpec object |
spec is an element type of the collection class. The main body of the configuration that needs to be checked before an upgrade is provided in spec. CCE checks the configuration based on the spec description. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
clusterID |
Yes |
String |
Cluster ID |
clusterVersion |
Yes |
String |
Cluster version |
targetVersion |
Yes |
String |
Target Version |
skippedCheckItemList |
No |
Array of skippedCheckItemList objects |
Skipped check items |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Names of the skipped check items |
resourceSelector |
No |
resourceSelector object |
Resource tag selector. This parameter is available only for node check, but not for cluster check or add-on check. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
apiVersion |
String |
API version |
kind |
String |
Resource type |
metadata |
Pre-upgrade check metadata |
|
spec |
PrecheckCluserResponseSpec object |
spec is an element type of the collection class. The main body of the configuration that needs to be checked before an upgrade is provided in spec. CCE checks the configuration based on the spec description. |
status |
PrecheckStatus object |
Pre-upgrade check status of a cluster |
Parameter |
Type |
Description |
---|---|---|
clusterID |
String |
Cluster ID |
clusterVersion |
String |
Current cluster version |
targetVersion |
String |
Target version |
skippedCheckItemList |
Array of skippedCheckItemListResponse objects |
Skipped check items |
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. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key |
values |
Array of strings |
Tag value list |
operator |
String |
Tag value |
Parameter |
Type |
Description |
---|---|---|
phase |
String |
Status. Options:
|
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 |
Parameter |
Type |
Description |
---|---|---|
phase |
String |
Status. Options:
|
itemsStatus |
Array of PreCheckItemStatus objects |
Compliance set by check item |
Parameter |
Type |
Description |
---|---|---|
phase |
String |
Status. Options:
|
itemsStatus |
Array of PreCheckItemStatus objects |
Compliance set by check item |
Parameter |
Type |
Description |
---|---|---|
phase |
String |
Status. Options:
|
nodeStageStatus |
Array of NodeStageStatus objects |
Node check status |
Parameter |
Type |
Description |
---|---|---|
nodeInfo |
NodeInfo object |
Node information |
itemsStatus |
Array of PreCheckItemStatus objects |
Compliance set by check item |
Parameter |
Type |
Description |
---|---|---|
uid |
String |
Node UID |
name |
String |
Node name |
status |
String |
Status |
nodeType |
String |
Node type |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Check item |
kind |
String |
Check item type. Options:
|
group |
String |
Check item group. Options:
|
level |
String |
Check item severity. Options:
|
phase |
String |
Status. Options:
|
message |
String |
Information |
riskSource |
riskSource object |
Risk item |
errorCodes |
Array of strings |
Error code set |
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 |
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 |
Example Requests
Perform a pre-upgrade check for a cluster.
POST /autopilot/v3/projects/{project_id}/clusters/{cluster_id}/operation/precheck { "kind" : "PreCheckTask", "apiVersion" : "v3", "spec" : { "clusterID" : "8978deaa-1743-11ee-8e46-0255ac10004c", "clusterVersion" : "v1.15.11-r1", "targetVersion" : "v1.19.16-r80", "skippedCheckItemList" : [ ] } }
Example Responses
Status code: 200
Cluster pre-upgrade check succeeded.
{ "kind" : "PreCheckTask", "apiVersion" : "v3", "metadata" : { "uid" : "9991b45e-a2be-4b49-aca4-50a25fa6f81e" }, "spec" : { "clusterID" : "8978deaa-1743-11ee-8e46-0255ac10004c", "clusterVersion" : "v1.15.11-r1", "targetVersion" : "v1.19.16-r80" }, "status" : { "phase" : "Init", "clusterCheckStatus" : { "phase" : "Init" }, "addonCheckStatus" : { "phase" : "Init" }, "nodeCheckStatus" : { "phase" : "Init" } } }
SDK Sample Code
The SDK sample code is as follows.
Perform a pre-upgrade check for a cluster.
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 50 51 52 53 54 55 56 57 58 59 |
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.*; import java.util.List; import java.util.ArrayList; public class CreateAutopilotPreCheckSolution { 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(); CreateAutopilotPreCheckRequest request = new CreateAutopilotPreCheckRequest(); request.withClusterId("{cluster_id}"); PrecheckClusterRequestBody body = new PrecheckClusterRequestBody(); PrecheckSpec specbody = new PrecheckSpec(); specbody.withClusterID("8978deaa-1743-11ee-8e46-0255ac10004c") .withClusterVersion("v1.15.11-r1") .withTargetVersion("v1.19.16-r80"); body.withSpec(specbody); body.withKind("PreCheckTask"); body.withApiVersion("v3"); request.withBody(body); try { CreateAutopilotPreCheckResponse response = client.createAutopilotPreCheck(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()); } } } |
Perform a pre-upgrade check for a cluster.
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 |
# 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 = CreateAutopilotPreCheckRequest() request.cluster_id = "{cluster_id}" specbody = PrecheckSpec( cluster_id="8978deaa-1743-11ee-8e46-0255ac10004c", cluster_version="v1.15.11-r1", target_version="v1.19.16-r80" ) request.body = PrecheckClusterRequestBody( spec=specbody, kind="PreCheckTask", api_version="v3" ) response = client.create_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) |
Perform a pre-upgrade check for a cluster.
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 50 51 |
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.CreateAutopilotPreCheckRequest{} request.ClusterId = "{cluster_id}" clusterIDSpec:= "8978deaa-1743-11ee-8e46-0255ac10004c" clusterVersionSpec:= "v1.15.11-r1" targetVersionSpec:= "v1.19.16-r80" specbody := &model.PrecheckSpec{ ClusterID: &clusterIDSpec, ClusterVersion: &clusterVersionSpec, TargetVersion: &targetVersionSpec, } request.Body = &model.PrecheckClusterRequestBody{ Spec: specbody, Kind: "PreCheckTask", ApiVersion: "v3", } response, err := client.CreateAutopilotPreCheck(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 |
Cluster pre-upgrade check succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot