Help Center/ Cloud Container Engine/ API Reference/ APIs/ Cluster Upgrade/ Updating the Status of a Specified Cluster Upgrade Booting Task

Updated on 2024-04-23 GMT+08:00

View PDF

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.

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	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.
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	Message body type (format).
X-Auth-Token	Yes	String	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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
status	No	status object	Updated workflow status. (Only Cancel is supported.)

**Table 4** status
Parameter	Mandatory	Type	Description
phase	No	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.

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	WorkFlowSpec 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** WorkFlowSpec
Parameter	Type	Description
clusterID	String	Cluster ID, which uniquely identifies a resource. The value is automatically generated after the object is created. A custom value will not take effect.
clusterVersion	String	Current version of the cluster to be upgraded
targetVersion	String	Target version of the cluster

**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	String	Path startpoint
endPoint	String	Path endpoint
critical	String	Whether it is a key path. An upgrade can be canceled only after the key path is executed.

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"
      }
    } ]
  }
}