ModifyCluster - 修改集群配置

创建ACK集群后,如需修改集群的配置,您可以调用ModifyCluster接口来完成。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:ModifyClusterupdate
*Cluster
acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
  • cs:EnableApiServerEip
  • cs:ApiServerEipId

请求语法

PUT /api/v2/clusters/{ClusterId} HTTP/1.1

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

cb95aa626a47740afbf6aa099b65****
bodyobject

请求体参数。

api_server_eipboolean

集群是否绑定 EIP,用于公网访问 API Server。取值:

  • true:集群绑定 EIP。
  • false:集群不绑定 EIP。
true
api_server_eip_idstring

集群 API Server 绑定的 EIP 实例 ID,仅当api_server_eip取值为true时生效。

eip-wz9fnasl6dsfhmvci****
deletion_protectionboolean

集群删除保护,防止通过控制台或 API 误删除集群。取值:

  • true:启用集群删除保护,将不能通过控制台或 API 删除集群。
  • false:不启用集群删除保护,则能通过控制台或 API 删除集群。

默认值:false

true
instance_deletion_protectionboolean

实例删除保护,防止通过控制台或 API 误删除释放节点。取值:

  • true: 不能通过控制台或 API 误删除集群。
  • false:能通过控制台或 API 误删除集群。

默认值:false

true
ingress_domain_rebindingboolean

重新绑定集群测试域名。取值:

  • true:重新绑定集群测试域名。
  • false:不重新绑定集群测试域名。

默认值:false

true
ingress_loadbalancer_idstring

被修改集群的 SLB 实例 ID。

lb-wz97kes8tnndkpodw****
resource_group_idstring

集群资源组 ID。

rg-acfmyvw3wjm****
maintenance_windowmaintenance_window

集群维护窗口,该功能只在 Pro 托管版集群中生效。

enable_rrsaboolean

启用或禁用 RRSA 功能(只有托管版集群支持配置该参数)。取值:

  • true:启用。
  • false:禁用。
true
access_control_listarray

注册集群 API Server SLB 访问控制列表。

string

注册集群 API Server SLB 访问控制列表。

注意:不允许填写 0.0.0.0/0 网段。

192.168.1.0/24
cluster_namestring

集群名称。

命名规则:由数字、汉字、英文字符或短划线(-)组成,长度范围 1~63 个字符,且不能以短划线(-)开头。

cluster-new-name
system_events_loggingobject

系统事件存储配置。

enabledboolean

是否开启系统事件存储。

true
logging_projectstring

系统事件存储的 LogProject 名称。

k8s-log-cb95aa626a47740afbf6aa099b65****
operation_policyobject

集群自动运维策略。

cluster_auto_upgradeobject

集群自动升级。

enabledboolean

是否开启集群自动升级。

true
channelstring

集群自动升级频次。更多信息,请参见升级频次

可取值:

  • patch:最新补丁版本。
  • stable:次新次要版本。
  • rapid:最新次要版本。
patch
api_server_custom_cert_sansobject

自定义 API Server 证书 SAN(只有托管版集群支持配置该参数)。

actionstring

覆盖或追加 SAN 配置。取值:

  • overwrite: 覆盖
  • append: 追加
append
subject_alternative_namesarray

SAN 列表。

string

SAN。

192.168.0.119
vswitch_idsarray

集群控制面虚拟交换机。适用于托管类集群变更控制面虚拟交换机,请注意以下事项:

  • 该参数为覆盖更新,需完全指定目标交换机列表。
  • 变更过程控制面组件会短暂重启,请谨慎操作。
  • 请确保集群所有安全组(包括控制面安全组、所有节点池的安全组、容器网络使用的安全组)的出入方向已放行新的虚拟交换机的 IP 网段,避免节点与容器无法连接 API server。
  • 如新的控制面交换机配置了 ACL 规则,请确保该 ACL 规则已经放行其与集群节点、容器网络等 IP 网段的通信。
string

集群控制面虚拟交换机。

vsw-2ze4jvvvade1yk899****
control_plane_configobject

专有版集群控制面配置。

charge_typestring

控制面节点实例付费类型,取值:

  • PrePaid:包年包月。
  • PostPaid:按量付费。

默认值:PostPaid

PrePaid
periodlong

控制面节点实例包年包月时长,当charge_type取值为PrePaid时才生效且为必选值。

PeriodUnit=Month时,取值范围:{1, 2 , 3, 6, 12, 24, 36, 48, 60}。

1
period_unitstring

控制面节点实例付费周期,当charge_type取值为PrePaid时才生效。

