You need to enable JavaScript to run this app.
导航
SetGlobalDefaultDeleteOption
最近更新时间:2024.06.21 16:12:58首次发布时间:2023.12.19 10:59:28

设置删除集群资源相关 OpenAPI 的全局策略。

使用说明

  • 仅如下时间之前已经开通了容器服务产品的 存量用户 可调用该接口,改造旧的删除集群资源相关 OpenAPI(DeleteCluster、DeleteNodePool、DeleteNodes、DeleteAddon),适配新的删除集群资源相关 OpenAPI:
    • 华北 2(北京):2023 年 12 月 18 号
    • 华南 1(广州):2023 年 12 月 18 号
    • 华东 2(上海):2023 年 12 月 20 号

    注意

    调用该接口前,请先完成 OpenAPI 改造的前期工作。详细信息,请参见 级联删除集群资源相关 OpenAPI 改造说明

  • 设置全局策略前,请升级您所使用的 SDK 和 Terraform 至最新版本,并且确保在各个地域完成适配。详细的文档说明,请参见 SDK 参考通过 Terraform 使用容器服务

请求说明

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

请求参数

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

参数名称类型是否必选示例值描述
ActionStringSetGlobalDefaultDeleteOption公共参数,本接口值:SetGlobalDefaultDeleteOption。
VersionString2022-05-12公共参数,本接口值:2022-05-12。

DefaultDeleteAllResources

Boolean

true

设置删除集群资源相关 OpenAPI(DeleteClusterDeleteNodePoolDeleteNodesDeleteAddon)的全局策略,将 OpenAPI 的默认行为调整为同步删除相关资源,避免资源残留:

  • false:初始值,代表调用删除集群资源相关 OpenAPI 时,继续使用旧参数 CascadingDeleteResources,该参数默认值为保留全部集群相关资源,不级联删除。
  • true:代表调用删除集群资源相关 OpenAPI 时,使用新参数 RetainResources,该参数默认值为删除全部集群相关资源,避免资源残留产生不必要费用。

注意

为当前参数赋值 true 后,在 30 日内未进行二次变更,即认为已经认可新的参数配置策略。后续上述 OpenAPI 调用中将只允许传入 RetainResources 参数来指定删除时所需要保留的资源。

请求示例

POST /?Action=SetGlobalDefaultDeleteOption&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
    "DefaultDeleteAllResources": true
}

返回参数

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

返回示例

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

错误码

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

HTTP 状态码错误码错误信息描述
400UpdateNotAllowed.DefaultDeleteAllResourcesThe update to the specified parameter DefaultDeleteAllResources is not allowed due to overtime.由于超时不允许更新 DefaultDeleteAllResources 参数,请稍后重试。重试多次若仍然报错,请 提交工单 获取技术支持。