Help Center/ Cloud Container Engine/ API Reference/ APIs/ Cluster Upgrade/ Updating the Status of a Specified Cluster Upgrade Booting Task
Updated on 2024-11-06 GMT+08:00

Updating the Status of a Specified Cluster Upgrade Booting Task

Function

This API is used to update the status of a specified cluster upgrade booting task. This API applies only to the upgrade cancellation process.

When this API is called, the status of the upgrade process booting task cannot be running, success, or cancel, and the status of the upgrade subtask cannot be running, init, pause, or queue.

Calling Method

For details, see Calling APIs.

URI

PATCH /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/upgradeworkflows/{upgrade_workflow_id}

Table 1 Path Parameters

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

Booting process ID of a cluster upgrade task. For details about how to obtain the ID, see Obtaining API URI Parameters.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Details:

Request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

status

No

status object

Details:

Updated workflow status (Only Cancel is supported.)

Constraints:

None

Table 4 status

Parameter

Mandatory

Type

Description

phase

No

String

Details:

Execution status of the cluster upgrade process

Constraints:

None

Options:

  • Cancel: The upgrade is canceled.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

kind

String

API type. The value is fixed at WorkFlowTask and cannot be changed.

apiVersion

String

API version. The value is fixed at v3 and cannot be changed.

metadata

Metadata object

Upgrade process metadata

spec

WorkFlowResponseSpec object

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.

status

WorkFlowStatus object

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.

Table 6 Metadata

Parameter

Type

Description

uid

String

Unique ID.

name

String

Resource name

labels

Map<String,String>

Resource labels in key-value pairs. This is a reserved field and does not take effect.

annotations

Map<String,String>

Resource annotations in the format of key-value pairs.

updateTimestamp

String

Update time.

creationTimestamp

String

Creation time.

Table 7 WorkFlowResponseSpec

Parameter

Type

Description

clusterID

String

Cluster ID

clusterVersion

String

Current cluster version

targetVersion

String

Target cluster version

Table 8 WorkFlowStatus

Parameter

Type

Description

phase

String

Execution status of the cluster upgrade process. Options:

Init: No task is running in the upgrade process.

Running: Some tasks in the upgrade process are being executed.

Pending: A task in the upgrade process fails to be executed.

Success: All tasks in the upgrade process have been executed.

Cancel: The upgrade process has been canceled.

pointStatuses

Array of PointStatus objects

Execution status of each task in the upgrade process

lineStatuses

Array of LineStatus objects

Task execution path of the upgrade process

Table 9 PointStatus

Parameter

Type

Description

taskType

String

Cluster upgrade task type. Options:

Cluster: a cluster upgrade task

PreCheck: a cluster pre-upgrade check task

Rollback: a cluster rollback task

Snapshot: a cluster upgrade snapshot task

PostCheck: a cluster post-upgrade check task

taskID

String

Upgrade task ID

status

String

Cluster upgrade status. Options:

Init: The task is in the initial state.

Queuing: The task is in the execution queue.

Running: The task is being executed.

Success: The task has been executed.

Failed: Executing the task failed.

startTimeStamp

String

Start time of the upgrade task

endTimeStamp

String

End time of the upgrade task

expireTimeStamp

String

Expiration time of the upgrade task (only for pre-upgrade check tasks)

Table 10 LineStatus

Parameter

Type

Description

startPoint

Point object

Path startpoint

endPoint

Point object

Path endpoint

critical

String

Whether it is a key path. An upgrade can be canceled only after the key path is executed.

Table 11 Point

Parameter

Type

Description

taskType

String

Cluster upgrade task type

Example Requests

Cancel the upgrade process.

PATCH /api/v3/projects/47eb1d64cbeb45cfa01ae20af4f4b563/clusters/f9960c6b-8e60-11ee-9754-0255ac100b05/operation/upgradeworkflows/d0b7e319-8172-424c-86ea-543cd23f9756

{
  "status" : {
    "phase" : "Cancel"
  }
}

Example Responses

Status code: 200

The status of the cluster upgrade booting task is updated.

{
  "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" : "Cancel",
    "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.

Cancel the upgrade process.

 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
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 UpgradeWorkFlowUpdateSolution {

    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();
        UpgradeWorkFlowUpdateRequest request = new UpgradeWorkFlowUpdateRequest();
        request.withClusterId("{cluster_id}");
        request.withUpgradeWorkflowId("{upgrade_workflow_id}");
        UpgradeWorkFlowUpdateRequestBody body = new UpgradeWorkFlowUpdateRequestBody();
        UpgradeWorkFlowUpdateRequestBodyStatus statusbody = new UpgradeWorkFlowUpdateRequestBodyStatus();
        statusbody.withPhase(UpgradeWorkFlowUpdateRequestBodyStatus.PhaseEnum.fromValue("Cancel"));
        body.withStatus(statusbody);
        request.withBody(body);
        try {
            UpgradeWorkFlowUpdateResponse response = client.upgradeWorkFlowUpdate(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());
        }
    }
}

Cancel the upgrade process.

 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
# 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 = UpgradeWorkFlowUpdateRequest()
        request.cluster_id = "{cluster_id}"
        request.upgrade_workflow_id = "{upgrade_workflow_id}"
        statusbody = UpgradeWorkFlowUpdateRequestBodyStatus(
            phase="Cancel"
        )
        request.body = UpgradeWorkFlowUpdateRequestBody(
            status=statusbody
        )
        response = client.upgrade_work_flow_update(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Cancel the upgrade process.

 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
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.UpgradeWorkFlowUpdateRequest{}
	request.ClusterId = "{cluster_id}"
	request.UpgradeWorkflowId = "{upgrade_workflow_id}"
	phaseStatus:= model.GetUpgradeWorkFlowUpdateRequestBodyStatusPhaseEnum().CANCEL
	statusbody := &model.UpgradeWorkFlowUpdateRequestBodyStatus{
		Phase: &phaseStatus,
	}
	request.Body = &model.UpgradeWorkFlowUpdateRequestBody{
		Status: statusbody,
	}
	response, err := client.UpgradeWorkFlowUpdate(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 status of the cluster upgrade booting task is updated.

Error Codes

See Error Codes.