删除指定集群下的节点池。

使用说明

删除接口为异步接口，当此接口返回成功时，此时节点池将进入{Deleting, [Progressing]}状态。接口返回成功不代表节点池删除成功，需要您调用 ListNodePools接口查看节点池是否存在，若未查询到，那么节点池已删除成功。

请求说明

VKE 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://vke.cn-beijing.volcengineapi.com?Action=DeleteNodePool&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	DeleteNodePool	接口名称。当前 API 的名称为 DeleteNodePool。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 2022-05-12。
ClusterId	String	是	cc5silumrsfeqxxxx	节点池所在集群的 ID。可以调用 ListClusters 接口，获取集群 ID。注意待删除节点池所在的集群必须处于以下任一状态： {Running,[*]} {Updating, [Progressing]} {Stopped, [Balance]} 可调用 ListClusters接口获取集群当前的状态。
Id	String	是	pc51i0m6rsfenxxxx	节点池 ID。可以调用 ListNodePools 接口，获取节点池 ID。注意节点池必须处于以下任一状态： {Running,[]} {Failed, []} 可调用 ListNodePools接口获取节点池当前的状态。
CascadingDeleteResources	Array of String	否	["Ecs"]	注意参数废弃说明：仅存量用户支持使用该参数。存量用户判断方法，请参见 FAQ。因该参数即将下线，所以存量用户仅在指定时间内可使用该参数，请尽快完成接口改造后使用新的 RetainResources 参数。接口改造说明，请参见级联删除集群资源相关 OpenAPI 改造说明。产品新用户（2023 年 12 月 18 日之后开通并使用 VKE）请使用 RetainResources参数。同步删除关联的资源，取值：取值为空：（默认值）不删除关联资源。 Ecs：删除节点池中的非包年包月的云服务器（ECS）实例。包年包月的 ECS 实例，仅从节点池中移除，不会被删除。您可以通过云服务器控制台或云服务器 API 查询到该实例，并按需执行后续操作。
RetainResources	Array of String	否	["Ecs"]	注意存量用户必须完成接口改造后，才能使用该参数。存量用户的判断方法，请参见 FAQ。新用户（2023 年 12 月 18 日之后开通并使用 VKE）可直接使用该参数。删除节点池时，需要保留的相关资源，取值：取值为空：（默认值）删除全部关联资源。若节点池内存在包年包月的云服务器（ECS）实例，则该接口仅从节点池中移除 ECS 实例，不会删除。您可以通过云服务器控制台或云服务器 API 查询到该实例，并按需执行后续操作。 Ecs：保留节点池中的 ECS 实例。

请求示例

返回参数

本接口无专有返回参数，公共返回参数请参见返回结果。

返回示例

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
400	OperationDenied.ClusterStatus	The action has been denied due to wrong cluster status {{statusPhase}} and [{{statusConditions}}].	指定集群的当前状态不支持该操作。请确认该接口依赖的集群状态后重试。
400	OperationDenied.NodePoolStatus	The action has been forbidden due to wrong node pool status {{statusPhase}} and [{{statusConditions}}].	指定节点池的当前状态不支持该操作。请确认该接口依赖的节点池状态后重试。
400	OperationDenied.ScheduledInstanceId	The operation has been denied due to the ScheduledInstanceId {{scheduledInstanceId}}.	无法删除节点池，因为存在待交付的弹性预约单。

容器服务