删除容器服务集群。

使用说明

此接口为异步接口，当此接口返回成功时，集群进入{Deleting, [Progressing]}状态，集群停止托管计费。此时，不代表集群已成功删除，需要您调用 ListClusters接口查看集群是否存在，若未查询到，那么集群已删除成功。

请求说明

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

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	DeleteCluster	接口名称。当前 API 的名称为 DeleteCluster。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 2022-05-12。
Id	String	是	cc9l74mvqtofjnoj5xxxx	待删除的集群 ID。可以调用 ListClusters 接口，获取集群 ID。注意待删除的集群必须处于以下任一状态： {Running,[]} {Failed, []} {Stopped, [Ok, Balance]} 可调用 ListClusters接口获取集群当前的状态。
Force	Boolean	否	false	强制删除集群，取值： false：（默认值）关闭。 true：开启。取该值时，即使是开启删除保护（DeleteProtection=true）的集群，也可以被强制删除。
CascadingDeleteResources	Array of String	否	["DefaultNodePoolResource", "NodePoolResource", "Clb", "Nat"]	注意参数废弃说明：仅存量用户支持使用该参数。存量用户判断方法，请参见 FAQ。因该参数即将下线，所以存量用户仅在指定时间内可使用该参数，请尽快完成接口改造后使用新的 RetainResources 参数。接口改造说明，请参见级联删除集群资源相关 OpenAPI 改造说明。产品新用户（2023 年 12 月 18 日之后开通并使用 VKE）请使用 RetainResources参数。同步删除指定集群内的相关资源，取值： DefaultNodePoolResource：同步删除集群内默认节点池中的云服务器（ECS）实例。若指定的集群中，默认节点池中存在包年包月的云服务器实例，则该接口仅从集群中移除云服务器实例，不会删除实例。您可以通过云服务器控制台或云服务器 API 查询到该实例，并按需执行后续操作。 NodePoolResource：同步删除集群内的所有自定义节点池、节点池内的云服务器实例及其关联的弹性块存储。不包含存储卷（PV）所对应的存储资源，例如云盘（EBS）、文件存储 NAS、文件存储 vePFS、对象存储（TOS）等资源。 Clb：同步删除集群创建的负载均衡器（CLB）。 Nat：同步删除集群创建的 NAT 网关。 All：同步删除集群内上述所有类型资源，但不包括不包含集群内的包年包月节点、PV 对应的存储资源，日志服务关联的 Topic。
RetainResources	Array of String	否	["Nat"]	注意存量用户必须完成接口改造后，才能使用该参数。存量用户的判断方法，请参见 FAQ。新用户（2023 年 12 月 18 日之后开通并使用 VKE）可直接使用该参数。删除集群时，需要保留的集群内相关资源，取值：取值为空：（默认值）删除集群关联创建的全部资源，及添加到节点池的非包年包月类型 ECS 实例。 DefaultNodePoolResource：保留集群内默认节点池中的 ECS 实例及其关联的弹性块存储、公网 IP 等资源。 NodePoolResource：保留集群内的所有自定义节点池内的 ECS 实例及其关联的弹性块存储、公网 IP 等资源。 Clb：保留集群内路由规则（Ingress）和服务（Service）创建的负载均衡（CLB）实例。 Alb：保留集群内 Ingress 和 Service 创建的应用型负载均衡（ALB）实例。 Nat：保留集群关联创建的 NAT 网关。 SecurityGroup：保留集群关联创建的安全组。 All：保留集群关联创建的所有资源。

请求示例

返回参数

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

返回示例

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	OperationDenied.DeleteProtection	The deletion protection of specified {{resourceType}} is enabled.	删除失败，指定资源开启了删除保护。您可以使用强制删除，也可以取消删除保护后重试。
400	OperationDenied.ClusterStatus	The action has been denied due to wrong cluster status {{statusPhase}} and [{{statusConditions}}].	指定集群的当前状态不支持该操作。请确认该接口依赖的集群状态后重试。