为指定的集群安装组件。

使用说明

调用该接口前，请先调用 ListSupportedAddons 接口，获取您待安装组件的安装模式（DeployMode），对应的版本（Version）等参数值，以减少不必要的安装失败。

此接口为异步接口，当此接口返回成功时，组件将进入{Creating, [Progressing]}状态，直到安装成功，进入{Running, [Ok]}状态。请调用 ListAddons 接口获取该组件当前的状态，查看组件是否安装成功。

请求说明

VKE 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://vke.cn-beijing.volcengineapi.com?Action=CreateAddon&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	CreateAddon	接口名称。当前 API 的名称为 CreateAddon。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 2022-05-12。
ClusterId	String	是	cc5sil*******	待安装组件的集群 ID。可以调用 ListClusters 接口，获取集群 ID。注意待安装组件的集群必须处于{Running,[*]}状态。可调用 ListClusters 接口获取集群当前的状态。
Name	String	是	ingress-nginx	待安装组件的名称。容器服务当前支持的组件名称，请调用 ListSupportedAddons获取。
Version	String	否	v0.44.0	待安装组件的版本。可以调用 ListSupportedAddons接口，获取待安装组件的版本。
DeployMode	String	否	Unmanaged	部署模式，取值： Unmanaged：非托管模式部署。 Managed：托管模式部署。可以调用 ListSupportedAddons 接口，获取待安装组件的托管模式。说明若不传入参数值，当组件支持托管时，此处系统默认为 Managed；当组件不支持托管时，此处系统默认为 Unmanaged。
DeployNodeType	String	否	VirtualNode	部署节点类型。仅DeployMode=Unmanaged时，才需要指定该参数。取值： Node：以节点（云服务器）方式部署。 VirtualNode：以虚拟节点（弹性容器实例）方式部署。说明若目标当前集群已安装了 vci-virtual-kubelet 组件，则此处默认值为 VirtualNode，否则默认值为 Node。请调用 ListAddons 接口，获取当前集群已安装的组件。
Config	String	否	-	组件配置。详细配置说明，请参见下方组件配置信息。注意仅组件配置信息中列出的组件需要配置该参数。其余组件无需配置。
ClientToken	String	否	BC028527-33B9-4990-A633-84E9F9******	用于保证请求幂等性的字符串。该字符串由调用方传入，需保证不同请求之间唯一。ClientToken 对大小写敏感，且最大值不超过 64 个 ASCII 字符。

组件配置信息

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"
}
]
}
}

cr-signature-verifier

配置内容

