You need to enable JavaScript to run this app.
导航
边缘计算节点
  • 文档首页
    • /
  • 边缘计算节点

删除边缘实例

最近更新时间：2023.07.03 16:32:40

首次发布时间：2022.02.25 18:58:32

我的收藏

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

接口说明

边缘实例删除后将不可恢复，请谨慎操作。删除边缘实例后：

  • 边缘实例上存储的数据将会被清除。
  • 边缘实例的公网 IP 地址将会被释放。
  • 绑定的弹性公网 IP 将会被解绑。
  • 关联的外网防火墙将会被解除关联。
  • 边缘实例将从对应的负载均衡实例的后端服务器池中被移除。

请求方法

POST

请求参数

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

名称

类型

是否必选

示例值

描述

Action

String

是

OfflineInstances

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

Version

String

是

2021-04-30

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

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 请求失败。关于错误码的更多信息，参见错误码。