Delete a node pool in a specified cluster.

Usage instructions

This is an asynchronous API. When this API returns a success message, the node pool will be in the {Deleting, [Progressing]} state. A returned success message does not mean the node pool has been deleted. You need to call the ListNodePools API to check whether the node pool still exists. If it is not found in the query results, the node pool has been deleted.

Request description

VKE has deployed services in multiple regions globally to provide a stable and low-latency access experience. You can refer to the Service addresses topic and select the most suitable access point for your business region.

Request method: POST

Request URL: https://vke.cn-beijing.volcengineapi.com?Action=DeleteNodePool&Version=2022-05-12

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following table describes the API request parameters. You also need to provide public parameters when calling the API. For details, see Public parameters.

Parameter	Type	Required	Sample value	Description
Action	String	Yes	DeleteNodePool	The API name. The name of the current API is DeleteNodePool.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
ClusterId	String	Yes	cc5silumrsfeqxxxx	The ID of the cluster where the node pool is located. Cluster IDs can be queried by calling the ListClusters API. Warning The cluster where the node pool to be deleted is located must be in one of the following states: {Running,[*]} {Updating, [Progressing]} {Stopped, [Balance]} You can call the ListClusters API to view the current status of the cluster.
Id	String	Yes	pc51i0m6rsfenxxxx	Node pool ID. You can call the ListNodePools API to obtain the node pool ID. Warning The node pool must be in one of the following states: {Running,[]} {Failed, []} You can call the ListNodePools API to obtain the current status of the node pool.
CascadingDeleteResources	Array of String	no	["Ecs"]	Warning Parameter deprecation notes: Only existing users can specify this parameter. For the methods of determining existing users, see FAQ. As this parameter will soon be deprecated, existing users can only use this parameter within the specified period of time. Please complete the API update as soon as possible and use the new RetainResources parameter after the update. For API update instructions, see OpenAPI update instructions related to cascading deletion of cluster resources. New users (those who activated VKE after December 18, 2023) should use the RetainResources parameter. Synchronously delete associated resources. Valid values: This parameter is left empty by default, which indicates that associated resources will not be deleted. Ecs: Delete non-subscription ECS instances in the node pool. Subscription ECS instances are only removed from the node pool and are not deleted. You can query the instances by using the ECS console or ECS API and perform operations on these instances based on your business requirements.
RetainResources	Array of String	no	["Ecs"]	Warning Existing users must complete API modification before using this parameter. For the methods of determining existing users, see FAQ. New users (those who activated VKE after December 18, 2023) can directly use this parameter. The resources to be retained when the node pool is being deleted. Valid values: An empty value (default) deletes all associated resources. If subscription ECS instances exist in the node pool, this API only removes the ECS instances from the node pool and does not delete them. You can query the instances by using the ECS console or ECS API and perform operations on these instances based on your business requirements. Ecs: Retain ECS instances in the node pool.

Parameter	Type	Required	Sample value	Description
Action	String	Yes	DeleteNodePool	The API name. The name of the current API is DeleteNodePool.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
ClusterId	String	Yes	cc5silumrsfeqxxxx	The ID of the cluster where the node pool is located. Cluster IDs can be queried by calling the ListClusters API. Warning The cluster where the node pool to be deleted is located must be in one of the following states: {Running,[*]} {Updating, [Progressing]} {Stopped, [Balance]} You can call the ListClusters API to view the current status of the cluster.
Id	String	Yes	pc51i0m6rsfenxxxx	Node pool ID. You can call the ListNodePools API to obtain the node pool ID. Warning The node pool must be in one of the following states: {Running,[]} {Failed, []} You can call the ListNodePools API to obtain the current status of the node pool.
CascadingDeleteResources	Array of String	no	["Ecs"]	Warning Parameter deprecation notes: Only existing users can specify this parameter. For the methods of determining existing users, see FAQ. As this parameter will soon be deprecated, existing users can only use this parameter within the specified period of time. Please complete the API update as soon as possible and use the new RetainResources parameter after the update. For API update instructions, see OpenAPI update instructions related to cascading deletion of cluster resources. New users (those who activated VKE after December 18, 2023) should use the RetainResources parameter. Synchronously delete associated resources. Valid values: This parameter is left empty by default, which indicates that associated resources will not be deleted. Ecs: Delete non-subscription ECS instances in the node pool. Subscription ECS instances are only removed from the node pool and are not deleted. You can query the instances by using the ECS console or ECS API and perform operations on these instances based on your business requirements.
RetainResources	Array of String	no	["Ecs"]	Warning Existing users must complete API modification before using this parameter. For the methods of determining existing users, see FAQ. New users (those who activated VKE after December 18, 2023) can directly use this parameter. The resources to be retained when the node pool is being deleted. Valid values: An empty value (default) deletes all associated resources. If subscription ECS instances exist in the node pool, this API only removes the ECS instances from the node pool and does not delete them. You can query the instances by using the ECS console or ECS API and perform operations on these instances based on your business requirements. Ecs: Retain ECS instances in the node pool.

Sample requests

Response parameters

There are no proprietary response parameters for this API. See Response results for details about public response parameters.

Sample responses

Error code

The error codes for this API are listed in the table below. Refer to the Public error codes topic.

HTTP status code	Error code	Error message	Description
400	OperationDenied.ClusterStatus	The action has been denied due to wrong cluster status {{statusPhase}} and [{{statusConditions}}].	The current status of the specified cluster does not support this operation. Please confirm the required cluster status for this API and try again.
400	OperationDenied.NodePoolStatus	The action has been forbidden due to wrong node pool status {{statusPhase}} and [{{statusConditions}}].	The current status of the specified node pool does not support this operation. Please confirm the required node pool status for this API and try again.
400	OperationDenied.ScheduledInstanceId	The operation has been denied due to the ScheduledInstanceId {{scheduledInstanceId}}.	The node pool cannot be deleted because an elastic scheduled order to be delivered exists.

Volcengine Kubernetes Engine