Performing a Post-upgrade Check for a Cluster
Function
This API is used to perform a post-upgrade check for a cluster, which is used by the customer to check the cluster status after an upgrade and provide feedback after services are restored. Use this API with the console.
Calling Method
For details, see Calling APIs.
URI
POST /autopilot/v3/projects/{project_id}/clusters/{cluster_id}/operation/postcheck
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
apiVersion |
Yes |
String |
Details: API version Constraints: The value is fixed. Options:
|
kind |
Yes |
String |
Details: API type Constraints: The value is fixed. Options:
|
spec |
Yes |
PostcheckResponseSpec object |
spec indicates the configuration confirmed after an upgrade. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
apiVersion |
String |
API version |
kind |
String |
Resource type |
metadata |
Post-upgrade check metadata |
|
spec |
PostcheckSpec object |
Configuration confirmed after a cluster upgrade |
status |
status object |
Status confirmed after a cluster upgrade |
Parameter |
Type |
Description |
---|---|---|
clusterID |
String |
Details: Cluster ID Constraints: None Options: N/A |
clusterVersion |
String |
Details: Source cluster version Constraints: None Options: N/A |
targetVersion |
String |
Details: Current cluster version Constraints: None Options: Supported cluster versions |
Example Requests
Perform a post-upgrade check for a cluster.
POST /autopilot/v3/projects/{project_id}/clusters/{cluster_id}/operation/postcheck { "kind" : "PostCheckTask", "apiVersion" : "v3", "spec" : { "clusterID" : "8978deaa-1743-11ee-8e46-0255ac10004c", "clusterVersion" : "v1.15.11-r1", "targetVersion" : "v1.19.16-r80" } }
Example Responses
Status code: 200
Cluster post-upgrade check succeeded.
{ "kind" : "PostCheckTask", "apiVersion" : "v3", "metadata" : { "uid" : "e99fedf8-348c-4084-b0fd-81bf187df4e0" }, "spec" : { "clusterID" : "8978deaa-1743-11ee-8e46-0255ac10004c", "clusterVersion" : "v1.15.11-r1", "targetVersion" : "v1.19.16-r80" }, "status" : { "phase" : "Success" } }
SDK Sample Code
The SDK sample code is as follows.
Perform a post-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 |
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 CreateAutopilotPostCheckSolution { 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(); CreateAutopilotPostCheckRequest request = new CreateAutopilotPostCheckRequest(); request.withClusterId("{cluster_id}"); PostcheckClusterRequestBody body = new PostcheckClusterRequestBody(); PostcheckSpec specbody = new PostcheckSpec(); specbody.withClusterID("8978deaa-1743-11ee-8e46-0255ac10004c") .withClusterVersion("v1.15.11-r1") .withTargetVersion("v1.19.16-r80"); body.withSpec(specbody); body.withKind("PostCheckTask"); body.withApiVersion("v3"); request.withBody(body); try { CreateAutopilotPostCheckResponse response = client.createAutopilotPostCheck(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 post-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 = CreateAutopilotPostCheckRequest() request.cluster_id = "{cluster_id}" specbody = PostcheckSpec( cluster_id="8978deaa-1743-11ee-8e46-0255ac10004c", cluster_version="v1.15.11-r1", target_version="v1.19.16-r80" ) request.body = PostcheckClusterRequestBody( spec=specbody, kind="PostCheckTask", api_version="v3" ) response = client.create_autopilot_post_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 post-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.CreateAutopilotPostCheckRequest{} request.ClusterId = "{cluster_id}" clusterIDSpec:= "8978deaa-1743-11ee-8e46-0255ac10004c" clusterVersionSpec:= "v1.15.11-r1" targetVersionSpec:= "v1.19.16-r80" specbody := &model.PostcheckSpec{ ClusterID: &clusterIDSpec, ClusterVersion: &clusterVersionSpec, TargetVersion: &targetVersionSpec, } request.Body = &model.PostcheckClusterRequestBody{ Spec: specbody, Kind: "PostCheckTask", ApiVersion: "v3", } response, err := client.CreateAutopilotPostCheck(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 post-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