调用ModifyCluster修改集群-阿里云帮助中心

调试

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

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称	类型	位置	是否必选	示例值	描述
ClusterId	String	Path	是	cb95aa626a47740afbf6aa099b65****	集群ID。
	Object	Body	否		请求体参数。
api_server_eip	Boolean	Body	否	true	集群是否绑定EIP，用于公网访问API Server。取值： `true`：集群绑定EIP。 `false`：集群不绑定EIP。
api_server_eip_id	String	Body	否	eip-wz9fnasl6dsfhmvci****	集群API Server绑定的EIP实例ID，仅当`api_server_eip`取值为`true`时生效。
deletion_protection	Boolean	Body	否	true	集群删除保护，防止通过控制台或API误删除集群。取值： `true`：启用集群删除保护，将不能通过控制台或API删除集群。 `false`：不启用集群删除保护，则能通过控制台或API删除集群。默认值：`false`。
instance_deletion_protection	Boolean	Body	否	true	实例删除保护，防止通过控制台或API误删除释放节点。取值： `true`: 不能通过控制台或API误删除集群。 `false`：能通过控制台或API误删除集群。默认值：`false`。
ingress_domain_rebinding	Boolean	Body	否	true	重新绑定集群测试域名。取值： `true`：重新绑定集群测试域名。 `false`：不重新绑定集群测试域名。默认值：`false`。
ingress_loadbalancer_id	String	Body	否	lb-wz97kes8tnndkpodw****	被修改集群的SLB实例ID。
resource_group_id	String	Body	否	rg-acfmyvw3wjm****	集群资源组ID。
maintenance_window	maintenance_window	Body	否		集群维护窗口，该功能只在Pro托管版集群中生效。
enable_rrsa	Boolean	Body	否	true	启用或禁用RRSA功能。取值： `true`：启用。 `false`：禁用。
access_control_list	Array of String	Body	否	192.168.1.0/24	注册集群 API Server SLB 访问控制列表。注意：不允许填写0.0.0.0/0网段。
cluster_name	String	Body	否	cluster-new-name	集群名称。命名规则：由数字、汉字、英文字符或短划线（-）组成，长度范围1~63个字符，且不能以短划线（-）开头。

返回数据

名称	类型	示例值	描述
cluster_id	String	cb95aa626a47740afbf6aa09****	集群ID。
request_id	String	687C5BAA-D103-4993-884B-C35E4314****	请求ID。
task_id	String	T-5a54309c80282e39ea00****	任务ID。

示例

请求示例

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****"
}

错误码

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