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

文档中心

立即注册

导航

容器服务

DeleteAddon

最近更新时间：2024.09.23 14:30:51首次发布时间：2022.11.07 19:55:17

从指定集群中卸载指定的组件。

使用说明

调用该接口前，请先调用 ListSupportedAddons 接口，获取您指定组件的详细信息。
注意
系统必装组件，不支持卸载。
此接口为异步接口，当此接口返回成功时，组件将进入{Deleting, [Progressing]}状态。接口返回成功不代表组件卸载成功，需要您调用 ListAddons 接口查看指定集群中组件是否存在，若未查询到，那么组件已卸载成功。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	DeleteAddon	接口名称。当前 API 的名称为 `DeleteAddon`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
ClusterId	String	是	cc5silum****	待卸载组件所属集群的 ID。可以调用 ListClusters 接口，获取集群 ID。注意集群必须处于`{Running,[Ok]}`或`{Updating, [Progressing]}`状态。可调用 ListClusters 接口获取集群当前的状态。
Name	String	是	ingress-nginx	待卸载组件的名称。可以调用 ListAddons 接口获取组件名称。注意组件必须不处于`{Creating, [Progressing]}`、`{Deleting, [Progressing]}`或者`{Failed, [ClusterNotRunning]}`状态。可调用 ListAddons 接口获取组件当前状态。
CascadingDeleteResources	Array of String	否	["Crd"]	注意参数废弃说明：对于 2023 年 12 月 18 日之后开通并使用容器服务产品的用户，不支持使用该参数，请使用 RetainResources 参数。其余存量用户，在指定时间内仍可使用该参数，但因该参数即将下线，故请尽快完成接口改造，使用新的 RetainResources 参数。接口改造说明，请参见级联删除集群资源相关 OpenAPI 改造说明。级联删除组件关联的资源，取值：取值为空：（默认值）不级联删除相关资源。 Crd: 同步删除组件的 CRD（Custom Resource Definition）资源。其他外部系统的资源不支持级联删除，例如 Ingress 关联的负载均衡器、日志组件关联的日志项目（Project）和日志主题（Topic）等。
RetainResources	Array of String	否	["Crd"]	注意仅 2023 年 12 月 18 日之后开通并使用容器服务产品的新用户可使用该参数，其余存量用户，必须完成接口改造后才能使用该参数。接口改造说明，请参见级联删除集群资源相关 OpenAPI 改造说明。删除组件时，需要保留的相关资源，取值：取值为空：（默认值）删除全部关联资源。注意其他外部系统的资源不支持级联删除，例如 Ingress 关联的负载均衡器、日志组件关联的日志项目（Project）和日志主题（Topic）等。 Crd：删除组件时保留组件的 CRD（Custom Resource Definition）资源。

请求示例

POST https://open.volcengineapi.com/?Action=DeleteAddon&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
        "ClusterId": "cc5si****",
        "Name": "ingress-nginx",
        "RetainResources": ["Crd"]
}

返回参数

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

返回示例

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

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	OperationDenied.ClusterStatus	The action has been denied due to wrong cluster status {{statusPhase}} and [{{statusConditions}}].	指定集群的当前状态不支持该操作。请确认该接口依赖的集群状态后重试。
400	OperationDenied.AddonStatus	The action has been forbidden due to wrong addon status {{statusPhase}} and [{{statusConditions}}].	当前组件状态不支持更新组件配置。请确认该接口依赖的组件状态后重试。
400	OperationDenied.RequiredAddon	It is forbidden to delete required addon.	该组件为系统必装组件，禁止卸载。