文档首页/ 云容器引擎 CCE/ API参考/ API/ 插件管理/ 批量创建插件检查任务 - BatchCreateAddonPrecheck
更新时间：2025-11-01 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量创建插件检查任务 - BatchCreateAddonPrecheck

功能介绍

该API用于在指定集群下批量创建插件检查任务。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

账号的项目ID

默认取值：

不涉及

cluster_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

集群ID

默认取值：

不涉及

请求参数

表2 请求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。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

kind

是

String

参数解释：

API类型

约束限制：

该值不可修改

取值范围：

固定值"AddonCheck"

默认取值：

AddonCheck

apiVersion

是

String

参数解释：

API版本

约束限制：

该值不可修改

取值范围：

固定值"v3"

默认取值：

v3

spec

是

AddonCheckSpec object

参数解释：

spec是集合类的元素类型，内容为插件检查具体信息，检查配置的详细描述主体部分都在spec中给出

约束限制：

不涉及
表4 AddonCheckSpec

参数

是否必选

参数类型

描述

clusterID

是

String

参数解释：

集群ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

addonList

是

Array of AddonInfo objects

参数解释：

插件检查信息列表，包含了需要检查的插件模板名称，插件实例ID，插件升级配置等。

约束限制：

不涉及
表5 AddonInfo

参数

是否必选

参数类型

描述

addonTemplateName

是

String

参数解释：

插件模板名称

约束限制：

不涉及

取值范围：

cce服务支持的插件模板

默认取值：

不涉及

addonInstanceID

是

String

参数解释：

插件实例ID，可以通过获取AddonInstance列表中的items[].metadata.uid字段获取

约束限制：

此参数必填

取值范围：

不涉及

默认取值：

不涉及

targetVersion

否

String

参数解释：

插件升级的目标版本

约束限制：

插件升级场景下，此参数必填。

取值范围：

cce服务提供的插件版本，可以通过查询AddonTemplates列表中的items[].spec.versions.version字段获取

默认取值：

不涉及

type

是

String

参数解释：

插件检查类型

约束限制：

此参数必填。

取值范围：

  • addonStatic: 运行中插件巡检

  • addonUpgrade: 插件升级前检查

默认取值：

不涉及

values

否

Map<String,Object>

参数解释：

插件模板编辑/升级参数（各插件不同），请根据具体插件模板信息填写参数

约束限制：

不涉及

响应参数

状态码：201

表6 响应Body参数

参数

参数类型

描述

kind

String

参数解释：

API类型

约束限制：

该值不可修改

取值范围：

固定值"AddonCheck"

默认取值：

AddonCheck

apiVersion

String

参数解释：

API版本

约束限制：

该值不可修改

取值范围：

固定值"v3"

默认取值：

v3

spec

AddonCheckSpec object

参数解释：

spec是集合类的元素类型，内容为插件检查具体信息，检查配置的详细描述主体部分都在spec中给出

约束限制：

不涉及

status

AddonCheckStatus object

参数解释：

status是集合类的元素类型，内容为插件检查任务的创建结果，包含task_id用于插件检查结果查询

约束限制：

不涉及
表7 AddonCheckSpec

参数

参数类型

描述

clusterID

String

参数解释：

集群ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

addonList

Array of AddonInfo objects

参数解释：

插件检查信息列表，包含了需要检查的插件模板名称，插件实例ID，插件升级配置等。

约束限制：

不涉及
表8 AddonInfo

参数

参数类型

描述

addonTemplateName

String

参数解释：

插件模板名称

约束限制：

不涉及

取值范围：

cce服务支持的插件模板

默认取值：

不涉及

addonInstanceID

String

参数解释：

插件实例ID，可以通过获取AddonInstance列表中的items[].metadata.uid字段获取

约束限制：

此参数必填

取值范围：

不涉及

默认取值：

不涉及

targetVersion

String

参数解释：

插件升级的目标版本

约束限制：

插件升级场景下，此参数必填。

取值范围：

cce服务提供的插件版本，可以通过查询AddonTemplates列表中的items[].spec.versions.version字段获取

默认取值：

不涉及

type

String

参数解释：

插件检查类型

约束限制：

此参数必填。

取值范围：

  • addonStatic: 运行中插件巡检

  • addonUpgrade: 插件升级前检查

默认取值：

不涉及

values

Map<String,Object>

参数解释：

插件模板编辑/升级参数（各插件不同），请根据具体插件模板信息填写参数

约束限制：

不涉及
表9 AddonCheckStatus

参数

参数类型

描述

items

Array of AddonCheckTask objects

参数解释：

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

约束限制：

不涉及
表10 AddonCheckTask

参数

参数类型

描述

metadata

CheckTaskMetadata object

参数解释：

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

约束限制：

不涉及

spec

CheckTaskSpec object

参数解释：

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

约束限制：

不涉及

status

CheckTaskStatus object

参数解释：

插件检查任务状态信息

约束限制：

不涉及
表11 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）任务存在此字段

取值范围：

不涉及
表12 CheckTaskSpec

参数

参数类型

描述

addonTargetVersion

String

参数解释：

插件升级目标版本

取值范围：

