Obtaining Details About a Specified Cluster Upgrade Task
Function
This API is used to obtain details about an upgrade booting task based on the task ID.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
URI
GET /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/upgradeworkflows/{upgrade_workflow_id}
| 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 |
| upgrade_workflow_id | Yes | String | Definition: Booting process ID of a cluster upgrade task. For details about how to obtain the ID, see Obtaining API URI Parameters. Constraints: N/A Range: N/A Default Value: N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| Content-Type | Yes | String | Definition: Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any. Constraints: GET requests are not validated. Range: N/A 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
| Parameter | Type | Description |
|---|---|---|
| kind | String | Definition: API type. The value is fixed at WorkFlowTask and cannot be changed. Range: |
| apiVersion | String | Definition: API version. The value is fixed at v3 and cannot be changed. Range: |
| metadata | Metadata object | Definition: Upgrade process metadata Range: N/A |
| spec | WorkFlowResponseSpec object | Definition: Element type of the collection class. The main body of the cluster upgrade process is provided in spec. CCE creates or updates objects by defining or updating spec. Range: N/A |
| status | WorkFlowStatus object | Definition: Element type of the collection class, which is used to record the current status of the cluster upgrade process, including the execution status of each process in the cluster upgrade process. Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| uid | String | Definition Unique ID Range N/A |
| name | String | Definition Resource name Range N/A |
| labels | Map<String,String> | Definition Resource labels in key-value pairs. This is a reserved field. Inputting values will not work. Range N/A |
| annotations | Map<String,String> | Definition Resource annotations in the format of key-value pairs Range N/A |
| updateTimestamp | String | Definition Update time Range N/A |
| creationTimestamp | String | Definition Creation time Range N/A |
| Parameter | Type | Description |
|---|---|---|
| clusterID | String | Definition: Cluster ID Range: N/A |
| clusterVersion | String | Definition: Current cluster version Range: N/A |
| targetVersion | String | Definition: Target cluster version Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| phase | String | Definition: Execution status of the cluster upgrade process Range: |
| pointStatuses | Array of PointStatus objects | Definition: Execution status of each task in the upgrade process Range: N/A |
| lineStatuses | Array of LineStatus objects | Definition: Task execution path of the upgrade process Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| taskType | String | Definition: Cluster upgrade task type Range: |
| taskID | String | Definition: Upgrade task ID Range: N/A |
| status | String | Definition: Cluster upgrade status Range: |
| startTimeStamp | String | Definition: Start time of an upgrade task Range: N/A |
| endTimeStamp | String | Definition: End time of an upgrade task Range: N/A |
| expireTimeStamp | String | Definition: Expiration time of an upgrade task (only for pre-upgrade check tasks) Range: N/A |
| Parameter | Type | Description |
|---|---|---|
| startPoint | Point object | Definition: Start point of a line Range: N/A |
| endPoint | Point object | Definition: End point of a line Range: N/A |
| critical | Boolean | Definition: Whether it is a key line. An upgrade cannot be canceled if the key line is not executed. Range: |
Example Requests
None
Example Responses
Status code: 200
Details about the cluster upgrade task are obtained.
{
"kind" : "WorkFlowTask",
"apiVersion" : "v3",
"metadata" : {
"uid" : "c271e39e-1a6e-4d3d-8fa8-2a36329c68d1",
"creationTimestamp" : "2023-11-25 06:32:34.923248 +0000 UTC",
"updateTimestamp" : "2023-11-25 07:49:30.281911 +0000 UTC"
},
"spec" : {
"clusterID" : "b4b9e60f-8aa2-11ee-af09-0255ac10004f",
"clusterVersion" : "v1.17.17-r0",
"targetVersion" : "v1.19.16-r80"
},
"status" : {
"phase" : "Pending",
"pointStatuses" : [ {
"taskType" : "PreCheck",
"taskID" : "f61e008c-1600-41c0-9bde-121de5a30660",
"status" : "Success",
"startTimeStamp" : "2023-11-25 07:20:04.592972 +0000 UTC",
"endTimeStamp" : "2023-11-25 07:21:05.518966 +0000 UTC",
"expireTimeStamp" : "2023-11-25 08:21:05.518966 +0000 UTC"
}, {
"taskType" : "Snapshot"
}, {
"taskType" : "Cluster",
"taskID" : "6d799ff6-3afe-4242-80b4-6f0a0fa746cb",
"status" : "Failed",
"startTimeStamp" : "2023-11-25 07:49:30.283459 +0000 UTC",
"endTimeStamp" : "2023-11-25 07:58:35.507243 +0000 UTC"
}, {
"taskType" : "PostCheck"
} ],
"lineStatuses" : [ {
"startPoint" : {
"taskType" : "PreCheck"
},
"endPoint" : {
"taskType" : "Cluster"
}
}, {
"startPoint" : {
"taskType" : "Cluster"
},
"endPoint" : {
"taskType" : "PostCheck"
}
} ]
}
} 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 ShowUpgradeWorkFlowSolution { 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(); ShowUpgradeWorkFlowRequest request = new ShowUpgradeWorkFlowRequest(); request.withClusterId("{cluster_id}"); request.withUpgradeWorkflowId("{upgrade_workflow_id}"); try { ShowUpgradeWorkFlowResponse response = client.showUpgradeWorkFlow(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 = ShowUpgradeWorkFlowRequest() request.cluster_id = "{cluster_id}" request.upgrade_workflow_id = "{upgrade_workflow_id}" response = client.show_upgrade_work_flow(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 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cce.CceClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cce.NewCceClient(hcClient) request := &model.ShowUpgradeWorkFlowRequest{} request.ClusterId = "{cluster_id}" request.UpgradeWorkflowId = "{upgrade_workflow_id}" response, err := client.ShowUpgradeWorkFlow(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 | Details about the cluster upgrade task are obtained. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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