文档首页/ 云容器引擎 CCE/ API参考/ API/ 集群升级/ 获取集群升级前检查任务详情列表

更新时间：2024-10-10 GMT+08:00

在线调试

CLI示例

查看PDF

获取集群升级前检查任务详情列表

功能介绍

获取集群升级前检查任务详情列表

调用方法

请参见如何调用API。

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/precheck/tasks

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，获取方式请参见如何获取接口URI中参数。约束限制：不涉及取值范围：账号的项目ID 默认取值：不涉及
cluster_id	是	String	参数解释：集群ID，获取方式请参见如何获取接口URI中参数。约束限制：不涉及取值范围：集群ID 默认取值：不涉及

请求参数

无

响应参数

状态码： 200

表2 响应Body参数
参数	参数类型	描述
apiVersion	String	api版本，默认为v3
kind	String	类型
metadata	Metadata object	基本信息，为集合类的元素类型，包含一组由不同名称定义的属性
items	Array of PrecheckClusterTask objects	集群检查任务列表

表3 Metadata
参数	参数类型	描述
uid	String	唯一id标识
name	String	资源名称
labels	Map<String,String>	资源标签，key/value对格式，接口保留字段，填写不会生效
annotations	Map<String,String>	资源注解，由key/value组成
updateTimestamp	String	更新时间
creationTimestamp	String	创建时间

表4 PrecheckClusterTask
参数	参数类型	描述
apiVersion	String	api版本，默认为v3
kind	String	资源类型，默认为PreCheckTask
metadata	PrecheckTaskMetadata object	升级前检查任务元数据信息
spec	PrecheckCluserResponseSpec object	升级前检查任务信息
status	PrecheckStatus object	升级前检查任务状态

表5 PrecheckTaskMetadata
参数	参数类型	描述
uid	String	任务ID
creationTimestamp	String	任务创建时间
updateTimestamp	String	任务更新时间

表6 PrecheckCluserResponseSpec
参数	参数类型	描述
clusterID	String	集群ID
clusterVersion	String	当前集群版本
targetVersion	String	升级目标版本
skippedCheckItemList	Array of skippedCheckItemListResponse objects	跳过检查的项目列表

表7 skippedCheckItemListResponse
参数	参数类型	描述
name	String	跳过检查的项目名称
resourceSelector	resourceSelectorResponse object	资源标签选择器，仅节点检查涉及该参数，集群检查和插件检查不涉及

表8 resourceSelectorResponse
参数	参数类型	描述
key	String	标签键值
values	Array of strings	标签值列表
operator	String	标签值

表9 PrecheckStatus
参数	参数类型	描述
phase	String	状态，取值如下 Init: 初始化 Running 运行中 Success 成功 Failed 失败 Error 错误
expireTimeStamp	String	检查结果过期时间
message	String	信息，一般是执行错误的日志信息
clusterCheckStatus	clusterCheckStatus object	集群限制检查状态
addonCheckStatus	addonCheckStatus object	插件检查状态
nodeCheckStatus	nodeCheckStatus object	节点检查状态

**表10** clusterCheckStatus
参数	参数类型	描述
phase	String	状态，取值如下 Init: 初始化 Running 运行中 Success 成功 Failed 失败
itemsStatus	Array of PreCheckItemStatus objects	检查项状态集合

**表11** addonCheckStatus
参数	参数类型	描述
phase	String	状态，取值如下 Init: 初始化 Running 运行中 Success 成功 Failed 失败
itemsStatus	Array of PreCheckItemStatus objects	检查项状态集合

**表12** nodeCheckStatus
参数	参数类型	描述
phase	String	状态，取值如下 Init: 初始化 Running 运行中 Success 成功 Failed 失败
nodeStageStatus	Array of NodeStageStatus objects	节点检查状态

**表13** NodeStageStatus
参数	参数类型	描述
nodeInfo	NodeInfo object	节点信息
itemsStatus	Array of PreCheckItemStatus objects	检查项状态集合

**表14** NodeInfo
参数	参数类型	描述
uid	String	节点UID
name	String	节点名称
status	String	状态
nodeType	String	节点类型

**表15** 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	错误码集合

**表16** riskSource
参数	参数类型	描述
configurationRisks	Array of configurationRisks objects	配置风险项
deprecatedAPIRisks	Array of deprecatedAPIRisks objects	废弃API风险
nodeRisks	Array of nodeRisks objects	节点风险
addonRisks	Array of addonRisks objects	插件风险

