CreateAddon

为指定的集群安装组件。

使用说明

• 调用该接口前，请先调用 ListSupportedAddons 接口，获取您待安装组件的安装模式（DeployMode），对应的版本（Version）等参数值，以减少不必要的安装失败。
• 此接口为异步接口，当此接口返回成功时，组件将进入{Creating, [Progressing]}状态，直到安装成功，进入{Running, [Ok]}状态。请调用 ListAddons 接口获取该组件当前的状态，查看组件是否安装成功。

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见 公共参数。

组件配置信息

metrics-collector

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  AccessKeyId	String	否	AKLTMWZkZWM******	当DeployNodeType=VirtualNode时必须传入该参数，否则，可不填。 表示使用火山引擎 AK/SK 的方式，授权 VCI 部署该组件。AccessKey ID（AK）的获取方式，请参见 获取访问密钥。
  AccessKeySecret	String	否	Wm1Rd09U******	当DeployNodeType=VirtualNode时必须传入该参数，否则，可不填。 表示使用火山引擎 AK/SK 的方式，授权 VCI 部署该组件。Secret Access Key（SK）的获取方式，请参见 获取访问密钥。

• Config 示例

  {
    "AccessKeyId": "AKLTMWZkZWM******",
    "AccessKeySecret": "Wm1Rd09U******"
  }
  

cr-credential-controller

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  CrConfigmapData	Object	是	-	镜像仓库免密组件配置信息。
  CrConfigmapData.Namespace	String	是	*	当前集群下可以免密拉取私有镜像的命名空间。默认值为*，表示所有命名空间都可以免密拉取私有镜像；您也可以输入具体的命名空间名称，指定多个命名空间，多个名称之间以英文逗号（,）分隔。
  CrConfigmapData.ServiceAccount	String	是	*	能够使用免密组件的 Kubernetes 中的服务账号。默认值为*，表示已配置命名空间下的所有 ServiceAccount，都可以免密拉取私有镜像；您也可以输入具体的 ServiceAccount，可以指定多个 ServiceAccount，多个名称之间以英文逗号（,）分隔。
  CrConfigmapData.Registries	Array	是	-	镜像仓库实例配置信息。
  CrConfigmapData.Registries.0.Instance	String	是	cr-basic	可以免密拉取私有镜像的目标镜像仓库实例名称。 可以调用 ListRegistries 接口，获取镜像仓库名称。 说明 可选同一个地域中的一个或多个镜像仓库实例。 该镜像仓库实例中，后续新推送的私有镜像也能被免密拉取。
  CrConfigmapData.Registries.0.Region	String	是	cn-beijing	目标镜像仓库实例所在的地域。

• Config 示例

  {
    "CrConfigmapData": {
      "Namespace": "*",
      "ServiceAccount": "*",
      "Registries": [
        {
          "Instance": "cr-basic",
          "Region": "cn-beijing"
        }
      ]
    }
  }
  

