配置删除保护--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

配置删除保护

最近更新时间：2024.07.08 16:21:05首次发布时间：2023.09.22 14:32:09

本接口用于为边缘服务配置删除保护。
您可以通过该接口开启或关闭删除保护功能。删除保护功能可以防止您的边缘服务被误删除，保障数据安全。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	SetCloudServerDeleteProtection	公共参数。该参数表示接口名称。取值：SetCloudServerDeleteProtection。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。

Body

参数	类型	是否必选	示例值	描述
Action	String	是	SetCloudServerDeleteProtection	公共参数。该参数表示接口名称。取值：SetCloudServerDeleteProtection。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
cloud_server_identity	String	是	cloudserver-8bvl8r6xcng****	边缘服务的 ID。您可以通过 ListCloudServers 接口查询边缘服务的 ID。
cloud_server_delete_protection	Boolean	是	false	是否为边缘服务开启删除保护。取值范围： true：开启删除保护。 false：关闭删除保护。

返回参数

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

请求示例

POST https://veenedge.volcengineapi.com/?Action=SetCloudServerDeleteProtection&Version=2021-04-30
&<其他公共参数>
{
  "cloud_server_identity": "cloudserver-28qt4gbvknp****",
  "cloud_server_delete_protection": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202309201936202A279F988FE7ECC4****",
        "Action": "SetCloudServerDeleteProtection",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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