Call the RemoveNodePoolNodes API to remove nodes from a node pool - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Operation description

When you remove a node, the pods 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.
Nodes remain in the Unschedulable state when they are being removed.
The system removes only worker nodes. It does not remove master nodes.
Even if you set the release_node parameter to true, subscription nodes are not released. You must release the subscription nodes in the ECS console after you remove the nodes.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cs:RemoveNodePoolNodes

update

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Request syntax

DELETE /clusters/{ClusterId}/nodepools/{NodepoolId}/nodes HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster.	c23421cfa74454bc8b37163fd19af****
NodepoolId	string	Yes	The node pool ID.	np97de2cfb1ba042398dd8f5504c94****

Request parameters

Parameter	Type	Required	Description	Example
release_node	boolean	No	Specifies whether to release the nodes after they are removed. Valid values: true: release the nodes after they are removed. false: do not release the nodes after they are removed.	true
drain_node	boolean	No	Specifies whether to drain the nodes that you want to remove. Valid values: true: drain the nodes that you want to remove. false: do not drain the nodes that you want to remove.	true
nodes `deprecated`	array	No	This parameter is deprecated. A list of nodes that you want to remove. Note This parameter is deprecated. Use instance_ids instead.
	string	No	The node name.	cn-hangzhou.172.16.xxx.xxx
instance_ids	array	No	A list of instances that you want to remove.
	string	No	The ID of the instance that you want to remove.	i-bp1c70fqbv1nlu9xxxxx
concurrency	boolean	No	Whether to remove concurrently.	false

Response elements

Element	Type	Description	Example
	object	The response body.
request_id	string	The request ID.	A9891419-D125-4D89-AFCA-68846675****
task_id	string	The task ID.	T-62a944794ee141074400****

Examples

Success response

JSON format

{
  "request_id": "A9891419-D125-4D89-AFCA-68846675****",
  "task_id": "T-62a944794ee141074400****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.