prometheus-agent

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  NodeExporterDisabled	String	是	true	是否禁用 node-exporter 插件。取值： false：（默认值）不禁用，即安装插件。node-exporter 插件用于通过 Linux 操作系统感知虚拟机各项指标。 true：禁用插件，即不安装插件。
  AutoScalingEnabled	Boolean	否	false	是否开启 vm-agent 采集器和 kube-state-metrics 组件的自动扩缩容功能。取值： false：（默认值）不开启自动扩容，即组件的分片数为配置的初始分片数，不会随着资源占用率的提升而自动扩容。 true：开启自动扩容。
  VmAgent.InitShards	Integer	否	1	vm-agent 初始（最小）分片数。 默认值：1 取值范围：[1, 20] 注意 安装完成 prometheus-agent 组件后不支持更新该参数配置。 不同规模集群中的推荐初始（最小）分片数不同，详情请参见 推荐规格。
  VmAgent.MaxShards	Integer	否	5	vm-agent 扩容最大分片数。 默认值：5 取值范围：[VmAgent.InitShards的值, 20] 仅AutoScalingEnabled=true时生效。
  VmAgent.Requests.Cpu	String	否	2	vm-agent 资源 CPU 请求。 单位为核。若使用毫核为单位，则格式为：CPU 请求+m，例如100m表示 CPU 资源请求为 100 毫核。 默认值：2
  VmAgent.Requests.Memory	String	否	2Gi	vm-agent 资源内存请求。 单位为 MiB 或 GiB，格式为：内存请求+单位，例如90Mi表示内存资源请求为 90 MiB；2Gi表示内存资源请求为 2 GiB。 默认值：2Gi
  VmAgent.Limits.Cpu	String	否	4	vm-agent 资源 CPU 上限。 单位为核。若使用毫核为单位，则格式为：CPU 请求+m，例如100m表示 CPU 资源上限为 100 毫核。 默认值：4
  VmAgent.Limits.Memory	String	否	4Gi	vm-agent 资源内存上限。 单位为 MiB 或 GiB，格式为：内存请求+单位，例如90Mi表示内存资源请求为 90 MiB；2Gi表示内存资源上限为 2 GiB。 默认值：4Gi
  KubeStateMetrics.InitShards	Integer	否	1	kube-state-metrics 初始分片数及缩容最小分片数。 默认值：1 取值范围：[1, 20] 注意 安装完成 prometheus-agent 组件后不支持更新该参数配置。 不同规模集群中的推荐初始（最小）分片数不同，详情请参见 推荐规格。
  KubeStateMetrics.MaxShards	Integer	否	5	kube-state-metrics 扩容最大分片数。 默认值：5 取值范围：[KubeStateMetrics.InitShards的值, 20] 仅AutoScalingEnabled=true时生效。
  KubeStateMetrics.Requests.Cpu	String	否	200m	kube-state-metrics 资源 CPU 请求。 单位为核。若使用毫核为单位，则格式为：CPU 请求+m，例如100m表示 CPU 资源请求为 100 毫核。 默认值：200m
  KubeStateMetrics.Requests.Memory	String	否	512Mi	kube-state-metrics 资源内存请求。 单位为 MiB 或 GiB，格式为：内存请求+单位，例如90Mi表示内存资源请求为 90 MiB；2Gi表示内存资源请求为 2 GiB。 默认值：512Mi
  KubeStateMetrics.Limits.Cpu	String	否	800m	kube-state-metrics 资源 CPU 上限。 单位为核。若使用毫核为单位，则格式为：CPU 请求+m，例如100m表示 CPU 资源上限为 100 毫核。 默认值：800m
  KubeStateMetrics.Limits.Memory	String	否	2Gi	kube-state-metrics 资源内存上限。 单位为 MiB 或 GiB，格式为：内存请求+单位，例如90Mi表示内存资源请求为 90 MiB；2Gi表示内存资源上限为 2 GiB。 默认值：2Gi

• Config 示例

  {
    "AuthType": "BasicAuth",
    "BasicAuthUsername": "admin",
    "BasicAuthPassword": "password****",
    "EnableNodeExporter": "true",
    "RemoteWriteURL": "http://xxx:yyy/workspaces/zzzz/api/v1/write"
  }
  

apmplus-opentelemetry-collector

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  promReplicas	Integer	是	1	PrometheusScraper 实例个数。单实例支持 10 万条数据/分钟，所需资源为 1 核 CPU 2GB 内存。一般情况下实例数为 1 可满足需求。如果集群每分钟产生 30 万条数据，请将实例数设置为 3。 说明 PrometheusScraper 默认以 Deployment 方式部署。
  otelReplicas	Integer	是	1	OpenTelemetryCollector 实例个数。单实例支持 1 万条 trace/秒，所需资源为 1 核 CPU 2GB 内存。一般情况下实例数为 1 可满足需求。如果集群每秒产生 3 万条 trace，请将实例数设置为 3。 说明 OpenTelemetryCollector 默认以 Statefulset 方式部署。

• Config 示例

  {
    "promReplicas": 1,
    "otelReplicas": 1
  }
  

cluster-autoscaler

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  Expander	String	是	random	节点自动扩容时所采用的扩容策略类型。取值： random：（默认值）随机选择一个节点池进行扩容。 most-pods：选择能够调度最多 Pods 的节点池进行扩容。 least-waste：选择 CPU 资源最少的空闲节点池进行扩容。 priority：选择所设优先级最高的节点池进行扩容。
  ScaleDownEnabled	Boolean	是	false	是否自动缩容，取值： true：开启自动缩容。开启后，集群中有较多空闲节点资源时会触发缩容。仅对 按量计费 节点资源生效。 false：（默认值）不开启自动缩容。
  ScaleDownUtilizationThreshold	Float	否	0.5	非 GPU 节点缩容阈值，取值范围：[0,1]。 当ScaleDownEnabled=true时必须传入。
  ScaleDownGpuUtilizationThreshold	Float	否	0.5	GPU 节点缩容阈值，取值范围：[0,1]。 当ScaleDownEnabled=true时必须传入。
  ScaleDownUnneededTime	Integer	否	1	缩容触发时延，取值范围：[1,60]，单位：分钟。 当ScaleDownEnabled=true时必须传入。
  ScaleDownDelayAfterAdd	Integer	否	1	扩容后缩容冷却时间，取值范围：[1,60]，单位：分钟。 当ScaleDownEnabled=true时必须传入。
  ScaleDownDelayAfterFailure	Integer	否	1	缩容失败冷却时间，取值范围：[1,60]，单位：分钟。 当ScaleDownEnabled=true时必须传入。
  MaxEmptyBulkDelete	Integer	否	5	最大并发缩容数，取值范围：[1,15]，单位：分钟。 当ScaleDownEnabled=true时必须传入。
  SkipNodesWithLocalStorage	Boolean	否	true	触发缩容时是否跳过包含本地存储 Pod 的节点。取值： true：（默认值）跳过。 false：不跳过。 当ScaleDownEnabled=true时必须传入。
  SkipNodesWithSystemPods	Boolean	否	true	触发缩容时是否跳过包含 kube-system 命名空间下非 DaemonSet 管理的 Pod 节点。取值： true：（默认值）跳过。 false：不跳过。 当ScaleDownEnabled=true时必须传入。