不涉及
表13 CheckTaskStatus

参数

参数类型

描述

status

String

参数解释：

插件检查状态

取值范围：

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

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

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

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

message

String

参数解释：

插件检查结果信息

取值范围：

不涉及

riskList

Array of CheckTaskRisk objects

参数解释：

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

约束限制：

不涉及
表14 CheckTaskRisk

参数

参数类型

描述

riskName

String

参数解释：

风险项名称

取值范围：

不涉及

level

String

参数解释：

风险等级

取值范围：

  • Warning: 中危，允许跳过

  • Fatal: 高危，不允许跳过

status

String

参数解释：

风险项检查状态

取值范围：

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

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

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

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

message

String

参数解释：

风险检查结果说明

取值范围：

不涉及

请求示例

  • 创建一个coredns插件的检查任务，检查类型为插件升级。

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

{
  "kind" : "AddonCheck",
  "apiVersion" : "v3",
  "spec" : {
    "clusterID" : "6b400e1c-4368-11f0-ba56-0255ac100037",
    "addonList" : [ {
      "addonTemplateName" : "coredns",
      "addonInstanceID" : "8fcaa506-809d-4f33-91b3-b27efcbeb540",
      "type" : "addonUpgrade",
      "values" : {
        "basic" : {
          "cluster_ip" : "10.247.3.10",
          "image_version" : "1.17.15",
          "platform" : "linux-amd64",
          "rbac_enabled" : true,
          "swr_addr" : "",
          "swr_user" : "hwofficial"
        },
        "custom" : {
          "cluster_id" : "8fcaa506-809d-4f33-91b3-b27efcbeb540",
          "stub_domains" : { },
          "tenant_id" : "0504201b6c80256b2f08c0099f0c8fe4",
          "upstream_nameservers" : [ ]
        },
        "flavor" : {
          "name" : 2500,
          "replicas" : 2,
          "resources" : [ {
            "limitsCpu" : "500m",
            "limitsMem" : "512Mi",
            "name" : "coredns",
            "requestsCpu" : "500m",
            "requestsMem" : "512Mi"
          } ]
        }
      }
    } ]
  }
}

  • 创建一个coredns插件的检查任务，检查类型为插件巡检。

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

{
  "kind" : "AddonCheck",
  "apiVersion" : "v3",
  "spec" : {
    "clusterID" : "6b400e1c-4368-11f0-ba56-0255ac100037",
    "addonList" : [ {
      "addonTemplateName" : "coredns",
      "addonInstanceID" : "8fcaa506-809d-4f33-91b3-b27efcbeb540",
      "type" : "addonStatic"
    } ]
  }
}

响应示例

状态码：201

表示在指定集群下批量创建插件检查任务下发成功。

{
  "kind" : "AddonCheck",
  "apiVersion" : "v3",
  "spec" : {
    "clusterID" : "6b400e1c-4368-11f0-ba56-0255ac100037",
    "addonList" : [ {
      "addonTemplateName" : "coredns",
      "addonInstanceID" : "8fcaa506-809d-4f33-91b3-b27efcbeb540",
      "type" : "addonUpgrade",
      "values" : {
        "basic" : {
          "cluster_ip" : "10.247.3.10",
          "image_version" : "1.17.15",
          "platform" : "linux-amd64",
          "rbac_enabled" : true,
          "swr_addr" : "",
          "swr_user" : "hwofficial"
        },
        "custom" : {
          "cluster_id" : "8fcaa506-809d-4f33-91b3-b27efcbeb540",
          "stub_domains" : { },
          "tenant_id" : "0504201b6c80256b2f08c0099f0c8fe4",
          "upstream_nameservers" : [ ]
        },
        "flavor" : {
          "name" : 2500,
          "replicas" : 2,
          "resources" : [ {
            "limitsCpu" : "500m",
            "limitsMem" : "512Mi",
            "name" : "coredns",
            "requestsCpu" : "500m",
            "requestsMem" : "512Mi"
          } ]
        }
      }
    } ]
  },
  "status" : {
    "items" : [ {
      "metadata" : {
        "type" : "addonUpgrade",
        "taskID" : "22386048-d955-4409-bc71-20cc2b774245",
        "addonTemplateName" : "coredns",
        "addonInstanceName" : "cceaddon-coredns",
        "addonInstanceID" : "8fcaa506-809d-4f33-91b3-b27efcbeb540",
        "createTimeStamp" : "2025-08-13T11:24:37.312017086+08:00"
      },
      "spec" : {
        "addonTargetVersion" : "1.27.1"
      },
      "status" : {
        "status" : "Init",
        "riskList" : [ {
          "riskName" : "K8sResourceModified",
          "status" : "Init",
          "level" : "Warning"
        }, {
          "riskName" : "AddonValidate",
          "status" : "Init",
          "level" : "Warning"
        }, {
          "riskName" : "AddonStatus",
          "status" : "Init",
          "level" : "Warning"
        } ]
      }
    } ]
  }
}

状态码

状态码

描述

201

表示在指定集群下批量创建插件检查任务下发成功。

错误码

请参见错误码。

父主题： 插件管理

相关文档