Month:以月为计时单位,当前只支持以月为单位。

Month
auto_renewboolean

控制面节点实例是否开启自动续费,当charge_type取值为PrePaid时才生效。取值:

  • true:自动续费。
  • false:不自动续费。

默认值:false

true
auto_renew_periodlong

控制面节点实例单次自动续费的续费时长。 取值范围:{1, 2, 3, 6, 12}。

默认值:1。

1
instance_typesarray

实例规格。更多信息,请参见实例规格族

string

实例规格。

ecs.g6.large
image_typestring

操作系统镜像类型,取值范围:

  • AliyunLinux3:Alinux3 镜像。
  • Custom: 自定义镜像。
AliyunLinux3
image_idstring

自定义镜像 ID。自定义镜像时指定。

aliyun_3_x64_20G_alibase_20240819.vhd
key_pairstring

密钥对名称,和login_password二选一。

ack
login_passwordstring

SSH 登录密码,和key_pair 二选一。密码规则为 8~30 个字符,且至少同时包含三项(大小写字母、数字和特殊符号)。如需要使用密码登录,需在扩容时指定。

Ack@2000.
system_disk_categorystring

节点系统盘类型,取值:

  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
  • cloud_auto:ESSD AutoPL 云盘。
  • cloud_essd_entry:ESSD Entry 云盘。
cloud_essd
system_disk_sizelong

节点系统盘类型,取值范围[40,500],单位:GiB。

120
system_disk_snapshot_policy_idstring

节点系统盘采用的自动快照策略 ID。

sp-2zej1nogjvovnz4z****
system_disk_performance_levelstring

节点系统盘磁盘性能等级, 仅对 ESSD 磁盘生效。磁盘性能等级和磁盘大小有关。更多信息,请参见 ESSD 云盘

PL1
system_disk_provisioned_iopslong

节点系统盘预配置的读写 IOPS。可能值:0~min{50,000, 1000*容量-基准性能}。 基准性能=min{1,800+50*容量, 50000}。

system_disk_category 取值为cloud_auto时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘

1000
system_disk_bursting_enabledboolean

节点系统盘是否开启 Burst(性能突发)。 取值:

  • true:是。
  • false:否。

system_disk_category 取值为cloud_auto时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘

true
deploymentset_idstring

部署集 ID。

ds-bp10b35imuam5amw****
cloud_monitor_flagsboolean

控制面节点是否安装云监控插件。取值:

  • true:安装云监控插件。
  • false:不安装云监控插件。
true
soc_enabledboolean

等保加固。更多信息,请参见 ACK 等保加固使用说明

取值:

  • true:开启等保加固。
  • false:不开启等保加固。

默认值:false

false
security_hardening_osboolean

阿里云 OS 安全加固。取值:

  • true:开启阿里云 OS 安全加固。
  • false:不开启阿里云 OS 安全加固。

默认值:false

true
cpu_policystring

节点 CPU 管理策略。当集群版本在 1.12.6 及以上时支持以下两种策略:

  • static:允许为节点上具有某些资源特征 Pod 增强其 CPU 亲和性和独占性。
  • none:表示启用现有的默认 CPU 亲和性方案。

默认值:none

none
runtimestring

容器运行时名称,取值范围:

  • containerd:推荐使用,支持所有集群版本。

默认值:containerd。

containerd
node_port_rangestring

节点服务端口范围。

30000-32767
sizelong

控制面节点数量。如需扩容专有版控制面,该参数为目标控制面节点数,需大于当前控制面节点数量。

5

返回参数

名称类型描述示例值
object

返回数据体。

cluster_idstring

集群 ID。

cb95aa626a47740afbf6aa09****
request_idstring

请求 ID。

687C5BAA-D103-4993-884B-C35E4314****
task_idstring

任务 ID。

T-5a54309c80282e39ea00****

示例

正常返回示例

JSON格式

{
  "cluster_id": "cb95aa626a47740afbf6aa09****",
  "request_id": "687C5BAA-D103-4993-884B-C35E4314****",
  "task_id": "T-5a54309c80282e39ea00****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-11-19API 内部配置变更,不影响调用查看变更详情
2024-10-18API 内部配置变更,不影响调用查看变更详情
2024-04-24API 内部配置变更,不影响调用查看变更详情
2024-01-11API 内部配置变更,不影响调用查看变更详情
2023-10-18API 内部配置变更,不影响调用查看变更详情
2023-10-10API 内部配置变更,不影响调用查看变更详情
2023-08-21API 内部配置变更,不影响调用查看变更详情
2023-08-18API 内部配置变更,不影响调用查看变更详情