• Config 示例

  {
    "Expander": "random",
    "ScaleDownEnabled": true,
    "ScaleDownUtilizationThreshold": 0.5,
    "ScaleDownUnneededTime": 1,
    "ScaleDownDelayAfterAdd": 1,
    "ScaleDownDelayAfterFailure": 1,
    "MaxEmptyBulkDelete": 5,
    "SkipNodesWithLocalStorage": true,
    "SkipNodesWithSystemPods": true
  }
  

event-collector

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  AccessKeyId	String	否	AKLTMWZkZWM******	当DeployNodeType=VirtualNode时必须传入该参数，否则，可不填。 表示使用火山引擎 AK/SK 的方式，授权 VCI 部署该组件。AccessKey ID（AK）的获取方式，请参见 获取访问密钥。
  AccessKeySecret	String	否	Wm1Rd09U******	当DeployNodeType=VirtualNode时必须传入该参数，否则，可不填。 表示使用火山引擎 AK/SK 的方式，授权 VCI 部署该组件。Secret Access Key（SK）的获取方式，请参见 获取访问密钥。
  ProjectId	String	是	4611ffdsa8-9716--**	关联该用户账号在集群所处地域下，已存在的日志项目 ID。 可以调用 DescribeProjects 获取日志项目 ID。若无可用的日志项目，请调用 CreateProject 创建后再使用。
  TopicId	String	是	f8fsdb36-9fae-461e--**	日志项目下，已存在的日志主题 ID。 可以调用 DescribeTopics 获取日志主题 ID。若无可用的日志主题，请调用 CreateTopic 创建后再使用。

• Config 示例

  {
    "ProjectId": "4611ffdsa8-9716-****-******",
    "TopicId": "f8fsdb36-9fae-461e-****-******",
    "AccessKeyId": "AKLTMWZkZWM******",
    "AccessKeySecret": "Wm1Rd09U******"
  }
  

