创建ACK集群后,如需修改集群的配置,您可以调用ModifyCluster接口来完成。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cs:ModifyCluster | update | *Cluster acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId} |
| 无 |
请求语法
PUT /api/v2/clusters/{ClusterId} HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClusterId | string | 是 | 集群 ID。 | cb95aa626a47740afbf6aa099b65**** |
body | object | 否 | 请求体参数。 | |
api_server_eip | boolean | 否 | 集群是否绑定 EIP,用于公网访问 API Server。取值:
| true |
api_server_eip_id | string | 否 | 集群 API Server 绑定的 EIP 实例 ID,仅当 | eip-wz9fnasl6dsfhmvci**** |
deletion_protection | boolean | 否 | 集群删除保护,防止通过控制台或 API 误删除集群。取值:
默认值: | true |
instance_deletion_protection | boolean | 否 | 实例删除保护,防止通过控制台或 API 误删除释放节点。取值:
默认值: | true |
ingress_domain_rebinding | boolean | 否 | 重新绑定集群测试域名。取值:
默认值: | true |
ingress_loadbalancer_id | string | 否 | 被修改集群的 SLB 实例 ID。 | lb-wz97kes8tnndkpodw**** |
resource_group_id | string | 否 | 集群资源组 ID。 | rg-acfmyvw3wjm**** |
maintenance_window | maintenance_window | 否 | 集群维护窗口,该功能只在 Pro 托管版集群中生效。 | |
enable_rrsa | boolean | 否 | 启用或禁用 RRSA 功能(只有托管版集群支持配置该参数)。取值:
| true |
access_control_list | array | 否 | 注册集群 API Server SLB 访问控制列表。 | |
string | 否 | 注册集群 API Server SLB 访问控制列表。 注意:不允许填写 0.0.0.0/0 网段。 | 192.168.1.0/24 | |
cluster_name | string | 否 | 集群名称。 命名规则:由数字、汉字、英文字符或短划线(-)组成,长度范围 1~63 个字符,且不能以短划线(-)开头。 | cluster-new-name |
system_events_logging | object | 否 | 系统事件存储配置。 | |
enabled | boolean | 否 | 是否开启系统事件存储。 | true |
logging_project | string | 否 | 系统事件存储的 LogProject 名称。 | k8s-log-cb95aa626a47740afbf6aa099b65**** |
operation_policy | object | 否 | 集群自动运维策略。 | |
cluster_auto_upgrade | object | 否 | 集群自动升级。 | |
enabled | boolean | 否 | 是否开启集群自动升级。 | true |
channel | string | 否 | patch | |
api_server_custom_cert_sans | object | 否 | 自定义 API Server 证书 SAN(只有托管版集群支持配置该参数)。 | |
action | string | 否 | 覆盖或追加 SAN 配置。取值:
| append |
subject_alternative_names | array | 否 | SAN 列表。 | |
string | 否 | SAN。 | 192.168.0.119 | |
vswitch_ids | array | 否 | 集群控制面虚拟交换机。适用于托管类集群变更控制面虚拟交换机,请注意以下事项:
| |
string | 否 | 集群控制面虚拟交换机。 | vsw-2ze4jvvvade1yk899**** | |
control_plane_config | object | 否 | 专有版集群控制面配置。 | |
charge_type | string | 否 | 控制面节点实例付费类型,取值:
默认值: | PrePaid |
period | long | 否 | 控制面节点实例包年包月时长,当 当 | 1 |
period_unit | string | 否 | 控制面节点实例付费周期,当
| Month |
auto_renew | boolean | 否 | 控制面节点实例是否开启自动续费,当
默认值: | true |
auto_renew_period | long | 否 | 控制面节点实例单次自动续费的续费时长。 取值范围:{1, 2, 3, 6, 12}。 默认值:1。 | 1 |
instance_types | array | 否 | 实例规格。更多信息,请参见实例规格族。 | |
string | 否 | 实例规格。 | ecs.g6.large | |
image_type | string | 否 | 操作系统镜像类型,取值范围:
| AliyunLinux3 |
image_id | string | 否 | 自定义镜像 ID。自定义镜像时指定。 | aliyun_3_x64_20G_alibase_20240819.vhd |
key_pair | string | 否 | 密钥对名称,和 | ack |
login_password | string | 否 | SSH 登录密码,和 | Ack@2000. |
system_disk_category | string | 否 | 节点系统盘类型,取值:
| cloud_essd |
system_disk_size | long | 否 | 节点系统盘类型,取值范围[40,500],单位:GiB。 | 120 |
system_disk_snapshot_policy_id | string | 否 | 节点系统盘采用的自动快照策略 ID。 | sp-2zej1nogjvovnz4z**** |
system_disk_performance_level | string | 否 | 节点系统盘磁盘性能等级, 仅对 ESSD 磁盘生效。磁盘性能等级和磁盘大小有关。更多信息,请参见 ESSD 云盘 | PL1 |
system_disk_provisioned_iops | long | 否 | 节点系统盘预配置的读写 IOPS。可能值:0~min{50,000, 1000*容量-基准性能}。 基准性能=min{1,800+50*容量, 50000}。 当 | 1000 |
system_disk_bursting_enabled | boolean | 否 | 节点系统盘是否开启 Burst(性能突发)。 取值:
当 | true |
deploymentset_id | string | 否 | 部署集 ID。 | ds-bp10b35imuam5amw**** |
cloud_monitor_flags | boolean | 否 | 控制面节点是否安装云监控插件。取值:
| true |
soc_enabled | boolean | 否 | false | |
security_hardening_os | boolean | 否 | 阿里云 OS 安全加固。取值:
默认值: | true |
cpu_policy | string | 否 | 节点 CPU 管理策略。当集群版本在 1.12.6 及以上时支持以下两种策略:
默认值: | none |
runtime | string | 否 | 容器运行时名称,取值范围:
默认值:containerd。 | containerd |
node_port_range | string | 否 | 节点服务端口范围。 | 30000-32767 |
size | long | 否 | 控制面节点数量。如需扩容专有版控制面,该参数为目标控制面节点数,需大于当前控制面节点数量。 | 5 |
返回参数
示例
正常返回示例
JSON
格式
{
"cluster_id": "cb95aa626a47740afbf6aa09****",
"request_id": "687C5BAA-D103-4993-884B-C35E4314****",
"task_id": "T-5a54309c80282e39ea00****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-11-19 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-10-18 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-04-24 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-01-11 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-10-18 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-10-10 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-08-21 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-08-18 | API 内部配置变更,不影响调用 | 查看变更详情 |