You need to enable JavaScript to run this app.
导航
DeleteVirtualNode
最近更新时间:2024.06.21 16:12:58首次发布时间:2023.10.26 16:05:10

删除指定的虚拟节点。

说明

邀测·申请试用】:虚拟节点相关 OpenAPI 功能目前处于 邀测 阶段。如果需要使用,请提交申请。

使用说明

  • 此接口为异步接口,当此接口返回成功时,此时虚拟节点将进入{Deleting, [Progressing]}状态。但接口返回成功不代表节点最终能删除成功。请调用 ListVirtualNodes 接口查看虚拟节点是否存在,若未查询到,那么虚拟节点已删除成功。
  • 仅当虚拟节点上的所有 VCI Pod 被删除后,才能删除虚拟节点。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=DeleteVirtualNode&Version=2022-05-12

请求参数

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

参数名称类型是否必选示例值说明
ActionStringDeleteVirtualNode公共参数,本接口值:DeleteVirtualNode。
VersionString2022-05-12公共参数,本接口值:2022-05-12。

Id

String

vck4gdidlemc3ou******

虚拟节点 ID。
可以调用 ListVirtualNodes 接口,获取虚拟节点 ID。

注意

虚拟节点必须处于以下任一状态:

  • {Running,[*]}
  • {Failed, [*]}

可以调用 ListVirtualNodes 接口,查看虚拟节点的当前状态。

请求示例

POST /?Action=DeleteVirtualNode&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
    "Id": "vck4gdidlemc3ou******"
}

返回参数

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

返回示例

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

错误码

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

HTTP 状态码错误码错误信息描述
400OperationDenied.VirtualNodeStatusThe operation has been denied due to wrong virtual node status {{statusPhase}} and [{{statusConditions}}].指定的虚拟节点当前状态不支持该操作。请确认该接口依赖的虚拟节点状态后重试。
400OperationDenied.ExistingPodInstancesThe operation has been denied because the virtual node still has pod instances.指定的虚拟节点当前还存在 Pod 实例,不支持该操作。请删除相关 Pod 实例后重试。