Obtaining Cluster Upgrade Task Details
Function
Upgrade task ID, obtained from the uid field in the response body after the cluster upgrade API is called.
-
Cluster upgrade involves many operations on components. You are advised to upgrade your cluster on the CCE console, a more interactive and intuitive way to reduce operational risks.
-
Currently, cluster upgrade APIs are available only upon request.
Calling Method
For details, see Calling APIs.
URI
GET /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/upgrade/tasks/{task_id}
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
Parameter |
Type |
Description |
---|---|---|
apiVersion |
String |
API version. Defaults to v3. |
kind |
String |
Resource type. Defaults to UpgradeTask. |
metadata |
UpgradeTaskMetadata object |
Upgrade task metadata. |
spec |
UpgradeTaskSpec object |
Upgrade task information. |
status |
UpgradeTaskStatus object |
Upgrade task status. |
Parameter |
Type |
Description |
---|---|---|
uid |
String |
Upgrade task ID. |
creationTimestamp |
String |
Time when a task was created. |
updateTimestamp |
String |
Time when a task is updated. |
Parameter |
Type |
Description |
---|---|---|
version |
String |
Source cluster version. |
targetVersion |
String |
Target cluster version to upgrade to. |
items |
Object |
Additional information about the upgrade task. |
Parameter |
Type |
Description |
---|---|---|
phase |
String |
Indicates the status of the upgrade task. Init: initializing
NOTE:
Queuing: waiting
NOTE:
Pause: paused
NOTE:
Failed: failed |
progress |
String |
Upgrade task progress. |
completionTime |
String |
End time of the upgrade task. |
Example Requests
None
Example Responses
Status code: 200
Cluster upgrade task details obtained.
{ "kind" : "UpgradeTask", "apiVersion" : "v3", "metadata" : { "uid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "creationTimestamp" : "2022-12-16 13:40:20.75671 +0800 CST", "updateTimestamp" : "2022-12-16 13:40:20.756712 +0800 CST" }, "spec" : { "version" : "v1.19.16-r4", "targetVersion" : "v1.23.5-r0" }, "status" : { "phase" : "Init", "progress" : "0.00", "completionTime" : "2022-12-16 13:40:20.756712 +0800 CST" } }
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 ShowUpgradeClusterTaskSolution { 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(); ShowUpgradeClusterTaskRequest request = new ShowUpgradeClusterTaskRequest(); request.withClusterId("{cluster_id}"); request.withTaskId("{task_id}"); try { ShowUpgradeClusterTaskResponse response = client.showUpgradeClusterTask(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 = ShowUpgradeClusterTaskRequest() request.cluster_id = "{cluster_id}" request.task_id = "{task_id}" response = client.show_upgrade_cluster_task(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.ShowUpgradeClusterTaskRequest{} request.ClusterId = "{cluster_id}" request.TaskId = "{task_id}" response, err := client.ShowUpgradeClusterTask(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 upgrade task details obtained. |
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