本接口用于根据边缘实例 ID 删除实例。
注意事项:
边缘实例删除后将不可恢复,请谨慎操作。删除边缘实例后:
下表列出了接口特定的请求参数以及公共请求参数 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 | 是否启用强制删除。取值:
|
该接口无特有的返回参数。
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 请求失败。关于错误码的更多信息,参见错误码。