文档首页> 云容器引擎 CCE> API参考> API> 集群升级> 集群升级前检查
更新时间：2023-12-20 GMT+08:00
在线调试
CLI示例
查看PDF
分享

集群升级前检查

功能介绍

集群升级前检查

调用方法

请参见如何调用API。

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/precheck

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

cluster_id

是

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

apiVersion

是

String

API版本，默认为v3

kind

是

String

资源类型，默认为PreCheckTask

spec

是

PrecheckSpec object

spec是集合类的元素类型，您对需要升级前检查的配置信息的主体部分都在spec中给出。CCE通过spec的描述来执行检查。
表3 PrecheckSpec

参数

是否必选

参数类型

描述

clusterID

否

String

集群ID

clusterVersion

否

String

集群版本

targetVersion

否

String

升级目标版本

skippedCheckItemList

否

Array of skippedCheckItemList objects

跳过检查的项目列表
表4 skippedCheckItemList

参数

是否必选

参数类型

描述

name

否

String

跳过的检查项名称

resourceSelector

否

resourceSelector object

资源标签选择器，仅节点检查涉及该参数，集群检查和插件检查不涉及。
表5 resourceSelector

参数

是否必选

参数类型

描述

key

是

String

标签键值，取值如下

  • node.uid：节点UID。

values

否

Array of strings

标签值列表

operator

是

String

标签逻辑运算符，当前支持如下取值

  • In

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

apiVersion

String

API版本

kind

String

资源类型

metadata

PrecheckCluserResponseMetadata object

升级前检查元数据

spec

PrecheckSpec object

spec是集合类的元素类型，您对需要升级前检查的配置信息的主体部分都在spec中给出。CCE通过spec的描述来执行检查。

status

PrecheckStatus object

集群升级前检查状态
表7 PrecheckCluserResponseMetadata

参数

参数类型

描述

uid

String

检查任务ID
表8 PrecheckSpec

参数

参数类型

描述

clusterID

String

集群ID

clusterVersion

String

集群版本

targetVersion

String

升级目标版本

skippedCheckItemList

Array of skippedCheckItemList objects

跳过检查的项目列表
表9 skippedCheckItemList

参数

参数类型

描述

name

String

跳过的检查项名称

resourceSelector

resourceSelector object

资源标签选择器，仅节点检查涉及该参数，集群检查和插件检查不涉及。
表10 resourceSelector

参数

参数类型

描述

key

String

标签键值，取值如下

  • node.uid：节点UID。

values

Array of strings

标签值列表

operator

String

标签逻辑运算符，当前支持如下取值

  • In
表11 PrecheckStatus

参数

参数类型

描述

phase

String

状态，取值如下

  • Init: 初始化

  • Running 运行中

  • Success 成功

  • Failed 失败

  • Error 错误

expireTimeStamp

String

检查结果过期时间

message

String

信息，一般是执行错误的日志信息

clusterCheckStatus

clusterCheckStatus object

集群限制检查状态

addonCheckStatus

addonCheckStatus object

插件检查状态

nodeCheckStatus

nodeCheckStatus object

节点检查状态
表12 clusterCheckStatus

参数

参数类型

描述

phase

String

状态，取值如下

  • Init: 初始化

  • Running 运行中

  • Success 成功

  • Failed 失败

itemsStatus

Array of PreCheckItemStatus objects

检查项状态集合
表13 addonCheckStatus

参数

参数类型

描述

phase

String

状态，取值如下

  • Init: 初始化

  • Running 运行中

  • Success 成功

  • Failed 失败

itemsStatus

Array of PreCheckItemStatus objects

检查项状态集合
表14 nodeCheckStatus

参数

参数类型

描述

phase

String

状态，取值如下

  • Init: 初始化

  • Running 运行中

  • Success 成功

  • Failed 失败

nodeStageStatus

Array of NodeStageStatus objects

节点检查状态
表15 NodeStageStatus

参数

参数类型

描述

nodeInfo

NodeInfo object

节点信息

itemsStatus

Array of PreCheckItemStatus objects

检查项状态集合
表16 NodeInfo

参数

参数类型

描述

uid

String

节点UID

name

String

节点名称

status

String

状态

nodeType

String

节点类型
表17 PreCheckItemStatus

参数

参数类型

描述

name

String

检查项名称

kind

String

检查项类型，取值如下

  • Exception: 异常类，需要用户解决

  • Risk：风险类，用户确认后可选择跳过

group

String

检查项分组，取值如下

  • LimitCheck: 集群限制检查

  • MasterCheck：控制节点检查

  • NodeCheck：用户节点检查

  • AddonCheck：插件检查

  • ExecuteException：检查流程错误

level

String

检查项风险级别，取值如下

  • Info: 提示级别

  • Warning：风险级别

  • Fatal：严重级别

phase

String

状态，取值如下

  • Init: 初始化

  • Running 运行中

  • Success 成功

  • Failed 失败

message

String

提示信息

riskSource

riskSource object

风险项

errorCodes

Array of strings

错误码集合
表18 riskSource

参数

参数类型

描述

configurationRisks

Array of configurationRisks objects

配置风险项

deprecatedAPIRisks

Array of deprecatedAPIRisks objects

废弃API风险

nodeRisks

Array of nodeRisks objects

节点风险

addonRisks

Array of addonRisks objects

插件风险
表19 configurationRisks

参数

参数类型

描述

package

String

组件名称

sourceFile

String

涉及文件路径

nodeMsg

String

节点信息

field

String

参数值

operation

String

修改操作类型

originalValue

String

原始值

value

String

当前值
表20 deprecatedAPIRisks

参数

参数类型

描述

url

String

请求路径，如/apis/policy/v1beta1/podsecuritypolicies

userAgent

String

客户端信息
表21 nodeRisks

参数

参数类型

描述

NodeID

String

用户节点ID
表22 addonRisks

参数

参数类型

描述

addonTemplateName

String

插件模板名称

alias

String

插件别名

请求示例

集群升级前检查请求体

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/precheck

{
  "kind" : "PreCheckTask",
  "apiVersion" : "v3",
  "spec" : {
    "clusterID" : "8978deaa-1743-11ee-8e46-0255ac10004c",
    "clusterVersion" : "v1.15.11-r1",
    "targetVersion" : "v1.19.16-r80",
    "skippedCheckItemList" : [ ]
  }
}

响应示例

状态码： 200

执行集群升级前检查成功。

{
  "kind" : "PreCheckTask",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "9991b45e-a2be-4b49-aca4-50a25fa6f81e"
  },
  "spec" : {
    "clusterID" : "8978deaa-1743-11ee-8e46-0255ac10004c",
    "clusterVersion" : "v1.15.11-r1",
    "targetVersion" : "v1.19.16-r80"
  },
  "status" : {
    "phase" : "Init",
    "clusterCheckStatus" : {
      "phase" : "Init"
    },
    "addonCheckStatus" : {
      "phase" : "Init"
    },
    "nodeCheckStatus" : {
      "phase" : "Init"
    }
  }
}

状态码

状态码

描述

200

执行集群升级前检查成功。

错误码

请参见错误码。

父主题： 集群升级
分享：

    相关文档

    相关产品