scheduler-plugin

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  NodePolicy	String	是	spread	节点调度策略，取值： binpack：多个 Pod 优先调度在同一节点。综合评估 CPU、内存、GPU 算力和显存等资源得分。 spread：（默认值）多个 Pod 分散调度在不同节点。综合评估 CPU、内存、GPU 算力和显存等资源得分。
  ResourceWeights	Array of ResourceWeight	否	[]	binpack/spread 的资源权重。子参数说明，请参见下方表格 ResourceWeight。
  GPUShareCardPolicy	String	是	binpack	GPU 显卡的调度策略： binpack：（默认值）多个 Pod 优先使用同一张 GPU 显卡。 spread：多个 Pod 分散使用不同的 GPU 显卡。 若您的工作负载中存在 GPU 计算型节点和 GPU 显卡的情况下，NodePolicy 和 GPUShareCardPolicy 的组合方式说明，请参见 配置调度器自定义参数。
  PodTopologySpreadWeight	Integer	否	2	原生 PodTopologySpread 调度策略的打分权重，分值越高拓扑打散调度的优先级越高，Pod 越大几率被调度到分散的拓扑区域。 取值范围：[1,100] 默认值：2
  PluginsCapacityScheduling	Boolean	否	false	【邀测·申请试用】是否开启 Capacity 调度。Capacity 调度通过弹性配额实现多租户间的资源共享，提升整体资源的利用率。 false：（默认值）不开启。 true：开启。 说明 Capacity 调度相关说明，请参见 Capacity 调度。
  GangSchedulingEnabled	Boolean	否	false	【邀测·申请试用】是否开启 Gang 调度。Gang 调度满足 All-or-Nothing 调度场景，即一组需要同时调度的 Pod 要么全部调度成功，要么一个都不成功。 false：（默认值）不开启。 true：开启。 说明 Gang 调度相关说明，请参见 Gang 调度。
  ResourcePolicySchedulingEnabled	Boolean	否	false	【邀测·申请试用】是否开启弹性资源优先级调度。弹性资源优先级调度通过自定义资源策略（ResourcePolicy），设置工作负载的 Pod 被弹性调度到不同类型节点（例如包年包月 ECS、按量付费 ECS、虚拟节点）的顺序。 false：（默认值）不开启。 true：开启。 注意 若开启弹性资源优先级调度，需要配置 ResourcePolicyWeight。 弹性资源优先级调度的使用方法，请参见 弹性资源优先级调度。
  ResourcePolicyWeight	Integer	否	100	仅 ResourcePolicyScheduling 开启时有效。设定弹性资源优先级调度的打分权重，权重越大得分越高。 取值范围：[1,100]。 默认值：100。
  LoadAwareSchedulingEnabled	Boolean	否	false	【邀测·申请试用】是否开启负载感知调度。负载感知调度根据节点实际资源负载进行调度，避免出现因单个节点负载过高而导致的应用程序或节点故障。 false：（默认值）不开启。 true：开启。 说明 负载感知调度的使用方法，请参见 负载感知调度。
  NumaAwareSchedulingEnabled	Boolean	否	false	【邀测·申请试用】是否开启拓扑感知调度。拓扑感知调度提供中心调度器与单机协作的拓扑感知调度能力，为负载提供更好的性能。 false：（默认值）不开启。 true：开启。 说明 拓扑感知调度的使用方法，请参见 拓扑感知调度。

  ResourceWeight

  说明

  Name 和 Weight 的更多配置说明，请参见 配置调度器自定义参数。

  配置名称	参数类型	是否必传	示例	描述
  Name	String	是	CPU	枚举值： CPU Memory nvidia.com/gpu vke.volcengine.com/mgpu-core
  Weight	Integer	是	100	取值范围为[1,10]，默认值为： CPU：1 Memory：1 nvidia.com/gpu：NULL vke.volcengine.com/mgpu-core：1

• Config 示例

  {
   "NodePolicy": "spread",
   "GPUShareCardPolicy": "binpack",
   "PluginsCapacityScheduling": false
  }
  

ingress-nginx

• 配置内容
  负载均衡产品限制和相关参数的详细说明，请参见 负载均衡文档。

  配置名称	参数类型	是否必传	示例	描述
  Replica	Integer	是	1	负载均衡实例个数。
  Resource	Object	是	-	Nginx 资源配置。
  Resource.Request	Object	是	-	请求资源配置。
  Resource.Request.Cpu	String	是	0.25	CPU 资源请求，单位为 Core。
  Resource.Request.Memory	String	是	512Mi	内存资源请求，单位为 MiB 或 GiB，格式为：内存请求+单位，例如512Mi表示内存资源请求为 512 MiB；2Gi表示内存资源请求为 2 GiB。
  Resource.Limit	Object	是	-	资源上限配置。
  Resource.Limit.Cpu	String	是	0.5	CPU 资源上限，单位为 Core。
  Resource.Limit.Memory	String	是	1024Mi	内存资源上限，单位为 MiB 或 GiB，格式为：内存上限+单位，例如1024Mi表示内存资源上限为 1024 MiB；2Gi表示内存资源上限为 2 GiB。
  PublicNetwork	Object	否	-	负载均衡公网配置。
  PublicNetwork.LanType	String	是	BGP	为负载均衡提供公网服务的线路类型，不同类型的线路在性能和计费标准上存在差异。当前仅支持 BGP（多线）。
  PublicNetwork.BandWidthLimit	Integer	是	10	公网类型负载均衡的带宽上限，单位为 Mbps，取值范围： 如果BillingType=2，则取值上限为 500。 如果BillingType=3，则取值上限为 200。
  PublicNetwork.IpVersion	String	是	IPV4	公网类型负载均衡 IP 地址版本类型。当前仅支持 IPV4。
  PublicNetwork.BillingType	Integer	是	3	公网类型负载均衡的计费方式，取值： 2：按量计费-按带宽上限，指定带宽上限后，将按照使用时长计费，与实际流量无关。 3：（默认值）按量计费-按实际流量，指定带宽上限后，将按照实际使用的出公网流量计费，与使用时长无关。
  PublicNetwork.SubnetId	String	是	subnet-3rei*******	公网类型负载均衡的子网 ID。
  PrivateNetwork	Object	否	-	私网负载均衡配置。
  PrivateNetwork.IpVersion	String	是	IPV4	私网类型负载均衡 IP 地址版本类型。当前仅支持 IPV4。
  PrivateNetwork.SubnetId	String	是	subnet-3rei*******	私网类型负载均衡的子网 ID。

