You need to enable JavaScript to run this app.
导航
删除边缘实例
最近更新时间:2024.08.05 11:41:58首次发布时间:2022.02.25 18:58:32

本接口用于根据边缘实例 ID 删除实例。

使用说明

注意事项:
边缘实例删除后将不可恢复,请谨慎操作。删除边缘实例后:

  • 随实例删除的云盘上存储的数据将会被清除且无法恢复。
  • 边缘实例的公网 IP 地址将会被释放。
  • 绑定的弹性公网 IP 将会被解绑。但是,该弹性公网 IP 不会被删除,并会继续产生费用。如果您不再需要使用该弹性公网 IP,可以选择将其删除以节省成本。
  • 关联的外网防火墙将会被解除关联。
  • 边缘实例将从对应的负载均衡实例的后端服务器池中被移除。
  • 关联的高可用虚拟 IP 将会被解绑。
  • 关联的自定义路由条目会被删除。
  • 挂载的弹性网卡会被卸载。

请求说明

  • 请求方式:POST
  • 请求地址:https://veenedge.volcengineapi.com/?Action=OfflineInstances&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数

Query

参数

类型

是否必选

示例值

描述

Action

String

OfflineInstances

公共参数。该参数表示接口名称。取值:OfflineInstances。

Version

String

2021-04-30

公共参数。该参数表示接口版本。取值:2021-04-30。

Body

参数

类型

是否必选

示例值

描述

instance_identities

[]String

["veen1020125208252511****"]

边缘实例 ID 列表。您可以通过 ListInstances 接口查询边缘实例 ID。

ignore_running

Boolean

true

是否启用强制删除。取值:

  • true:是。能够删除已停止(stop)和运行中 (running)的边缘实例。该参数值仅在以下场景中可用:需要删除的所有边缘实例处于已停止(stop)或运行中 (running)状态。
  • false(默认值):否。仅能够删除已停止(stop)的边缘实例。该参数值仅在以下场景中可用:需要删除的所有边缘实例处于已停止(stop)状态。

返回参数

该接口无特有的返回参数。

请求示例

POST https://veenedge.volcengineapi.com/?Action=OfflineInstances&Version=2021-04-30
&<其他公共参数>
{
  "instance_identities": [
    "veen2210222221323202****"
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305311731087FE81440C2833B06****",
        "Action": "OfflineInstances",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码