文档

ModifyCluster - 修改集群配置

更新时间:

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

调试

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

授权信息

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

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

请求语法

PUT /api/v2/clusters/{ClusterId}

请求参数

名称类型必填描述示例值
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

返回参数

名称类型描述示例值
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-04-24API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2024-01-11API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-10-18API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-10-10API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-21API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-18API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)