• Config 示例

  {
    "Replica": 1,
    "Resource": {
      "Request": {
        "Cpu": "0.25",
        "Memory": "512Mi"
      },
      "Limit": {
        "Cpu": "0.5",
        "Memory": "1024Mi"
      }
    },
    "PublicNetwork": {
      "LanType": "BGP",
      "BandWidthLimit": 10,
      "IpVersion": "IPV4",
      "BillingType": 2,
      "SubnetId": "subnet-3rei*******"
    },
    "PrivateNetwork": {
      "SubnetId": "",
      "IpVersion": ""
    }
  }
  

p2p-accelerator

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  Region	String	是	cn-beijing	已开启 P2P 加速的镜像仓库实例所在地域。
  Registry	String	是	helm-cr	已开启 P2P 加速的镜像仓库实例。
  NydusEnabled	Boolean	是	true	【邀测·申请试用】是否同步开启镜像懒加载功能。开启后，需要安装 image-accelerator 容器镜像加速组件一同使用。镜像懒加载功能相关信息，请参见 容器镜像懒加载方案。
  AccessKeyId	String	否	AKLTMWZkZWM******	当DeployNodeType=VirtualNode时必须传入该参数。 表示使用火山引擎 AK/SK 的方式，授权 VCI 部署该组件。此处传入AccessKey ID（AK）。 AccessKey ID 获取方式，请参见 访问密钥使用指南。
  AccessKeySecret	String	否	Wm1Rd09U******	当DeployNodeType=VirtualNode时必须传入该参数。 表示使用火山引擎 AK/SK 的方式，授权 VCI 部署该组件。此处传入 Secret Access Key（SK）。 Secret Access Key 获取方式，请参见 访问密钥使用指南。
  DaemonProxyReplicas	Integer	否	3	自定义设置 Dfdaemon（P2P 网络传输节点）Proxy 容器数量，默认值：3。

• Config 示例

  {
    "Region": "cn-beijing",
    "Registry": "helm-cr",
    "NydusEnabled": true
  }
  

mgpu

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  ExporterDisabled	Boolean	否	true	是否禁用容器共享 GPU 的资源监控插件 mgpu-exporter： false：（默认值）不禁用，即安装插件，使用 Prometheus 监控功能监控 mGPU 相关的指标。 true：禁用，即不安装插件。您可以安装自己的监控 Exporter，监控 mGPU 相关的指标。

• Config 示例

  {
    "ExporterDisabled": true
  }
  

nvidia-device-plugin

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  ExporterDisabled	Boolean	是	true	是否禁用 Nvidia GPU 资源监控插件 dcgm-exporter： false：（默认值）不禁用，即安装插件，使用 Prometheus 监控功能监控 Nvidia GPU 相关的指标。 true：禁用插件。您可以安装自己的监控 Exporter，监控 Nvidia GPU 相关的指标

• Config 示例

  {
    "ExporterDisabled": true
  }
  

prometheus-adapter

• 配置内容

  配置名称	参数类型	是否必传	示例	描述
  AuthType	String	是	EcsRole	VMP 工作区的认证鉴权方式，取值： EcsRole：通过云服务器（ECS）绑定的 IAM 角色进行鉴权。

• Config 示例

  {
    "AuthType": "EcsRole"
  }
  

请求示例

POST /?Action=CreateAddon&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
 {
    "ClusterId": "cc5silumrsf******",
    "Name": "ingress-nginx",
    "DeployMode": "Unmanaged",
    "DeployNodeType": ["VirtualNode"],
    "Config": "{\"Replica\":1,\"Resource\":{\"Request\":{\"Cpu\":\"0.25\",\"Memory\":\"512Mi\"},\"Limit\":{\"Cpu\":\"0.5\",\"Memory\":\"1024Mi\"}},\"PrivateNetwork\":{\"SubnetId\":\"subnet-2d61qn69iji****\",\"IpVersion\":\"IPV4\"}}",
    "ClientToken": "BC028527-33B9-4990-A633-84E9F9******"
}

返回参数

本接口无专有返回参数，公共返回参数请参见 返回结果。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
        "ResponseMetadata": {
                "RequestId": "021635330810134****",
                "Action": "CreateAddon",
                "Version": "2022-05-12",
                "Service": "vke",
                "Region": "cn-beijing"
        },
        "Result": {}
}

错误码

本接口错误码如下表所示，公共错误码请参见 公共错误码。