DeleteNodePool--容器服务-火山引擎

文档中心

导航

容器服务

DeleteNodePool

最近更新时间：2024.09.29 18:50:56首次发布时间：2022.06.27 21:21:41

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

使用说明

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

请求说明

请求方式：POST
请求地址：https://open.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	是	cc5silum********	节点池所在集群的 ID。可以调用 ListClusters 接口，获取集群 ID。注意待删除节点池所在的集群必须处于以下任一状态： `{Running,[*]}` `{Updating, [Progressing]}` `{Stopped, [Balance]}` 可调用 ListClusters 接口获取集群当前的状态。
Id	String	是	pc51i0m6********	节点池 ID。可以调用 ListNodePools 接口，获取节点池 ID。注意节点池必须处于以下任一状态： `{Running,[]}` `{Failed, []}` 可调用 ListNodePools 接口获取节点池当前的状态。
CascadingDeleteResources	Array of String	否	["Ecs"]	注意参数废弃说明：对于 2023 年 12 月 18 日之后开通并使用容器服务产品的用户，不支持使用该参数，请使用 RetainResources 参数。其余存量用户，在指定时间内仍可使用该参数，但因该参数即将下线，故请尽快完成接口改造，使用新的 RetainResources 参数。接口改造说明，请参见级联删除集群资源相关 OpenAPI 改造说明。同步删除关联的资源，取值：取值为空：（默认值）不删除关联资源。 Ecs：删除节点池中的非包年包月的云服务器（ECS）实例。包年包月的 ECS 实例，仅从节点池中移除，不会被删除。您可以通过云服务器控制台或云服务器 API 查询到该实例，并按需执行后续操作。说明在删除过程中，若这些资源开启了删除保护，则无法被删除；未开启删除保护的资源，会被继续删除。建议在调用接口前按需调整删除保护设置。
RetainResources	Array of String	否	["Ecs"]	注意仅 2023 年 12 月 18 日之后开通并使用容器服务产品的新用户可使用该参数，其余存量用户，必须完成接口改造后才能使用该参数。接口改造说明，请参见级联删除集群资源相关 OpenAPI 改造说明。删除节点池时，需要保留的相关资源，取值：取值为空：（默认值）删除全部关联资源。若节点池内存在包年包月的云服务器（ECS）实例，则该接口仅从节点池中移除 ECS 实例，不会删除。您可以通过云服务器控制台或云服务器 API 查询到该实例，并按需执行后续操作。 Ecs：保留节点池中的 ECS 实例。说明在删除过程中，若这些资源开启了删除保护，则无法被删除；未开启删除保护的资源，会被继续删除。建议在调用接口前按需调整删除保护设置。

请求示例

POST https://open.volcengineapi.com/?Action=DeleteNodePool&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
    "ClusterId": "cc5silum********",
    "Id": "pc51i0m6********",
    "RetainResources": ["Ecs"]
}

返回参数

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

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "0216353********",
        "Action": "DeleteNodePool",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

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

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}}].	指定节点池的当前状态不支持该操作。请确认该接口依赖的节点池状态后重试。