配置名称	参数类型	是否必传	示例	描述
Replicas	Integer	否	2	组件副本数：默认值：2 取值范围：正整数。
WhitelistImages	Array	否	[]	用户追加的豁免镜像列表，匹配该镜像地址模式的镜像将跳过签名验证。支持通配符（匹配单层路径，匹配任意深度路径），例如docker.io/library/*。该列表不会覆盖 Chart 预置镜像。
WhitelistNamespaces	Array	否	[]	用户追加的豁免命名空间，处于豁免命名空间下的 Pod 将跳过镜像签名验证。该列表不会覆盖 Chart 预置命名空间。
Rules	Array	是	-	镜像签名验证策略列表，最多 20 条。每条策略按声明顺序顺序匹配生效。
Rules[].Name	String	是	production-images	镜像签名验证策略名称。自定义任意字符串。
Rules[].Mode	String	是	Enforce	镜像签名验证失败时的处理方式，支持以下两种模式： Enforce：拦截部署，Pod 创建请求被拒绝。适用于生产环境等对安全要求严格的场景。 Audit：仅记录告警，不阻断 Pod 部署。适用于灰度观察或测试环境，便于在不影响业务的情况下排查问题。
Rules[].Namespaces	Array	是	["production"]	镜像签名验证策略生效的命名空间。空数组表示命中全部命名空间。
Rules[].ImagePatterns	Array	是	["cr-cn-beijing.volces.com/prod/**"]	需要验证签名的 CR 镜像地址模式，支持通配符（匹配单层路径，*匹配任意深度路径）。注意不要填写公网公共镜像源。
Rules[].Authorities	Array	是	-	信任的 KMS 签名密钥列表，最少填写 1 个密钥，最多 5 个。
Rules[].Authorities[].ProjectName	String	是	cr-prod	KMS 密钥环所属项目名称。可调用 QueryKeyring 查询密钥环所属项目。
Rules[].Authorities[].KeyringName	String	是	cr-signing-keyring	KMS 密钥环（Keyring）名称。可调用 QueryKeyring 查询密钥环名称。
Rules[].Authorities[].KeyId	String	是	75c80f24-d2ba-****	KMS 密钥 ID。可调用 GetPublicKey 查询密钥 ID。

Config 示例

{
"Replicas": 2,
"WhitelistImages": [],
"WhitelistNamespaces": [],
"Rules": [
{
"Name": "production-images",
"Mode": "Enforce",
"Namespaces": ["production"],
"ImagePatterns": [
"cr-cn-beijing.volces.com/prod/**"
],
"Authorities": [
{
"ProjectName": "cr-prod",
"KeyringName": "cr-signing-keyring",
"KeyId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
}
]
}
]
}

prometheus-agent

配置内容

配置名称	参数类型	是否必传	示例	描述
NodeExporterDisabled	Boolean	否	false	是否禁用 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 示例

{
"NodeExporterDisabled": false,
"VmAgent": {
"InitShards": 2,
"Requests": {
"Cpu": "500m",
"Memory": "512Mi"
}
}
}

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

配置内容

配置名称	参数类型	是否必传	示例	描述
ScanInterval	String	否	10s	弹性伸缩的间隔时间：取值为：10s、15s、30s、60s、120s、180s、300s，单位为：秒。
MaxNodeProvisionTime	String	否	15	等待节点就绪最大超时时间，取值范围：[1,60]。默认为 15。单位：分钟。
ScaleDown.Enabled	Boolean	是	false	是否自动缩容，取值： true：开启自动缩容。开启后，集群中有较多空闲节点资源时会触发缩容。仅对按量计费节点资源生效。 false：（默认值）不开启自动缩容。
ScaleDown.UtilizationThreshold	Float	否	0.5	非 GPU 节点缩容阈值，取值范围：[0,1]。当ScaleDown.Enabled=true时必须传入。
ScaleDown.GpuUtilizationThreshold	Float	否	0.5	GPU 节点缩容阈值，取值范围：[0,1]。当ScaleDown.Enabled=true时必须传入。
ScaleDown.UnneededTime	Integer	否	1	缩容触发时延，取值范围：[1,60]，单位：分钟。当ScaleDown.Enabled=true时必须传入。
ScaleDown.DelayAfterAdded	Integer	否	1	扩容后缩容冷却时间，取值范围：[1,60]，单位：分钟。当ScaleDown.Enabled=true时必须传入。
ScaleDown.DelayAfterFailure	Integer	否	1	缩容失败冷却时间，取值范围：[1,60]，单位：分钟。当ScaleDown.Enabled=true时必须传入。
ScaleDown.SkipNodesWithLocalStorageDisabled	Boolean	否	false	触发缩容时不跳过包含本地存储 Pod 的节点。取值： true：是，不跳过。 false：（默认值）否，跳过。当ScaleDown.Enabled=true时必须传入。
ScaleDown.SkipNodesWithSystemPodsDisabled	Boolean	否	false	触发缩容时不跳过包含 kube-system 命名空间下非 DaemonSet 管理的 Pod 节点。取值： true：是，不跳过。 false：（默认值）否，跳过。当ScaleDown.Enabled=true时必须传入。
ScaleDown.MaxEmptyBulkDeleteNumber	Integer	否	5	最大并发缩容数，取值范围：[1,15]，单位：个。当ScaleDown.Enabled=true时必须传入。
ScaleDown.MinReplicas	Integer	否	0	节点排水时允许工作负载存在的最小 Pod 数量。
ScaleDown.MaxGracefulTermination	Integer	否	600	节点排水时等待 Pod 终止的最大秒数。
ScaleDown.DaemonSetEvictionForNodesDisabled	Boolean	否	false	节点缩容时不对节点上 DaemonSet 类型的 Pod 排水。 true：是，不对节点上 DaemonSet 类型的 Pod 进行排水。 false：（默认值）否，对节点上 DaemonSet 类型的 Pod 进行排水。
ScaleDown.IgnoreDaemonSetsUtilizationEnabled	Boolean	否	false	在计算缩减规模时的资源利用率时，是否会忽略 DaemonSet Pod。取值： true：计算时会忽略 DaemonSet Pod。 false：（默认值）计算时不会忽略 DaemonSet Pod。
ScaleDown.ScaleDownDelayTypeLocalEnabled	Boolean	否	false	是否基于节点池本地状态计算缩容延迟。取值： true：基于节点本地状态计算缩容延迟。为集群每个节点池维护独立的“缩容延迟计时器”，能够加速缩容，避免浪费资源。 false：（默认值）：集群中所有的节点池使用同一个“缩容延迟计时器”，在缩容冷却时间内不会进行缩容。
ScaleUp.Expander	String	是	random	节点自动扩容时所采用的扩容策略类型。取值： random：（默认值）随机选择一个节点池进行扩容。 most-pods：选择能够调度最多 Pods 的节点池进行扩容。 least-waste：选择 CPU 资源最少的空闲节点池进行扩容。 priority：选择所设优先级最高的节点池进行扩容。

Config 示例

{
"ScanInterval": "15s",
"ScaleDown": {
"Enabled": false,
"UtilizationThreshold": 0.5,
"GpuUtilizationThreshold": 0.5,
"UnneededTime": 10,
"DelayAfterAdded": 10,
"DelayAfterFailure": 3,
"SkipNodesWithLocalStorageDisabled": true,
"SkipNodesWithSystemPodsDisabled": true,
"MaxEmptyBulkDeleteNumber": 5,
"MinReplicas": 0,
"MaxGracefulTermination": 600,
"DaemonSetEvictionForNodesDisabled": false,
"ScaleDownDelayTypeLocalEnabled": false,
"IgnoreDaemonSetsUtilizationEnabled": false
},
"ScaleUp": {
"Expander": "random"
}
}

event-collector

配置内容

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

Config 示例

{
"ProjectId": "4611ffdsa8-****",
"TopicId": "f8fsdb36-9fae-****",
"AccessKeyId": "AK************",
"AccessKeySecret": "SK**********"
}

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：开启。说明负载感知调度的使用方法，请参见负载感知调度。
LoadAwareSchedulingConfig	Object	否	-	开启负载感知调度后（LoadAwareSchedulingEnabled=true），该参数配置生效。负载感知调度配置。子参数说明，请参见下方表格 LoadAwareSchedulingConfig。
NumaAwareSchedulingEnabled	Boolean	否	false	【邀测·申请试用】是否开启 NUMA 拓扑感知调度。拓扑感知调度提供中心调度器与单机协作的拓扑感知调度能力，为负载提供更好的性能。 false：（默认值）不开启。 true：开启。说明拓扑感知调度的使用方法，请参见拓扑感知调度。

ResourceWeight

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

LoadAwareSchedulingConfig

配置名称	参数类型	是否必传	示例	描述
Scope	String	否	cluster	负载感知调度策略生效范围，取值： cluster：负载感知调度策略在集群范围生效，集群内所有 Pod 调度均开启负载感知插件。 pod：（默认值）负载感知调度策略在 Pod 范围生效，需要为 Pod 添加启用负载感知调度的 Annotation，才会生效。Annotaition 配置方法，请参见负载感知调度。
UsageThresholds	Array of LoadAwareUsageThreshold	否	-	负载感知调度插件的资源利用率阈值。子参数说明，参考下方表格 LoadAwareUsageThreshold。
ResourceWeights	Array of LoadAwareResourceWeight	否	-	负载感知调度插件资源权重。子参数说明，参考下方表格 LoadAwareResourceWeight。

LoadAwareUsageThreshold

配置名称	参数类型	是否必传	示例	描述
Name	String	是	Memory	负载感知调度的节点资源利用率阈值类型，取值： Cpu：CPU 资源 Memory：内存资源
Threshold	Integer	是	100	负载感知调度节点资源阈值的设定值。取值范围：[1,100] 单位：% 默认值： Cpu：70 Memory：95

LoadAwareResourceWeight

配置名称	参数类型	是否必传	示例	描述
Name	String	是	Memory	负载感知调度的节点资源权重类型，取值： Cpu：CPU 资源 Memory：内存资源
Weight	Integer	是	10	负载感知调度节点资源权重的设定值。取值范围：[1,10]，权重越大得分越高。默认值： Cpu：1 Memory：1

Config 示例

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

p2p-accelerator

基础配置

配置名称	参数类型	是否必传	示例	描述
NydusEnabled	Boolean	是	false	是否为 Nydus 镜像懒加载开启 P2P 加速回源。 true：Nydus 通过 P2P 的 Seed Peer 进行回源，适合大规模扩容或多节点同时拉取同一镜像的场景，可降低镜像仓库的回源压力。 false：（默认值）Nydus 直接回源至镜像仓库。说明该配置仅为镜像懒加载功能提供 P2P 加速回源能力，开启该功能时，您还需要保证进行以下操作，才能正确使用镜像懒加载功能。已在集群中安装 image-accelerator 组件。详情请参见容器镜像懒加载。已在对应的镜像仓库同步开启懒加载能力。详情请参见创建镜像懒加载转化规则。
Registry	String	是	cr-demo	选择已开启 P2P 镜像加速的镜像仓库标准版实例。
DeployNodeType	String	是	Node	组件部署使用的节点类型。取值： Node：以节点（云服务器）方式部署的组件。 VirtualNode：以虚拟节点（弹性容器实例）方式部署的组件。
NodeSelector	Array	否	[]	组件全局节点选择器。支持将 Scheduler、Seed Peer、Preheater Controller 等资源调度到指定节点。当配置为空时，表示不限制节点。该配置不影响 Peer、Watcher 和 Preheater Agent 资源的调度。
NodeSelector[].Key	String	否	cluster.vke.volcengine.com/pool-name	节点选择时的标签键。
NodeSelector[].Value	String	否	p2p	节点选择时的标签值。
Tolerations	Array	否	[]	组件全局 Kubernetes 污点容忍规则，通常与节点选择器（NodeSelector）配合使用，使组件能够调度到带污点的 P2P 专用节点池。
Tolerations[].Key	String	否	cluster.vke.volcengine.com/pool-name	容忍规则中的污点键。用于识别 P2P 专用节点池上的污点。配置后，P2P 组件工作负载可以容忍带有该键的污点，并结合NodeSelector调度到对应的专用节点池。
Tolerations[].Operator	String	否	Equal	污点匹配方式。取值： Equal：表示污点键（Key）和污点值（Value）均需与节点污点一致。 Exists：表示只匹配污点键（Key）。
Tolerations[].Value	String	否	p2p	容忍规则中的污点值。当Operator为Equal时，该值必须与节点污点的 Value 配置一致。
Tolerations[].Effect	String	否	NoSchedule	容忍的节点污点效果，必须与节点上污点配置的Effect一致。 P2P 专用节点池使用NoSchedule，表示默认不允许未配置对应容忍规则的工作负载调度到该节点池，从而将 P2P 组件与普通业务工作负载隔离。

Scheduler 配置

配置名称	参数类型	是否必传	示例	描述
Scheduler.Replicas	Integer	否	3	Scheduler 副本数。正整数形式，默认值为 3。建议配置为多副本形式，避免单点故障影响整个集群的镜像拉取调度。
Scheduler.Tolerations	Array	否	[]	配置 Scheduler 对节点污点（Taint）的容忍规则。该规则的优先级高于基础配置中的全局规则。
Scheduler.Affinity	Object	否	{}	配置 Scheduler 的 Kubernetes 亲和性规则。
Scheduler.Resources.Limits.Cpu	String	否	4	Scheduler 组件的 CPU 上限。字符串形式，取值必须大于 0，精度不能小于 1m。单位为核或毫核。当单位为核时，无需额外配置单位，例如 2 表示 2 个 CPU。当单位为毫核时，格式为CPU 请求+m，例如100m表示 100 毫核。默认值为 4。
Scheduler.Resources.Limits.Memory	String	否	8Gi	Scheduler 组件的内存上限。字符串形式，格式为数字+单位。单位支持 Mi 或 Gi。例如90Mi表示内存资源为 90MiB；2Gi表示内存资源为 2GiB。默认值为 8Gi。
Scheduler.Resources.Requests.Cpu	String	否	2	Scheduler 组件的 CPU 请求。字符串形式，取值必须大于 0，精度不能小于 1m。单位为核或毫核。当单位为核时，无需额外配置单位，例如 2 表示 2 个 CPU。当单位为毫核时，格式为CPU 请求+m，例如100m表示 100 毫核。默认值为 2。
Scheduler.Resources.Requests.Memory	String	否	4Gi	Scheduler 组件的内存请求。字符串形式，格式为数字+单位。单位支持 Mi 或 Gi。例如90Mi表示内存资源为 90MiB；2Gi表示内存资源为 2GiB。默认值为 4Gi。

Seed Peer 配置（DfdaemonProxy）

配置名称	参数类型	是否必传	示例	描述
DfdaemonProxy.Replicas	Integer	否	3	Seed Peer 副本数。正整数形式，默认值为 3。建议配置为多副本形式，避免单点故障影响整个集群的镜像拉取调度。
DfdaemonProxy.Tolerations	Array	否	[]	配置 Seed Peer 对节点污点（Taint）的容忍规则。该规则的优先级高于基础配置中的全局规则。
DfdaemonProxy.Affinity	Object	否	{}	配置 Seed Peer 的 Kubernetes 亲和性规则。
DfdaemonProxy.Persistence.HostPath	Object	否	{}	使用节点本地盘的目录保存镜像缓存。
DfdaemonProxy.Persistence.HostPath.Path	String	否	/mnt/p2pcache	使用节点本地目录保存镜像缓存时，节点上的保存目录，固定为/mnt/p2pcache，请勿自定义为其他路径。
DfdaemonProxy.Persistence.HostPath.Type	String	否	DirectoryOrCreate	使用节点本地目录保存镜像缓存时，HostPath类型。配置为DirectoryOrCreate时，表示目录不存在时系统会自动创建。
DfdaemonProxy.Persistence.StorageClass	String	否	ebs-ssd	使用云盘保存镜像缓存，并指定 PVC 使用的 StorageClass。该参数的值为空时，表示由系统根据账号支持的云盘类型自动选择。
DfdaemonProxy.Persistence.Size	String	否	100Gi	每个 Seed Peer 实例申请的缓存盘容量。默认值为 100 GiB。
DfdaemonProxy.Resources.Limits.Cpu	String	否	12	Seed Peer 组件的 CPU 上限。字符串形式，取值必须大于 0，精度不能小于 1m。单位为核或毫核。当单位为核时，无需额外配置单位，例如 2 表示 2 个 CPU。当单位为毫核时，格式为CPU 请求+m，例如100m表示 100 毫核。默认值为 12。
DfdaemonProxy.Resources.Limits.Memory	String	否	24Gi	Seed Peer 组件的内存上限。字符串形式，格式为数字+单位。单位支持 Mi 或 Gi。例如90Mi表示内存资源为 90MiB；2Gi表示内存资源为 2GiB。默认值为 24Gi。
DfdaemonProxy.Resources.Requests.Cpu	String	否	4	Seed Peer 组件的 CPU 请求。字符串形式，取值必须大于 0，精度不能小于 1m。单位为核或毫核。当单位为核时，无需额外配置单位，例如 2 表示 2 个 CPU。当单位为毫核时，格式为CPU 请求+m，例如100m表示 100 毫核。默认值为 4。
DfdaemonProxy.Resources.Requests.Memory	String	否	8Gi	Seed Peer 组件的内存请求。字符串形式，格式为数字+单位。单位支持 Mi 或 Gi。例如90Mi表示内存资源为 90MiB；2Gi表示内存资源为 2GiB。默认值为 8Gi。
DfdaemonProxy.Config.Storage.Keep	Boolean	否	true	Seed Peer 重启后是否保留已有缓存数据。 true：（默认值）Seed Peer 重启后继续使用已缓存的镜像数据，不影响其他节点的正常拉取。 false：Seed Peer 重启时自身缓存将丢失，镜像数据仍可通过集群内其他 Peer 节点的缓存获取。仅当所有节点均无缓存时，才会触发从镜像仓库回源。建议仅在需要强制清空 Seed Peer 缓存时使用。
DfdaemonProxy.Config.Gc.Policy.TaskTtl	String	否	720h	Seed Peer 缓存的过期时间。超过该时间未被访问的缓存数据将被标记为可回收。 Kubernetes duration 字符串格式，支持时间单位，例如 48h、168h。
DfdaemonProxy.Config.Gc.Policy.DiskThreshold	String	否	0	参与缓存回收阈值计算的磁盘容量。字符串形式，格式为数字+单位。例如 512GiB。该值必须小于缓存盘的实际大小。取值为 0 时，表示使用缓存盘的实际容量。
DfdaemonProxy.Config.Gc.Policy.DiskHighThresholdPercent	Integer	否	90	磁盘使用率高水位阈值，单位为百分比。当磁盘使用率达到该阈值时，触发缓存回收，将数据清理至低水位以下。磁盘容量较小或缓存增长较快时，可适当降低该值，提前触发缓存回收，避免磁盘空间耗尽。调高该值可保留更多缓存，但存在磁盘空间耗尽的风险。说明该参数的取值必须大于DiskLowThresholdPercent。
DfdaemonProxy.Config.Gc.Policy.DiskLowThresholdPercent	Integer	否	70	磁盘使用率低水位阈值，单位为百分比。触发回收后，系统持续清理缓存直到磁盘使用率降至该阈值以下。该值越低，每次回收清理的数据越多，可以减少回收频率，但会删除更多潜在有效缓存；建议与高水位保持合理间距，避免频繁触发小规模回收。说明该参数的取值必须小于DiskHighThresholdPercent。

Peer 配置（Dfdaemon）

配置名称	参数类型	是否必传	示例	描述
Dfdaemon.Persistence.HostPath.Path	String	否	/mnt/p2pcache	Peer 在节点上的挂载路径，固定为/mnt/p2pcache，请勿自定义为其他路径。仅对带有vke.volcengine.com/p2p-cache-disk=true标签的节点生效。其他节点使用系统盘上的 emptyDir。
Dfdaemon.Persistence.HostPath.Type	String	否	DirectoryOrCreate	HostPath 类型。配置为DirectoryOrCreate时，表示目录不存在时系统会自动创建。
Dfdaemon.Resources.Limits.Cpu	String	否	2	Peer 组件的 CPU 上限。字符串形式，取值必须大于 0，精度不能小于 1m。单位为核或毫核。当单位为核时，无需额外配置单位，例如 2 表示 2 个 CPU。当单位为毫核时，格式为CPU 请求+m，例如100m表示 100 毫核。默认值为 2。
Dfdaemon.Resources.Limits.Memory	String	否	4Gi	Peer 组件的内存上限。字符串形式，格式为数字+单位。单位支持 Mi 或 Gi。例如90Mi表示内存资源为 90MiB；2Gi表示内存资源为 2GiB。默认值为 4Gi。
Dfdaemon.Resources.Requests.Cpu	String	否	200m	Peer 组件的 CPU 请求。字符串形式，取值必须大于 0，精度不能小于 1m。单位为核或毫核。当单位为核时，无需额外配置单位，例如 2 表示 2 个 CPU。当单位为毫核时，格式为CPU 请求+m，例如100m表示 100 毫核。默认值为 0.2。
Dfdaemon.Resources.Requests.Memory	String	否	200Mi	Peer 组件的内存请求。字符串形式，格式为数字+单位。单位支持 Mi 或 Gi。例如90Mi表示内存资源为 90MiB；2Gi表示内存资源为 2GiB。默认值为 200Mi。
Dfdaemon.Config.Storage.Keep	Boolean	否	true	Peer 重启后是否保留节点上的缓存数据。 true：Peer 重启后继续使用已缓存的镜像数据，不影响节点的正常拉取。 false：Peer 重启时自身缓存将丢失，镜像数据仍可通过 Seed Peer 或集群内其他 Peer 节点的缓存获取。仅当所有节点均无缓存时，才会触发从镜像仓库回源。建议仅在需要强制清空该节点缓存时使用。
Dfdaemon.Config.Gc.Policy.TaskTtl	String	否	168h	Peer 缓存的过期时间。超过该时间未被访问的缓存数据将被标记为可回收。 Kubernetes duration 字符串格式，支持时间单位，例如 48h、168h。
Dfdaemon.Config.Gc.Policy.DiskThreshold	String	否	0	参与缓存回收阈值计算的磁盘容量。字符串形式，格式为数字+单位。例如 512GiB。该值必须小于缓存盘的实际大小。取值为 0 时，表示使用缓存盘的实际容量。
Dfdaemon.Config.Gc.Policy.DiskHighThresholdPercent	Integer	否	90	磁盘使用率高水位阈值，单位为百分比。当磁盘使用率达到该阈值时，触发缓存回收，将数据清理至低水位以下。磁盘容量较小或缓存增长较快时，可适当降低该值，提前触发缓存回收，避免磁盘空间耗尽。调高该值可保留更多缓存，但存在磁盘空间耗尽的风险。说明该参数的取值必须大于DiskLowThresholdPercent。
Dfdaemon.Config.Gc.Policy.DiskLowThresholdPercent	Integer	否	70	磁盘使用率低水位阈值，单位为百分比。触发回收后，系统持续清理缓存直到磁盘使用率降至该阈值以下。该值越低，每次回收清理的数据越多，可以减少回收频率，但会删除更多潜在有效缓存；建议与高水位保持合理间距，避免频繁触发小规模回收。说明该参数的取值必须小于DiskHighThresholdPercent。

镜像预热配置

配置名称	参数类型	是否必传	示例	描述
EnableImagePreheater	Boolean	否	true	是否部署镜像预热组件。取值： true：创建镜像预热组件，包括 Preheat Controller、Preheat Agent 及相关资源。 false：不创建。
PreheaterController.Replicas	Integer	否	2	Preheat Controller 副本数。整数形式，取值范围为 1～5。默认值为 2。
PreheaterController.Resources.Limits.Cpu	String	否	1	Preheat Controller 组件的 CPU 上限。字符串形式，取值必须大于 0，精度不能小于 1m。单位为核或毫核。当单位为核时，无需额外配置单位，例如 2 表示 2 个 CPU。当单位为毫核时，格式为CPU 请求+m，例如100m表示 100 毫核。默认值为 1。
PreheaterController.Resources.Limits.Memory	String	否	1Gi	Preheat Controller 组件的内存上限。字符串形式，格式为数字+单位。单位支持 Mi 或 Gi。例如90Mi表示内存资源为 90MiB；2Gi表示内存资源为 2GiB。默认值为 1Gi。
PreheaterController.Resources.Requests.Cpu	String	否	200m	Preheat Controller 组件的 CPU 请求。字符串形式，取值必须大于 0，精度不能小于 1m。单位为核或毫核。当单位为核时，无需额外配置单位，例如 2 表示 2 个 CPU。当单位为毫核时，格式为CPU 请求+m，例如100m表示 100 毫核。默认值为 0.2。
PreheaterController.Resources.Requests.Memory	String	否	256Mi	Preheat Controller 组件的内存请求。字符串形式，格式为数字+单位。单位支持 Mi 或 Gi。例如90Mi表示内存资源为 90MiB；2Gi表示内存资源为 2GiB。默认值为 256Mi。
PreheaterAgent.Resources.Limits.Cpu	String	否	2	Preheat Agent 组件的 CPU 上限。字符串形式，取值必须大于 0，精度不能小于 1m。单位为核或毫核。当单位为核时，无需额外配置单位，例如 2 表示 2 个 CPU。当单位为毫核时，格式为CPU 请求+m，例如100m表示 100 毫核。默认值为 2。
PreheaterAgent.Resources.Limits.Memory	String	否	512Mi	Preheat Agent 组件的内存上限。字符串形式，格式为数字+单位。单位支持 Mi 或 Gi。例如90Mi表示内存资源为 90MiB；2Gi表示内存资源为 2GiB。默认值为 512Mi。
PreheaterAgent.Resources.Requests.Cpu	String	否	100m	Preheat Agent 组件的 CPU 请求。字符串形式，取值必须大于 0，精度不能小于 1m。单位为核或毫核。当单位为核时，无需额外配置单位，例如 2 表示 2 个 CPU。当单位为毫核时，格式为CPU 请求+m，例如100m表示 100 毫核。默认值为 0.1。
PreheaterAgent.Resources.Requests.Memory	String	否	128Mi	Preheat Agent 组件的内存请求。字符串形式，格式为数字+单位。单位支持 Mi 或 Gi。例如90Mi表示内存资源为 90MiB；2Gi表示内存资源为 2GiB。默认值为 128Mi。

Config 示例

{
"NydusEnabled": false,
"Registry": "cr-demo",
"DeployNodeType": "Node",
"NodeSelector": [
{
"Key": "cluster.vke.volcengine.com/pool-name",
"Value": "p2p"
}
],
"Tolerations": [
{
"Key": "cluster.vke.volcengine.com/pool-name",
"Operator": "Equal",
"Value": "p2p",
"Effect": "NoSchedule"
}
],
"Scheduler": {
"Replicas": 3,
"Resources": {
"Limits": { "Cpu": "4", "Memory": "8Gi" },
"Requests": { "Cpu": "2", "Memory": "4Gi" }
}
},
"DfdaemonProxy": {
"Replicas": 3,
"Persistence": {
"StorageClass": "ebs-ssd",
"Size": "100Gi"
},
"Resources": {
"Limits": { "Cpu": "12", "Memory": "24Gi" },
"Requests": { "Cpu": "4", "Memory": "8Gi" }
},
"Config": {
"Storage": { "Keep": true },
"Gc": {
"Policy": {
"TaskTtl": "720h",
"DiskThreshold": "0",
"DiskHighThresholdPercent": 90,
"DiskLowThresholdPercent": 70
}
}
}
},
"Dfdaemon": {
"Persistence": {
"HostPath": {
"Path": "/mnt/p2pcache",
"Type": "DirectoryOrCreate"
}
},
"Resources": {
"Limits": { "Cpu": "2", "Memory": "4Gi" },
"Requests": { "Cpu": "200m", "Memory": "200Mi" }
},
"Config": {
"Storage": { "Keep": true },
"Gc": {
"Policy": {
"TaskTtl": "168h",
"DiskThreshold": "0",
"DiskHighThresholdPercent": 90,
"DiskLowThresholdPercent": 70
}
}
}
},
"EnableImagePreheater": true,
"PreheaterController": {
"Replicas": 2,
"Resources": {
"Limits": { "Cpu": "1", "Memory": "1Gi" },
"Requests": { "Cpu": "200m", "Memory": "256Mi" }
}
},
"PreheaterAgent": {
"Resources": {
"Limits": { "Cpu": "2", "Memory": "512Mi" },
"Requests": { "Cpu": "100m", "Memory": "128Mi" }
}
}
}

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"
}

请求示例

返回参数

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

返回示例

错误码

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

HTTP 状态码	错误码	错误信息	说明
409	AlreadyExists.{{parameter}}	The specified {{resourceType}} {{resourceId}} already exists.	指定的资源已存在。
400	OperationDenied.NetworkMode	The specified addon is not compatible with the current network mode.	当前网络模型不支持。
400	OperationDenied.DeployMode	The specified deploy mode is not supported.	当前部署模式不支持。
400	OperationDenied.DeployNodeType	The specified deploy node type is not supported.	当前部署节点类型不支持。
400	OperationDenied.ClusterStatus	The action is forbidden due to cluster status {{statusPhase}} and {{statusConditions}}.	指定集群的当前状态不支持该操作。请确认该接口依赖的集群状态后重试。
400	NotSupported.{{parameter}}	The specified {{resourceType}} {{resourceContent}} is not supported.	指定的资源不支持安装。

容器服务