Help Center/ Cloud Container Engine/ API Reference (Ally Region)/ APIs/ Cluster Upgrade/ Obtaining Details About a Specified Cluster Upgrade Task
Updated on 2026-09-30 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

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.

URI

GET /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

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

Table 2 Request header 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

Table 3 Response body parameters

Parameter

Type

Description

kind

String

Definition:

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

Range:

  • WorkFlowTask

apiVersion

String

Definition:

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

Range:

  • v3

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
Table 4 Metadata

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
Table 5 WorkFlowResponseSpec

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
Table 6 WorkFlowStatus

Parameter

Type

Description

phase

String

Definition:

Execution status of the cluster upgrade process

Range:

  • 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 failed 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

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
Table 7 PointStatus

Parameter

Type

Description

taskType

String

Definition:

Cluster upgrade task type

Range:

  • 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

Definition:

Upgrade task ID

Range:

N/A

status

String

Definition:

Cluster upgrade status

Range:

  • Init: The task is in the initial state.

  • Queuing: The task has entered the execution queue.

  • Running: The task starts to be executed.

  • Success: The task has been executed.

  • Failed: The task failed to be executed.

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
Table 8 LineStatus

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:

  • true: The line is a key line.

  • false: The line is not a key line.
Table 9 Point

Parameter

Type

Description

taskType

String

Definition:

Cluster upgrade task type

Range:

N/A

Example Requests

None

Example Responses

Status code: 200

{
  "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"
      },
      "critical" : true
    }, {
      "startPoint" : {
        "taskType" : "Cluster"
      },
      "endPoint" : {
        "taskType" : "PostCheck"
      },
      "critical" : false
    } ]
  }
}

Status Codes

Status Code

Description

200

Details about the cluster upgrade task are obtained.

Error Codes

See Error Codes.

Parent topic: Cluster Upgrade