**表17** configurationRisks
参数	参数类型	描述
package	String	组件名称
sourceFile	String	涉及文件路径
nodeMsg	String	节点信息
field	String	参数值
operation	String	修改操作类型
originalValue	String	原始值
value	String	当前值

**表18** deprecatedAPIRisks
参数	参数类型	描述
url	String	请求路径，如/apis/policy/v1beta1/podsecuritypolicies
userAgent	String	客户端信息

**表19** nodeRisks
参数	参数类型	描述
NodeID	String	用户节点ID

**表20** addonRisks
参数	参数类型	描述
addonTemplateName	String	插件模板名称
alias	String	插件别名

请求示例

无

响应示例

状态码： 200

表示获取集群升级前检查任务详情列表成功。

{
  "kind" : "List",
  "apiVersion" : "v3",
  "metadata" : { },
  "items" : [ {
    "kind" : "PreCheckTask",
    "apiVersion" : "v3",
    "metadata" : {
      "uid" : "10b52d23-080a-4b7d-bf83-64b4687ca786",
      "creationTimestamp" : "2023-12-16 07:07:11.099111 +0000 UTC",
      "updateTimestamp" : "2023-12-16 07:09:10.425622 +0000 UTC"
    },
    "spec" : {
      "clusterVersion" : "v1.23.5-r0",
      "targetVersion" : "v1.23.11-r0"
    },
    "status" : {
      "phase" : "Failed",
      "clusterCheckStatus" : {
        "phase" : "Success",
        "itemsStatus" : [ {
          "name" : "DeprecatedApiCheck",
          "kind" : "Risk",
          "group" : "LimitCheck",
          "level" : "Info",
          "phase" : "Success",
          "message" : "check item succeed",
          "riskSource" : { }
        }, {
          "name" : "BlackLimit",
          "kind" : "Exception",
          "group" : "LimitCheck",
          "level" : "Fatal",
          "phase" : "Success",
          "message" : "check item succeed",
          "riskSource" : { }
        }, {
          "name" : "MasterSSH",
          "kind" : "Exception",
          "group" : "LimitCheck",
          "level" : "Fatal",
          "phase" : "Success",
          "message" : "check item succeed",
          "riskSource" : { }
        }, {
          "name" : "ReleaseLimit",
          "kind" : "Exception",
          "group" : "LimitCheck",
          "level" : "Warning",
          "phase" : "Success",
          "message" : "check item succeed",
          "riskSource" : { }
        }, {
          "name" : "ClusterNoArm",
          "kind" : "Exception",
          "group" : "LimitCheck",
          "level" : "Warning",
          "phase" : "Success",
          "message" : "check item succeed",
          "riskSource" : { }
        } ]
      },
      "addonCheckStatus" : {
        "phase" : "Failed",
        "itemsStatus" : [ {
          "name" : "AddonLimit",
          "kind" : "Exception",
          "group" : "AddonCheck",
          "level" : "Warning",
          "phase" : "Failed",
          "message" : "addon [ CoreDNS,CCE Container Storage (Everest) ] status is abnormal, check and try again",
          "riskSource" : {
            "addonRisks" : [ {
              "addonTemplateName" : "coredns",
              "alias" : "CoreDNS"
            }, {
              "addonTemplateName" : "everest",
              "alias" : "CCE Container Storage (Everest)"
            } ]
          }
        }, {
          "name" : "CoreDNSConfLimit",
          "kind" : "Exception",
          "group" : "AddonCheck",
          "level" : "Fatal",
          "phase" : "Success",
          "message" : "check item succeed",
          "riskSource" : { }
        }, {
          "name" : "EverestLimitHungVersion",
          "kind" : "Risk",
          "group" : "AddonCheck",
          "level" : "Fatal",
          "phase" : "Success",
          "message" : "check item succeed",
          "riskSource" : { }
        } ]
      },
      "nodeCheckStatus" : {
        "phase" : "Success"
      }
    }
  } ]
}

状态码

状态码	描述
200	表示获取集群升级前检查任务详情列表成功。

错误码

请参见错误码。

父主题：集群升级

上一篇：获取集群升级前检查任务详情

下一篇：集群升级后确认

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

获取集群升级前检查任务详情列表

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线