文档首页/ 云容器引擎 CCE/ API参考/ API/ 插件管理/ 获取插件检查任务结果列表
更新时间:2025-09-28 GMT+08:00
分享

获取插件检查任务结果列表

功能介绍

获取集群下插件检查任务结果列表

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

账号的项目ID

默认取值:

不涉及

cluster_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

集群ID

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

type

String

参数解释:

根据插件检查类型筛选结果

约束限制:

不涉及

取值范围:

  • addonStatic: 运行中插件巡检

  • addonUpgrade: 插件升级前检查

默认取值:

不涉及

task_id

String

参数解释:

根据插件检查任务ID筛选结果,插件检查任务ID可以通过批量创建插件检查任务中的status.items[].metadata.taskID字段获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

addon_instance_id

String

参数解释:

根据插件实例ID筛选结果,实例ID可以通过获取AddonInstance列表中的items[].metadata.uid字段获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

消息体的类型(格式)

约束限制:

GET方法不做校验

取值范围:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data(注:存在FormData参数时使用)

默认取值:

不涉及

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

kind

String

参数解释:

API类型

取值范围:

固定值"AddonCheck"

apiVersion

String

参数解释:

API版本

取值范围:

固定值"v3"

pageInfo

PageInfo object

参数解释:

插件任务列表的分页信息

约束限制:

不涉及

items

Array of AddonCheckTask objects

参数解释:

插件检查任务信息列表,包含了插件检查任务ID,插件模板名称,插件实例ID等。

约束限制:

不涉及

表5 PageInfo

参数

参数类型

描述

currentCount

Integer

参数解释:

当前所有的插件检查任务数

取值范围:

不涉及

表6 AddonCheckTask

参数

参数类型

描述

metadata

CheckTaskMetadata object

参数解释:

基本信息,为集合类的元素类型,包含一组由不同名称定义的属性

约束限制:

不涉及

spec

CheckTaskSpec object

参数解释:

插件检查目标信息,包含插件升级的目标版本

约束限制:

不涉及

status

CheckTaskStatus object

参数解释

插件检查任务状态信息

约束限制

不涉及

表7 CheckTaskMetadata

参数

参数类型

描述

type

String

参数解释:

插件检查类型

取值范围:

  • addonStatic: 运行中插件巡检

  • addonUpgrade: 插件升级前检查

taskID

String

参数解释:

插件检查任务ID,用于任务检查结果查询

取值范围:

不涉及

addonTemplateName

String

参数解释:

插件模板名称

取值范围:

cce服务提供的插件模板,可以通过查询AddonTemplates列表中的items[].metadata.name字段获取

addonInstanceName

String

参数解释:

插件实例名称

取值范围:

不涉及

addonInstanceID

String

参数解释:

插件实例ID

取值范围:

不涉及

createTimeStamp

String

参数解释:

插件检查任务创建时间

取值范围:

不涉及

expireTimeStamp

String

参数解释:

插件检查任务超时时间,仅终态(Failed/Success)任务存在此字段

取值范围:

不涉及

表8 CheckTaskSpec

参数

参数类型

描述

addonTargetVersion

String

参数解释:

插件升级目标版本

取值范围:

不涉及

表9 CheckTaskStatus

参数

参数类型

描述

status

String

参数解释:

插件检查状态

取值范围:

  • Init: 插件检查状态,初始化

  • Running: 插件检查状态,检查中

  • Failed: 插件检查状态,检查完成有风险

  • Success: 插件检查状态,检查完成无风险

message

String

参数解释:

插件检查结果信息

取值范围:

不涉及

riskList

Array of CheckTaskRisk objects

参数解释:

插件检查风险项列表,不同插件对应的风险检查项不同。

约束限制:

不涉及

表10 CheckTaskRisk

参数

参数类型

描述

riskName

String

参数解释:

风险项名称

取值范围:

不涉及

level

String

参数解释:

风险等级

取值范围:

  • Warning: 中危,允许跳过

  • Fatal: 高危,不允许跳过

status

String

参数解释:

风险项检查状态

取值范围:

  • Init: 风险项检查状态,初始化

  • Running: 风险项检查状态,检查中

  • Failed: 风险项检查状态,检查完成有风险

  • Success: 风险项检查状态,检查完成无风险

message

String

参数解释:

风险检查结果说明

取值范围:

不涉及

请求示例

响应示例

状态码:200

ok

{
  "kind" : "AddonCheck",
  "apiVersion" : "v3",
  "pageInfo" : {
    "currentCount" : 1
  },
  "items" : {
    "metadata" : {
      "type" : "addonUpgrade",
      "taskID" : "8ca259cc-553b-11e9-926f-0255ac101a31",
      "addonTemplateName" : "coredns",
      "addonInstanceName" : "cceaddon-coredns",
      "addonInstanceID" : "1d43577d-4b50-4723-b05b-2121f47cb219",
      "createTimestamp" : "2025-08-05T17:10:44.648388+08:00"
    },
    "spec" : {
      "addonTargetVersion" : "3.0.4"
    },
    "status" : {
      "status" : "Failed",
      "message" : "Addon task check finish"
    },
    "riskList" : [ {
      "riskName" : "AddonStatus",
      "status" : "Failed",
      "level" : "Warning",
      "message" : "addon status(abnormal) is not running"
    }, {
      "riskName" : "AddonValidate",
      "status" : "Failed",
      "level" : "Fatal",
      "message" : "configmap coredns had been modified, failed to ensure the consistency of corefile between current and recorded, the manually modified configuration by user may be lost if upgrade continue: 1. rollback current corefile; 2. set parameterSyncStrategy to force to force take over; 3. set parameterSyncStrategy to inherit to auto inherit your configuration; "
    } ]
  }
}

状态码

状态码

描述

200

ok

错误码

请参见错误码

相关文档