DeleteCluster - Container Service for Kubernetes - Alibaba Cloud Documentation Center

You can call the DeleteCluster operation to delete a cluster and specify whether to delete or retain the relevant cluster resources. Before you delete a cluster, you must manually delete workloads in the cluster, such as Deployments, StatefulSets, Jobs, and CronJobs. Otherwise, you may fail to delete the cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cs:DeleteCluster	delete	*Cluster `acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}`	none	none

Request syntax

DELETE /clusters/{ClusterId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	c905d1364c2dd4b6284a3f41790c4****
retain_all_resources	boolean	No	Specifies whether to retain all resources. If you set the parameter to `true`, the `retain_resources` parameter is ignored. The cloud resources that are created by the cluster are retained. You can call the `DescribeClusterResources` operation to query cloud resources created by the cluster. If you set the parameter to `false`, resources to be retained by default in the `delete_options` parameter are still retained. To delete these resources, set `delete_mode` to `delete` in `delete_options`. `true`: retains all resources, including cloud resources created by the cluster. `false`: does not retain all resources. Resources to be retained by default in the `delete_options` parameter are retained. For example, `ALB` instances are retained when this parameter is set to `false`. Default value: `false`.	false
keep_slb`deprecated`	boolean	No	Specifies whether to retain the Server Load Balancer (SLB) resources that are created by the cluster. `true`: retains the SLB instances that are created by the cluster. `false`: does not retain the SLB instances that are created by the cluster. Default value: `false`. Set resource_type to `SLB` in the `delete_options` parameter to manage SLB instances.	false
retain_resources	array	No	The list of resources. To retain resources when you delete a cluster, you need to specify the IDs of the resources to be retained.
	string	No	The resource name.	sg-2ze6ess9kho6fdn9****
delete_options	array<object>	No	The type of cluster resource that you want to delete or retain.
	object	No
resource_type	string	No	The type of the resource. Valid values: SLB: SLB resources created for Services. By default, the SLB resources are automatically deleted. ALB: Application Load Balancer (ALB) resources created by the ALB Ingress controller. By default, the ALB resources are retained. SLS_Data: Simple Log Service projects used by the cluster logging feature. By default, the Simple Log Service projects are retained. SLS_ControlPlane: Simple Log Service projects used to store the logs of control planes in ACK managed clusters. By default, the Simple Log Service projects are retained. PrivateZone: PrivateZone resources created by ACK Serverless clusters. By default, the PrivateZone resources are retained.	SLS_Data
delete_mode	string	No	The deletion policy for the specified type of resource. Valid values: delete: deletes the specified type of resource. retain: retains the specified type of resource.	delete

Response parameters

Parameter	Type	Description	Example
	object	The response body.
cluster_id	string	The ID of the cluster.	cb95aa626a47740afbf6aa099b650****
request_id	string	The request ID.	687C5BAA-D103-4993-884B-C35E4314****
task_id	string	The ID of the task.	T-5a54309c80282e39ea****

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-09	The request parameters of the API has changed	View Change Details
2024-01-11	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-25	The response structure of the API has changed	View Change Details
2023-12-21	The response structure of the API has changed	View Change Details
2023-03-22	The response structure of the API has changed	View Change Details