文档首页/ 云容器引擎 CCE/ API参考 (联盟区域) / API/ 集群升级/ 更新指定集群升级引导任务状态
更新时间:2026-09-30 GMT+08:00

更新指定集群升级引导任务状态

功能介绍

该API用于更新指定集群升级引导任务状态,当前仅适用于取消升级流程

调用该API时升级流程引导任务状态不能为进行中(running) 已完成(success) 已取消(cancel),升级子任务状态不能为running(进行中) init(已初始化) pause(任务被暂停) queue(队列中)

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方式请参见如何获取接口URI中参数。

约束限制:

不涉及

取值范围:

账号的项目ID

默认取值:

不涉及

cluster_id

是

String

参数解释:

集群ID,获取方式请参见如何获取接口URI中参数。

约束限制:

不涉及

取值范围:

集群ID

默认取值:

不涉及

upgrade_workflow_id

是

String

参数解释:

集群升级任务引导流程ID,获取方式请参见如何获取接口URI中参数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释:

消息体的类型(格式),默认为application/json,有其他取值时会在具体接口中专门说明。

约束限制:

GET方法不做校验

取值范围:

不涉及

默认取值:

不涉及

X-Auth-Token

是

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

status

否

status object

参数解释:

集群升级流程的执行状态

约束限制:

当前仅支持Cancel

取值范围:

  • Cancel:表示取消升级

默认取值:

不涉及

表4 status

参数

是否必选

参数类型

描述

phase

否

String

参数解释:

集群升级流程的执行状态

约束限制:

当前仅支持Cancel

取值范围:

  • Cancel:表示取消升级

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

kind

String

参数解释:

API类型,固定值"WorkFlowTask",该值不可修改。

取值范围:

  • WorkFlowTask

apiVersion

String

参数解释:

API版本,固定值"v3",该值不可修改。

取值范围:

  • v3

metadata

Metadata object

参数解释:

升级流程的元数据信息

取值范围:

不涉及

spec

WorkFlowResponseSpec object

参数解释:

集合类的元素类型,您对集群升级流程主体都在spec中给出。CCE通过spec的描述来创建或更新对象。

取值范围:

不涉及

status

WorkFlowStatus object

参数解释:

集合类的元素类型,用于记录本次集群升级流程的当前状态信息,包含了集群升级流程的各个流程的执行状态。

取值范围:

不涉及

表6 Metadata

参数

参数类型

描述

uid

String

参数解释:

唯一id标识

取值范围:

不涉及

name

String

参数解释:

资源名称

取值范围:

不涉及

labels

Map<String,String>

参数解释:

资源标签,key/value对格式,接口保留字段,填写不会生效

取值范围:

不涉及

annotations

Map<String,String>

参数解释:

资源注解,由key/value组成

取值范围:

不涉及

updateTimestamp

String

参数解释:

更新时间

取值范围:

不涉及

creationTimestamp

String

参数解释:

创建时间

取值范围:

不涉及

表7 WorkFlowResponseSpec

参数

参数类型

描述

clusterID

String

参数解释:

集群ID

取值范围:

不涉及

clusterVersion

String

参数解释:

当前集群版本

取值范围:

不涉及

targetVersion

String

参数解释:

本次集群升级的目标版本

取值范围:

不涉及

表8 WorkFlowStatus

参数

参数类型

描述

phase

String

参数解释:

集群升级流程的执行状态

取值范围:

  • Init:表示该升级流程中还未有任何任务开始运行

  • Running:表示该升级流程中已有任务开始执行

  • Pending:表示该升级流程中有任务执行失败

  • Success:表示该升级流程中所有任务都已执行成功

  • Cancel:表示该升级流程已被取消

pointStatuses

Array of PointStatus objects

参数解释:

升级流程中的各个任务项的执行状态

取值范围:

不涉及

lineStatuses

Array of LineStatus objects

参数解释:

表示该升级流程的任务执行线路

取值范围:

不涉及

表9 PointStatus

参数

参数类型

描述

taskType

String

参数解释:

集群升级任务类型

取值范围:

  • Cluster:集群升级任务

  • PreCheck:集群升级预检查任务

  • Rollback:集群升级回归任务

  • Snapshot:集群升级快照任务

  • PostCheck:集群升级后检查任务

taskID

String

参数解释:

升级任务项ID

取值范围:

不涉及

status

String

参数解释:

集群升级状态

取值范围:

  • Init:任务初始状态

  • Queuing:任务已进入执行队列

  • Running:任务开始执行

  • Success:任务执行成功

  • Failed:任务执行失败

startTimeStamp

String

参数解释:

升级任务开始时间

取值范围:

不涉及

endTimeStamp

String

参数解释:

升级任务结束时间

取值范围:

不涉及

expireTimeStamp

String

参数解释:

升级任务过期时间(当前仅升级前检查任务适用)

取值范围:

不涉及

表10 LineStatus

参数

参数类型

描述

startPoint

Point object

参数解释:

线路起点

取值范围:

不涉及

endPoint

Point object

参数解释:

线路终点

取值范围:

不涉及

critical

Boolean

参数解释:

表示是否为关键线路(关键线路未执行无法取消升级流程)

取值范围:

  • true:是关键线路

  • false:非关键线路

表11 Point

参数

参数类型

描述

taskType

String

参数解释:

集群升级任务类型

取值范围:

不涉及

请求示例

取消升级流程

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

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

响应示例

状态码: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" : "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"
      }
    } ]
  }
}

状态码

状态码

描述

200

表示更新集群升级引导任务状态成功

错误码

请参见错误码。