Modify a cluster - API Reference| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request syntax

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

Request parameters

Table 1. Request path parameters
Parameter	Type	Required	Example	Description
ClusterId	String	Yes	cb95aa626a47740afbf6aa099b65****	The ID of the cluster.

Table 2. Request body parameters
Parameter	Type	Required	Example	Description
api_server_eip	Boolean	No	true	Specifies whether to associate an elastic IP address (EIP) with the cluster API server. This enables Internet access for the cluster. Valid values: `true`: associates an EIP with the cluster API server. `false`: does not associate an EIP with the cluster API server.
api_server_eip_id	String	No	eip-wz9fnasl6dsfhmvci****	The ID of the EIP that you want to associate with the cluster API server. The parameter takes effect only if `api_server_eip` is set to `true`.
deletion_protection	Boolean	No	true	Specifies whether to enable deletion protection for the cluster. If deletion protection is enabled, the cluster cannot be deleted in the console or by calling the API. Valid values: `true`: enables deletion protection for the cluster. You cannot delete the cluster in the console or by calling the API. `false`: does not enable deletion protection for the cluster. You can delete the cluster in the console or by calling the API Default value: `false`.
instance_deletion_protection	Boolean	No	true	Specifies whether to enable deletion protection for the instances in the cluster. If deletion protection is enabled, the instances in the cluster cannot be deleted in the console or by calling the API. Valid values: `true`: The nodes in the cluster cannot be deleted in the console or by calling API operations. `false`: The nodes in the cluster can be deleted in the console or by calling API operations. Default value: `false`.
ingress_domain_rebinding	String	No	true	Specifies whether to remap the test domain name of the cluster. Valid values: `true`: remaps the test domain name of the cluster. `false`: does not remap the test domain name of the cluster. Default value: `false`.
ingress_loadbalancer_id	String	No	lb-wz97kes8tnndkpodw****	The ID of the Server Load Balancer (SLB) instance that is associated with the cluster.
resource_group_id	String	No	rg-acfmyvw3wjm****	The ID of the resource group to which the cluster belongs.
maintenance_window	maintenance_window	No		The details of the maintenance window of the cluster. This parameter takes effect only in professional Kubernetes clusters.

Response syntax

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

Response parameters

Table 3. Response body parameters
Parameter	Type	Example	Description
cluster_id	String	cb95aa626a47740afbf6aa09****	The ID of the cluster.
request_id	String	687C5BAA-D103-4993-884B-C35E4314****	The ID of the request.
task_id	String	T-5a54309c80282e39ea00****	The ID of the task.

Examples

Sample requests

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

Sample success responses

XML format

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 format

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

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

Error codes

For a list of error codes, visit the API Error Center.