All Products
Search
Document Center

Container Service for Kubernetes:DeleteClusterNodes

Last Updated:Nov 07, 2024

Removes nodes from a Container Service for Kubernetes (ACK) cluster. When you remove nodes, you can specify whether to release the Elastic Compute Service (ECS) instances and drain the nodes. When you remove nodes, pods on the nodes are migrated. This may adversely affect your businesses. We recommend that you back up data and perform this operation during off-peak hours.

Operation description

  • When you remove a node, the pods that run on the node are migrated to other nodes. This may cause service interruptions. We recommend that you remove nodes during off-peak hours.
  • The operation may have unexpected risks. Back up the data before you perform this operation.
  • When the system removes a node, it sets the status of the node to Unschedulable.
  • The system removes only worker nodes. It does not remove master nodes.

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.

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:DeleteClusterNodesdelete
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

POST /clusters/{ClusterId}/nodes HTTP/1.1 DELETE /clusters/{ClusterId}/nodes HTTP/1.1

POST /clusters/{ClusterId}/nodes HTTP/1.1 DELETE /clusters/{ClusterId}/nodes HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The cluster ID.

c850429a2287b4d968e27e87a4921****
bodyobjectNo

The request body.

drain_nodebooleanNo

Specifies whether to remove all pods from the nodes that you want to remove. Valid values:

  • true: removes all pods from the nodes that you want to remove.
  • false: does not remove pods from the nodes that you want to remove.

Default value: false.

true
release_nodebooleanNo

Specifies whether to release the Elastic Compute Service (ECS) instances. Valid values:

  • true: releases the ECS instances.
  • false: does not release the ECS instances.

Default value: false.

Note You cannot release subscription ECS instances.
true
nodesarrayYes

The list of nodes to be removed. You need to specify the name of the nodes used in the cluster, for example, cn-hangzhou.192.168.0.70.

stringNo

The node name.

cn-chengdu.192.168.0.70

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

cluster_idstring

The cluster ID.

c104d5d5f301c4e2a8ee578c37bc****
request_idstring

The request ID.

A9891419-D125-4D89-AFCA-68846675E2F7
task_idstring

The task ID.

T-60fea8ad2e277f0879000ae9

Examples

Sample success responses

JSONformat

{
  "cluster_id": "c104d5d5f301c4e2a8ee578c37bc****",
  "request_id": "A9891419-D125-4D89-AFCA-68846675E2F7",
  "task_id": "T-60fea8ad2e277f0879000ae9"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history