容器服务
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | UpdateClusterConfig | 接口名称。当前 API 的名称为 UpdateClusterConfig。 |
Version | String | 是 | 2022-05-12 | 接口版本。当前 API 的版本为 2022-05-12。 |
ClientToken | String | 否 | BC028527-33B9-4990-**** | 用于保证请求幂等性的字符串。该字符串由调用方传入,需保证不同请求之间唯一。ClientToken 对大小写敏感,且最大值不超过 64 个 ASCII 字符。 |
Id | String | 是 | cc8o***** | 待更新集群的 ID。 注意 |
Name | String | 否 | TestCluster | 集群名称。
|
Description | String | 否 | A Kubernetes Cluster Managed by VKE | 集群描述,长度限制为 300 个字符以内。 |
DeleteProtectionEnabled | Boolean | 否 | false | |
ClusterConfig | 否 | - | 集群控制面及节点的网络配置。 | |
PodsConfig | 否 | - | 集群的容器(Pod)网络配置。 | |
LoggingConfig | 否 | - | 集群的日志配置信息。 | |
KubernetesConfig | 否 | - | Kubernetes 相关参数配置。 | |
MonitoringConfig | 否 | - | 集群监控配置。 | |
MaintenanceWindowConfig | 否 | - | 集群的运维配置信息。 | |
IrsaEnabled | Boolean | 否 | false | 当前集群是否启用 IRSA (IAM Role for Service Account) 能力,实现集群内 Pod 维度的 OpenAPI 权限隔离:
|
SourceRegion | String | 否 | cn-beijing | |
RegisterMonitoringConfig | 否 | - | 注册集群监控配置。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
SubnetIds | Array of String | 否 | ["subnet-5g39***","subnet-5g39***"] | 集群控制面在私有网络(VPC)内通信的子网 ID。 注意
|
ApiServerPublicAccessEnabled | Boolean | 否 | false | 集群 API Server 公网访问配置,取值:
|
ApiServerPublicAccessConfig | 否 | - | 集群 API Server 公网访问配置信息。 ApiServerPublicAccessEnabled=true时才生效。 | |
ClusterConnectorConfigRequest | 否 | - | 注册集群连接配置。 | |
ResourcePublicAccessDefaultEnabled | Boolean | 否 | false | 集群内节点、应用的公网访问配置,取值:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
PublicAccessNetworkConfig | 否 | - | 集群 API Server 公网访问网络配置。ApiServerPublicAccessEnabled=true时才需要填写,否则忽略。 说明 集群创建完成后暂不支持修改该参数,请合理配置。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Isp | String | 否 | BGP | 公网 IP 的线路类型,取值:
|
Bandwidth | Integer | 否 | 100 | 公网 IP 的带宽峰值,单位为 Mbps,取值:
|
BillingType | Integer | 否 | 3 | 公网 IP 的计费类型,取值:
|
BandwidthPackageId | String | 否 | bwp-2zeo******** | 共享带宽包的 ID,表示将公网 IP 加入到共享带宽包。 注意 公网 IP 加入到共享带宽包时,必须同时满足如下条件:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Type | String | 是 | Direct | 注册集群的连接方式,取值:
|
Provider | String | 是 | Ack | 注册集群的提供商,取值:
|
ProxyConfig | 否 | - | 注册集群代理模式配置。 仅Tpye为Agent时需要配置。 | |
TargetKubeConfig | String | 否 | - | 待注册集群的 KubeConfig(需要进行 BASE64 编码),取值范围为 0~20480。 仅Type=Direct时才需配置,否则会被忽略。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
SubnetIds | Array of String | 否 | ["subnet-5g39***","subnet-5g39d***"] | 注册集群控制面在 VPC 内网络通信使用的子网 ID 列表。 |
AclEnabled | Boolean | 否 | true | 白名单访问控制,用于限制访问注册集群的 IP 地址。若开启并配置白名单 IP CIDR,集群接入时代理 Agent 的接入 IP 和集群接入后允许访问 APIServer 的 IP 将受到限制于配置的白名单范围,否则拒绝访问。取值:
|
AclIpWhitelist | Array of String | 否 | ["192.168.1.0/24", "10.0.0.0/16"] | ACL 白名单 IP 列表,支持 CIDR 格式,仅在AclEnabled 为true时有效。 |
ApiServerPublicAccessConfig | 否 | - | 注册集群的公网访问配置,仅在ApiServerPublicAccessEnabled为true时需配置,否则会忽略该参数。 | |
ApiServerPublicAccessEnabled | Boolean | 否 | false | 注册集群 API Server 公网访问配置,取值:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
VpcCniConfig | 否 | - | VPC-CNI 网络配置。 | |
FlannelConfig | 否 | - | Flannel 网络配置。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
SubnetIds | Array of String | 否 | ["subnet-5g39dw******","subnet-5g3vp******"] | VPC-CNI 容器网络模型对应的 Pod 子网 ID 列表。 PodNetworkMode=VpcCniShared时才需填写,否则忽略。 注意 更新集群时,仅支持在当前集群原有 Pod 子网基础上增加 Pod 子网。 |
VciSubnetIds | Array of String | 否 | ["subnet-5g39d****","subnet-5g39d****"] | VPC-CNI 容器网络模型对应的 VCI Pod 子网 ID 列表。 PodNetworkMode=VpcCniShared时才需填写,否则忽略。 注意 VCI Pod 子网必须为 Pod 子网的子集。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
SubnetIds | Array of String | 否 | ["subnet-5g39***","subnet-5g39***"] |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
LogSetups | 否 | - | 集群的日志选项信息。
| |
LogProjectId | String | 否 | b68324a0-2680-48c7******** | 集群的日志项目(Log Project)ID。 注意
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
LogTtl | Integer | 否 | 30 | 日志在日志服务中的保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。
|
Enabled | Boolean | 否 | false | 是否开启该日志选项,取值:
注意
|
LogType | String | 是 | Audit | 当前开启的日志类型,取值:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
CustomSans | Array of String | 否 | ["abc.com","192.168.0.10"] | 自定义签发域名或 IP 能力,支持输入符合规范的自定义 IP、域名或 URI,多个配置以半角逗号(,)分隔。支持最多 6 条自定义证书 SAN(Subject Alternative Name)。更多使用说明,请参见 使用自定义域名连接集群。 |
ClusterDomain | String | 否 | cluster.local | 集群本地域名。域名由小数点(.)分隔的两个或更多部分组成,每个部分用小写字母、数字和中划线(-),且首尾必须为小写字母或数字,长度不超过 57 个字符。 |
AdvancedConfig | 否 | - | kube-apiserver 增强配置。 | |
ControlPlaneConfig | 否 | - | Kubernetes 核心组件的自定义参数配置。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
InternalDnsEnabled | Boolean | 否 | true | 是否为集群开启 API Server 私网域名访问:
注意 2026 年 5 月 15 日之前创建的 VKE 托管集群中,节点侧组件通过 CLB VIP 访问 API Server。您可以通过配置本参数,将节点侧组件访问 API Server 的链路切换为通过私网域名访问。配置完后您还需要进行一系列操作,详情请参见 为存量集群开启 API Server 私网域名访问。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
KubeApiServerConfig | 否 | - | kube-apiserver 组件的自定义参数配置。 | |
KubeSchedulerConfig | 否 | - | kube-scheduler 组件的自定义参数配置。 | |
KubeControllerManagerConfig | 否 | - | kube-controller-manager 组件的自定义参数配置。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
FeatureGates | 否 | - | kube-apiserver 的特性门控配置。 | |
RequestTimeout | String | 否 | 60s | 请求超时时间,即处理程序保持请求打开的最长时间。
|
AdmissionPlugins | 否 | - | kube-apiserver 中除默认启用的准入控制插件之外,额外启用的准入控制插件列表。 | |
DefaultNotReadyTolerationSeconds | Integer | 否 | 300 | Pod 对节点NotReady:NoExecute污点的容忍时长。
|
DefaultUnreachableTolerationSeconds | Integer | 否 | 300 | Pod 对节点Unreachable:NoExecute污点的容忍时长。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
SidecarContainers | Boolean | 否 | true | 是否开启 SidecarContainers 特性开关,支持原生 Sidecar 容器。取值:
注意 仅以下版本 VKE 集群中支持使用该特性门控:
|
StatefulSetAutoDeletePVC | Boolean | 否 | true | 是否开启 StatefulSetAutoDeletePVC 特性开关,支持 StatefulSet 自动删除 PVC。取值:
注意 仅以下版本 VKE 集群中支持使用该特性门控:
|
InPlacePodVerticalScaling | Boolean | 否 | true | 是否开启 InPlacePodVerticalScaling 特性开关,支持 Pod 原地垂直伸缩。取值:
注意 仅 Kubernetes v1.34 版本 VKE 集群中支持使用该特性门控。 |
MaxUnavailableStatefulSet | Boolean | 否 | true | 是否开启 MaxUnavailableStatefulSet 特性开关,支持为 StatefulSet 的滚动更新增加maxUnavailable配置,允许更新时同时让多个 Pod 处于不可用状态并行更新。取值:
注意 仅以下版本 VKE 集群中支持使用该特性门控:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
PodNodeSelector | Boolean | 否 | true | 是否启用 PodNodeSelector 准入控制插件。取值:
|
AlwaysPullImages | Boolean | 否 | true | 是否启用 AlwaysPullImages 准入控制插件。取值:
|
PodTolerationRestriction | Boolean | 否 | true | 是否启用 PodTolerationRestriction 准入控制插件。取值:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
KubeApiQps | Integer | 否 | 50 | kube-scheduler 与 APIServer 通信的 QPS 限制。
|
Parallelism | Integer | 否 | 16 | kube-scheduler 在执行调度算法时同时并行执行的 Goroutine 数量。
|
FeatureGates | 否 | - | kube-scheduler 的特性门控配置。 | |
KubeApiBurst | Integer | 否 | 100 | kube-scheduler 与 APIServer 通信时的突发请求上限。
注意 KubeApiBurst 的取值必须大于等于 KubeApiQps 取值。 |
PodMaxBackoffSeconds | Integer | 否 | 10 | Pod 调度失败后最大回退秒数,两次调度间隔不会低于当前回退秒数。
|
PercentageOfNodesToScore | Integer | 否 | 50 | 调度 Pod 时评估的可运行节点比例,找到指定比例的节点后停止筛选。
|
PodInitialBackoffSeconds | Integer | 否 | 1 | 为无法调度的 Pod 设置初始退避时间。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
SidecarContainers | Boolean | 否 | true | 是否开启 SidecarContainers 特性开关,支持原生 Sidecar 容器。取值:
注意 仅以下版本 VKE 集群中支持使用该特性门控:
|
InPlacePodVerticalScaling | Boolean | 否 | true | 是否开启 InPlacePodVerticalScaling 特性开关,支持 Pod 原地垂直伸缩。取值:
注意 仅 Kubernetes v1.34 版本 VKE 集群中支持使用该特性门控。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
KubeApiQps | Integer | 否 | 50 | kube-controller-manager 与 APIServer 通信的 QPS 限制。
|
FeatureGates | 否 | - | kube-controller-manager 的特性门控配置。 | |
KubeApiBurst | Integer | 否 | 100 | kube-controller-manager 与 APIServer 通信时的突发请求上限。
注意 KubeApiBurst 的取值必须大于等于 KubeApiQps 取值。 |
NodeEvictionRate | Double | 否 | 0.1 | 节点故障场景下的 Pod 驱逐速率。当所在可用区处于健康状态时,此参数控制每秒被选中进行 Pod 驱逐的节点数。
|
NodeMonitorGracePeriod | Integer | 否 | 50s | 节点失联后,被标记为NotReady或Unknown的时间。
|
UnhealthyZoneThreshold | Double | 否 | 0.55 | 可用区的不健康阈值。当同一个可用区内处于 NotReady 状态的节点比例超过此数值时,控制面会判定该可用区发生了整体基础设施异常,从而触发区域级的限流驱逐策略。
|
TerminatedPodGCThreshold | Integer | 否 | 12500 | Terminated Pod 垃圾回收阈值,即可以保留的 Terminated Pod 最大数量。
|
LargeClusterSizeThreshold | Integer | 否 | 50 | 集群的大规模阈值,节点控制器根据此阈值判断集群是否为大规模集群,以决定 Pod 驱逐策略。
|
SecondaryNodeEvictionRate | Double | 否 | 0.01 | 大面积故障时的第二档排空节点速率。当所在可用区被判定为“不健康”(故障比例超过UnhealthyZoneThreshold配置时),且节点失效时,每秒从此参数指定数量的节点上驱逐 Pod。
|
ConcurrentTTLAfterFinishedSyncs | Integer | 否 | 10 | 负责清理过期 Job 的 TTLAfterFinished 控制器的并发同步协程数。
|
HorizontalPodAutoscalerTolerance | Double | 否 | 0.1 | Pod 水平自动扩缩容(HPA)时,若实际指标与期望指标的偏差小于此容差率,则不会触发扩缩容。
|
HorizontalPodAutoscalerSyncPeriod | String | 否 | 15s | HPA 同步 Pod 数量的周期。
|
ConcurrentHorizontalPodAutoscalerSyncs | Integer | 否 | 5 | 允许并发同步的 HPA 对象数量。数值越大,HPA 对象处理响应越快,但会占用更多 CPU 及网络资源。
注意 仅 Kubernetes v1.26 及以上版本集群支持该参数。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
StatefulSetAutoDeletePVC | Boolean | 否 | true | 是否开启 StatefulSetAutoDeletePVC 特性开关,支持 StatefulSet 自动删除 PVC。取值:
注意 仅以下版本 VKE 集群中支持使用该特性门控:
|
InPlacePodVerticalScaling | Boolean | 否 | true | 是否开启 InPlacePodVerticalScaling 特性开关,支持 Pod 原地垂直伸缩。取值:
注意 仅 Kubernetes v1.34 版本 VKE 集群中支持使用该特性门控。 |
MaxUnavailableStatefulSet | Boolean | 否 | true | 是否开启 MaxUnavailableStatefulSet 特性开关,支持为 StatefulSet 的滚动更新增加maxUnavailable配置,允许更新时同时让多个 Pod 处于不可用状态并行更新。取值:
注意 仅以下版本 VKE 集群中支持使用该特性门控:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
WorkspaceId | String | 否 | 2521550******** | 集群监控使用的托管 Prometheus 工作区 ID。 |
ComponentConfigs | 否 | - | 集群控制面监控配置。 | |
EnableMetricsExternalCollection | Boolean | 否 | false | 是否开启外部 Promtheus 采集集群控制面组件指标,取值:
说明 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Name | String | 是 | KubeApiServer | 需要监控的集群控制面组件,取值:KubeApiServer、KubeScheduler、Etcd 和 ClusterAutoscaler。 |
Enabled | Boolean | 否 | true | 是否开启控制面组件监控,取值:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Duration | Integer | 否 | 4 | 自动运维的持续时长,整数形式,取值范围为 4~24,单位为小时。 未配置该参数时,默认值为 4。 |
StartTime | String | 否 | 20:00:00Z | 自动运维的开始时间,Golang 标准时间格式,24 小时制。取值范围为 00~23 中的整点。例如:01:00:00Z、14:00:00Z。 未配置该参数时,默认值为 16:00:00Z,即 UTC 标准时间 16:00:00,北京时间(UTC +8)次日 00:00:00。 说明
|
TaskConfigs | 否 | - | 自动运维任务配置。 未配置该参数时,系统默认只执行 集群控制面日常运维 任务,不执行其他运维任务。 | |
WeeklyCycle | Array of String | 否 | ["Monday","Tuesday"] | 自动运维的周期,取值:
未配置该参数时,系统默认每天都执行运维任务。 |
ExemptEndDate | String | 否 | 20260704 | 自动运维豁免窗口的结束时间,格式为YYYYMMDD,按北京时间(UTC +8)自然日执行。例如:配置为20260704时,表示截止到该日期的 23:59:59,不再执行自动运维任务。 说明 该日期必须晚于ExemptStartDate配置的日期,且最多不超过 60 天。 |
ExemptStartDate | String | 否 | 20260702 | 自动运维豁免窗口的开始时间,格式为YYYYMMDD,按北京时间(UTC +8)自然日执行。例如:配置为20260702时,表示从该日期的 00:00:00 点起,不再执行自动运维任务。 说明
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Group | String | 是 | Cluster | 自动运维任务的分组,取值:
|
Action | String | 是 | AutoUpgradeAddonVersion | 自动运维任务,取值:
|
Targets | Array of String | 否 | ["metrics-server","cluster-autoscaler"] |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
QueryUrl | String | 否 | http://query.prometheus-cn-beijing.ivolces.com/workspaces/1d0*** | 注册集群使用托管 Prometheus 进行监控时,托管 Prometheus 工作区的 Query 地址。注册集群使用该地址,查询保存在工作区的监控数据。 说明 |
WorkspaceId | String | 否 | e28ae750-bbb8******** | 注册集群使用托管 Prometheus 进行监控时,托管 Prometheus 工作区的 ID。 |
RemoteWriteUrl | String | 否 | http://write.prometheus-cn-beijing.ivolces.com/workspaces/1d0*** | 注册集群使用托管 Prometheus 进行监控时,托管 Prometheus 工作区的 RemoteWrite 地址。注册集群使用该地址,将集群监控数据保存在指定的工作区中。 说明 |
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
400 | OperationDenied.ClusterStatus | The action is forbidden due to cluster status {{statusPhase}} and {{statusConditions}}. | 指定集群的当前状态不支持该操作。请确认该接口依赖的集群状态后重试。 |
400 | QuotaExceeded.{{ResourceType}} | The quota of {{ResourceType}} has reached the limit. | 指定资源的配额达到上限,如 EIP、LogProject、LogTopic 等。请提升相关资源配额,或删除无用资源,预留出配额后重试。 |
400 | Insufficient.SubnetIp | The IP of subnet {{subnetId}} is insufficient. | 指定的子网可用 IP 数量不足。请指定符合要求的子网后重试。 |
400 | LimitExceeded.ClusterSubnetZones | You have reached the limit of the number of cluster subnet zones that you can add. | 集群子网可用区个数超过限制。请确保子网可用区不超过 3 个。 |
400 | LimitExceeded.ClusterSubnetsOfZone | You have reached the limit of the number of cluster subnets in zone {{zone}} that you can add. | 单个可用区下已指定的子网个数超过限制。请确保每个可用区下已指定的子网数不超过 2 个。 |
409 | Conflict.Name | The specified name conflicts with existing {{resourceType}}. | 指定地域存在同名资源,请更新资源名称后重试。 |
400 | IpFamilyMismatch.{{parameter}} | The specified {{resourceType}} {{resourceContent}} and IpFamily {{ipFamily}} are mismatched. | 指定的资源和网络协议栈不匹配。请确认资源支持的网络协议栈后重试。 |
403 | OperationDenied.{{cause}} | Operation is denied because {{causeDescription}}. | 表示操作被拒绝,当前环境下不允许更新集群。请根据具体错误信息说明解决问题后重试。 |