GetGlobalDefaultDeleteOption--容器服务-火山引擎

文档中心

导航

容器服务

GetGlobalDefaultDeleteOption

最近更新时间：2024.09.23 14:30:52首次发布时间：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 改造说明。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	GetGlobalDefaultDeleteOption	接口名称。当前 API 的名称为 `GetGlobalDefaultDeleteOption`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。

请求示例

POST https://open.volcengineapi.com/?Action=GetGlobalDefaultDeleteOption&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{}

返回参数

本接口返回参数如下表所示，公共返回参数请参见返回结果。

参数	类型	示例值	描述
DefaultDeleteAllResources	Boolean	true	集群资源删除 OpenAPI（ DeleteCluster、DeleteNodePool、DeleteNodes、DeleteAddon ）的全局策略： false：代表当前账号调用删除集群资源相关 OpenAPI 时，继续使用旧参数 CascadingDeleteResources，该参数默认值为保留全部集群相关资源，不级联删除。 true：代表当前账号调用删除集群资源相关 OpenAPI 时，使用新参数 RetainResources，该参数默认值为删除全部集群相关资源，避免资源残留产生不必要费用。
LastChangeTime	String	2021-10-27T10:33:30Z	最近一次将 DefaultDeleteAllResources 参数的值从 false 更新为 true 的时间。标准 RFC3339 格式的 UTC+0 时间。

参数

类型

示例值

描述

DefaultDeleteAllResources

Boolean

true

集群资源删除 OpenAPI（ DeleteCluster、DeleteNodePool、DeleteNodes、DeleteAddon ）的全局策略：

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

LastChangeTime

String

2021-10-27T10:33:30Z

最近一次将 DefaultDeleteAllResources 参数的值从 false 更新为 true 的时间。
标准 RFC3339 格式的 UTC+0 时间。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "0216353****",
        "Action": "GetGlobalDefaultDeleteOption",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {
        "DefaultDeleteAllResources": true,
        "LastChangeTime": "2023-12-27T10:33:30Z"
    }
}

错误码

本接口无专有错误码，公共错误码请参见公共错误码。