Remove a specified add-on from a specified cluster.

Usage instructions

Before calling this API, first call the ListSupportedAddons API to query details of the specified add-on.

This API is asynchronous. When this API returns success, the add-on is in the {Deleting, [Progressing]} state. A successful API response does not indicate that the add-on has been uninstalled. You need to call the ListAddons API to check whether the add-on exists in the specified cluster. If it is not found, the add-on has been successfully uninstalled.

Request description

VKE has deployed services in multiple regions globally to provide a stable and low-latency access experience. You can refer to the Service addresses topic and select the most suitable access point for your business region.

Request method: POST

Request URL: https://vke.cn-beijing.volcengineapi.com?Action=DeleteAddon&Version=2022-05-12

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following table contains the request parameters for the API. You also need to provide public parameters when calling this API. See Public parameters for details.

Parameters	Type	Required	Sample value	Description
Action	String	Yes	DeleteAddon	The API name. The name of the current API is DeleteAddon.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
ClusterId	String	Yes	cc5silumrsfeqxxxx	The ID of the cluster to which the add-on to be uninstalled belongs. Cluster IDs can be queried by calling the ListClusters API. Warning The cluster must be in the {Running,[Ok]} or {Updating, [Progressing]} state. You can call the ListClusters API to view the current status of the cluster.
Name	String	Yes	ingress-nginx	The name of the add-on to be uninstalled. You can call the ListAddons API to obtain the add-on name. Warning The add-on must not be in the {Creating, [Progressing]}, {Deleting, [Progressing]}, or {Failed, [ClusterNotRunning]} state. You can call the ListAddons API to obtain the current status of the add-on.
CascadingDeleteResources	Array of String	no	["Crd"]	Warning Parameter deprecation notes: Only existing users can specify this parameter. For the methods of determining existing users, see FAQ. As this parameter will soon be deprecated, existing users can only use this parameter within the specified period of time. Please complete the API update as soon as possible and use the new RetainResources parameter after the update. For API update instructions, see OpenAPI update instructions related to cascading deletion of cluster resources. New users (those who activated VKE after December 18, 2023) should use the RetainResources parameter. Cascading deletion of resources associated with the add-on. Values: An empty value (default) does not perform cascading deletion of related resources. Crd: Synchronously delete the CRD (Custom Resource Definition) resources of the add-on. Cascading deletion is not supported for resources in other external systems, such as Load Balancers associated with Ingresses, as well as log projects and log topics associated with logging add-ons.
RetainResources	Array of String	no	["Crd"]	Warning Existing users must complete API modification before using this parameter. For the methods of determining existing users, see FAQ. New users (those who activated VKE after December 18, 2023) can directly use this parameter. Resources to be retained when deleting the add-on. Values: An empty value (default) deletes all associated resources. Crd: Retains the CRD (Custom Resource Definition) resources when deleting the add-on.

Sample requests

Response parameters

There are no proprietary response parameters for this API. See Response results for details about public response parameters.

Sample responses

Error code

The error codes for this API are listed in the table below. Refer to the Public error codes topic for details.

HTTP status code	Error code	Error message	Description
400	OperationDenied.ClusterStatus	The action has been denied due to wrong cluster status {{statusPhase}} and [{{statusConditions}}].	The current status of the specified cluster does not support this action. Please confirm the required cluster status for this API and try again later.
400	OperationDenied.AddonStatus	The action has been forbidden due to wrong addon status {{statusPhase}} and [{{statusConditions}}].	The current add-on status does not support updating the add-on configuration. Please confirm the required add-on status for this API and try again later.
400	OperationDenied.RequiredAddon	It is forbidden to delete required addon.	This add-on is required by the system and cannot be uninstalled.

Volcengine Kubernetes Engine