集群升级前检查
功能介绍
集群升级前检查
调用方法
请参见如何调用API。
URI
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/precheck
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
cluster_id |
是 |
String |
参数解释: 集群ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 集群ID 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
apiVersion |
是 |
String |
参数解释: API版本 约束限制: 固定值 取值范围:
|
kind |
是 |
String |
参数解释: API类型 约束限制: 固定值 取值范围:
|
spec |
是 |
PrecheckSpec object |
参数解释: spec是集合类的元素类型,您对需要升级前检查的配置信息的主体部分都在spec中给出。CCE通过spec的描述来执行检查。 约束限制: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
clusterID |
是 |
String |
参数解释: 集群ID 约束限制: 不涉及 取值范围: 不涉及 |
clusterVersion |
是 |
String |
参数解释: 集群版本,请填写当前集群的补丁版本,可登录控制台在总览页面进行查看 约束限制: 不涉及 取值范围: 不涉及 |
targetVersion |
是 |
String |
参数解释: 升级目标版本,如果填写大版本,则自动选择最新补丁版本 约束限制: 不涉及 取值范围: 高于集群当前版本的可用集群版本 |
skippedCheckItemList |
否 |
Array of skippedCheckItemList objects |
参数解释: 跳过检查的项目列表 约束限制: 不涉及 取值范围: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
参数解释: 跳过检查的项目名称 约束限制: 不涉及 取值范围: 不涉及 |
resourceSelector |
否 |
resourceSelector object |
参数解释: 资源标签选择器 约束限制: 仅节点检查涉及该参数,集群检查和插件检查不涉及 取值范围: 不涉及 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
apiVersion |
String |
API版本 |
kind |
String |
资源类型 |
metadata |
升级前检查元数据 |
|
spec |
PrecheckCluserResponseSpec object |
spec是集合类的元素类型,您对需要升级前检查的配置信息的主体部分都在spec中给出。CCE通过spec的描述来执行检查。 |
status |
PrecheckStatus object |
集群升级前检查状态 |
参数 |
参数类型 |
描述 |
---|---|---|
clusterID |
String |
集群ID |
clusterVersion |
String |
当前集群版本 |
targetVersion |
String |
升级目标版本 |
skippedCheckItemList |
Array of skippedCheckItemListResponse objects |
跳过检查的项目列表 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
跳过检查的项目名称 |
resourceSelector |
resourceSelectorResponse object |
资源标签选择器,仅节点检查涉及该参数,集群检查和插件检查不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
标签键值 |
values |
Array of strings |
标签值列表 |
operator |
String |
标签值 |
参数 |
参数类型 |
描述 |
---|---|---|
phase |
String |
状态,取值如下
|
expireTimeStamp |
String |
检查结果过期时间 |
message |
String |
信息,一般是执行错误的日志信息 |
clusterCheckStatus |
clusterCheckStatus object |
集群限制检查状态 |
addonCheckStatus |
addonCheckStatus object |
插件检查状态 |
nodeCheckStatus |
nodeCheckStatus object |
节点检查状态 |
参数 |
参数类型 |
描述 |
---|---|---|
phase |
String |
状态,取值如下
|
itemsStatus |
Array of PreCheckItemStatus objects |
检查项状态集合 |
参数 |
参数类型 |
描述 |
---|---|---|
phase |
String |
状态,取值如下
|
itemsStatus |
Array of PreCheckItemStatus objects |
检查项状态集合 |
参数 |
参数类型 |
描述 |
---|---|---|
phase |
String |
状态,取值如下
|
nodeStageStatus |
Array of NodeStageStatus objects |
节点检查状态 |
参数 |
参数类型 |
描述 |
---|---|---|
nodeInfo |
NodeInfo object |
节点信息 |
itemsStatus |
Array of PreCheckItemStatus objects |
检查项状态集合 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
检查项名称 |
kind |
String |
检查项类型,取值如下
|
group |
String |
检查项分组,取值如下
|
level |
String |
检查项风险级别,取值如下
|
phase |
String |
状态,取值如下
|
message |
String |
提示信息 |
riskSource |
riskSource object |
风险项 |
errorCodes |
Array of strings |
错误码集合 |
参数 |
参数类型 |
描述 |
---|---|---|
configurationRisks |
Array of configurationRisks objects |
配置风险项 |
deprecatedAPIRisks |
Array of deprecatedAPIRisks objects |
废弃API风险 |
nodeRisks |
Array of nodeRisks objects |
节点风险 |
addonRisks |
Array of addonRisks objects |
插件风险 |
参数 |
参数类型 |
描述 |
---|---|---|
package |
String |
组件名称 |
sourceFile |
String |
涉及文件路径 |
nodeMsg |
String |
节点信息 |
field |
String |
参数值 |
operation |
String |
修改操作类型 |
originalValue |
String |
原始值 |
value |
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 |
执行集群升级前检查成功。 |
错误码
请参见错误码。