All Products
Search
Document Center

Container Service for Kubernetes:DeleteCluster

Last Updated:Feb 21, 2024

You can call the DeleteCluster operation to delete a cluster by cluster ID and release all nodes in the cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
cs:DeleteClusterWrite
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

DELETE /clusters/{ClusterId}

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The cluster ID.

c905d1364c2dd4b6284a3f41790c4****
retain_all_resourcesbooleanNo

Specifies whether to retain all resources. If you set the parameter to true, the retain_resources parameter is ignored.

  • true: retains all resources.
  • false: does not retain all resources.

Default value: false.

false
keep_slbbooleanNo

Specifies whether to retain the Server Load Balancer (SLB) resources that are created by the cluster.

  • true: retains the SLB resources that are created by the cluster.
  • false: does not retain the SLB resources that are created by the cluster.

Default value: false.

false
retain_resourcesarrayNo

The list of resources. To retain resources when you delete a cluster, you need to specify the IDs of the resources to be retained.

stringNo

The resource name.

sg-2ze6ess9kho6fdn9****

Response parameters

ParameterTypeDescriptionExample
object
task_idstring

The task ID.

T-5a54309c80282e39ea****

Examples

Sample success responses

JSONformat

{
  "task_id": "T-5a54309c80282e39ea****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-01-11The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-12-25The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-12-21The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-03-22The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.