调用ModifyCluster修改集群。

调试

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

请求语法

PUT /api/v2/clusters/ClusterId HTTP/1.1 
Content-Type:application/json
{
  "api_server_eip" : Boolean,
  "api_server_eip_id" : "String",
  "deletion_protection" : Boolean,
  "instance_deletion_protection" : Boolean,
  "ingress_domain_rebinding" : "String",
  "ingress_loadbalancer_id" : "String",
  "resource_group_id" : "String",
  "maintenance_window" : {
    "enable" : Boolean,
    "maintenance_time" : "String",
    "duration" : "String",
    "weekly_period" : "String"
  }
}

请求参数

表 1. 请求Path参数
参数名称 类型 是否必选 示例 说明
ClusterId String cb95aa626a47740afbf6aa099b65****

集群ID。

表 2. 请求Body参数
参数名称 类型 是否必选 示例 说明
api_server_eip Boolean true

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

  • true:集群绑定EIP。
  • false:集群不绑定EIP。
api_server_eip_id String eip-wz9fnasl6dsfhmvci****

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

deletion_protection Boolean true

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

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

默认值:false

instance_deletion_protection Boolean true

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

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

默认值:false

ingress_domain_rebinding String true

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

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

默认值:false

ingress_loadbalancer_id String lb-wz97kes8tnndkpodw****

被修改集群的SLB实例ID。

resource_group_id String rg-acfmyvw3wjm****

集群资源组ID。

maintenance_window maintenance_window

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

响应体语法

HTTP/1.1 200
Content-Type:application/json
{
  "cluster_id" : "String",
  "request_id" : "String",
  "task_id" : "String"
}

响应参数

表 3. 响应Body参数
参数名称 类型 示例 说明
cluster_id String cb95aa626a47740afbf6aa09****

集群ID。

request_id String 687C5BAA-D103-4993-884B-C35E4314****

请求ID。

task_id String T-5a54309c80282e39ea00****

任务ID。

修改ACK集群示例

请求示例

PUT /api/v2/clusters/cb95aa626a47740afbf6aa099b65**** HTTP/1.1 
Content-Type:application/json
{
  "api_server_eip" : true,
  "api_server_eip_id" : "eip-wz9fnasl6dsfhmvci****",
  "deletion_protection" : true,
  "instance_deletion_protection" : true,
  "ingress_domain_rebinding" : "true",
  "ingress_loadbalancer_id" : "lb-wz97kes8tnndkpodw****",
  "resource_group_id" : "rg-acfmyvw3wjm****",
  "maintenance_window" : {
    "enable" : false,
    "maintenance_time" : "03:00:00Z",
    "duration" : "3h",
    "weekly_period" : "Monday,Thursday"
  }
}

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<cluster_id>cb95aa626a47740afbf6aa09****</cluster_id>
<request_id>687C5BAA-D103-4993-884B-C35E4314****</request_id>
<task_id>T-5a54309c80282e39ea00****</task_id>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

开发者资源

  • SDK

    阿里云为您提供多种语言的SDK,帮助您快速通过API集成阿里云的产品和服务,推荐您使用SDK调用API,已免除您手动签名验证,详情请参见SDK参考文档链接。

  • OpenAPI Explorer

    快速检索,可视化调试API,在线命令行工具,同步动态生成可执行的SDK代码示例。

  • 阿里云CLI

    阿里云资产管理和配置工具,可通过命令方式同时管理多个阿里云产品和服务,简单快捷,是您上云好帮手。