最近更新时间:2023.12.21 17:25:43
首次发布时间:2022.11.07 19:55:17
从指定集群中卸载指定的组件。
注意
系统必装组件,不支持卸载。
{Deleting, [Progressing]}
状态。接口返回成功不代表组件卸载成功,需要您调用 ListAddons 接口查看指定集群中组件是否存在,若未查询到,那么组件已卸载成功。调用该 API 时的请求参数如下,除此之外还需传入公共请求参数。公共请求参数说明,请参见 公共参数。
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DeleteAddon | 公共参数,本接口值:DeleteAddon。 |
Version | String | 是 | 2022-05-12 | 公共参数,本接口值:2022-05-12。 |
ClusterId | String | 是 | cc5silumrsf****** | 待卸载组件所属集群的 ID。 注意 集群必须处于 |
Name | String | 是 | ingress-nginx | 待卸载组件的名称。 注意 组件必须 不处于 |
CascadingDeleteResources | Array of String | 否 | ["Crd"] | 注意 参数废弃说明:
级联删除组件关联的资源,取值:
|
RetainResources | Array of String | 否 | ["Crd"] | 注意 仅 2023 年 12 月 18 日之后开通并使用容器服务产品的新用户可使用该参数,其余存量用户,必须完成接口改造后才能使用该参数。接口改造说明,请参见 级联删除集群资源相关 OpenAPI 改造说明。 删除组件时,需要保留的相关资源,取值:
|
POST /?Action=DeleteAddon&Version=2022-05-12 HTTP/1.1 Content-Type:application/json { "ClusterId": "cc5silumrsf******", "Name": "ingress-nginx", "RetainResources": ["Crd"] }
本接口无专有返回参数,公共返回参数请参见 返回结果。
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "021635330810134****", "Action": "DeleteAddon", "Version": "2022-05-12", "Service": "vke", "Region": "cn-beijing" }, "Result": {} }
本接口错误码如下表所示,公共错误码请参见 公共错误码。
HTTP 状态码 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | OperationDenied.RequiredAddon | It is forbidden to delete required addon. | 该组件为系统必装组件,禁止卸载。 |
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}}. | 当前组件状态不支持卸载组件。请确认该接口依赖的组件状态后重试。 |