最近更新时间:2023.12.21 17:25:43
首次发布时间:2022.06.27 21:21:46
从集群中删除一个或多个节点。
此接口为异步接口,当此接口返回成功时,此时节点将进入{Deleting, [Progressing]}
状态。但接口返回成功不代表节点最终能删除成功。请调用 ListNodes 接口查看节点是否存在,若未查询到,那么节点已删除成功。
调用该 API 时的请求参数如下,除此之外还需传入公共请求参数。公共请求参数说明,请参见 公共参数。
参数名称 | 类型 | 是否必选 | 示例值 | 说明 |
---|---|---|---|---|
Action | String | 是 | DeleteNodes | 公共参数,本接口值:DeleteNodes。 |
Version | String | 是 | 2022-05-12 | 公共参数,本接口值:2022-05-12。 |
ClusterId | String | 是 | cc5silumrsfeq**** | 集群的 ID。 注意 集群必须处于以下任一状态:
|
NodePoolId | String | 是 | pc8oah9cbcv**** | 节点池 ID。 注意 节点池必须处于以下任一状态:
|
Ids | Array of String | 是 | ["nc5t5epmrsf****"] | 节点 ID 列表。 注意
|
CascadingDeleteResources | Array of String | 否 | ["Ecs"] | 注意 参数废弃说明:
同步删除指定节点的关联资源,取值:
说明 在删除过程中,若这些资源开启了删除保护,则无法被删除;未开启删除保护的资源,会被继续删除。建议在调用接口前按需调整删除保护设置。 |
RetainResources | Array of String | 否 | ["Ecs"] | 注意 仅 2023 年 12 月 18 日之后开通并使用容器服务产品的新用户可使用该参数,其余存量用户,必须完成接口改造后才能使用该参数。接口改造说明,请参见 级联删除集群资源相关 OpenAPI 改造说明。 删除节点时,需要保留的节点关联资源,取值:
说明 在删除过程中,若这些资源开启了删除保护,则无法被删除;未开启删除保护的资源,会被继续删除。建议在调用接口前按需调整删除保护设置。 |
POST /?Action=DeleteNodes&Version=2022-05-12 HTTP/1.1 Content-Type:application/json { "ClusterId": "cc5silumrsfeq****", "NodePoolId": "pc8oah9cbcv****", "Ids": ["nc5t5epmrsf****"], "RetainResources": ["Ecs"] }
本接口无专有返回参数,公共返回参数请参见 返回结果。
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "021635330810134****", "Action": "DeleteNodes", "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}}]. | 指定节点池的当前状态不支持该操作。请确认该接口依赖的节点池状态后重试。 |
400 | OperationDenied.NodeStatus | The action has been forbidden due to wrong node status {{statusPhase}} and [{{statusConditions}}]. | 指定节点的当前状态不支持该操作。请确认该接口依赖的节点状态后重试。 |
400 | OperationDenied.NodePoolReplicas | The operation has been denied due to the node pool replicas limit. | 删除节点超过了节点池最小节点数限制。请减少要删除的节点 ID 数量后重试。 |