View the details of add-ons that are supported by VKE.

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=ListSupportedAddons&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	ListSupportedAddons	The API name. The name of the current API is ListSupportedAddons.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
Filter	Object of ListSupportedAddonsFilter	no	-	Filters for querying add-ons.

ListSupportedAddonsFilter

Parameters	Type	Required	Sample value	Description
Name	String	no	ingress-nginx	The name of the add-on to be queried.
PodNetworkModes	Array of String	no	["Flannel"]	Pod network models (CNI) supported by the add-on. Values: Flannel: an independent underlay network solution, based on which a high-performance network for clusters can be built along with the global routing capabilities of VPCs. VPC-CNI: an underlay network solution implemented based on the ENIs of VPCs, providing high network performance.
DeployModes	Array of String	no	["Managed"]	Supported deployment modes. Values: Unmanaged: Obtain add-ons deployed in unmanaged mode. Managed: Obtain add-ons deployed in managed mode. An empty value indicates that add-ons with all supported deployment modes are returned.
DeployNodeTypes	Array of String	no	["Node"]	Deployment node type. This parameter is required only when DeployMode is set to Unmanaged. Valid values: Node: Obtain add-ons with node (ECS) as their deployment node type. VirtualNode: Obtain add-ons with virtual node (VCI) as their deployment node type. An empty value indicates that add-ons with all supported deployment node types are returned.
Necessaries	Array of String	no	["Required"]	The installation necessity level of the add-on. Values: Required: Required Recommended: Recommended OnDemand: Optional
Categories	Array of String	no	["Storage"]	Add-on categories. Values: Storage: Storage Network: Network Monitor: Monitoring Scheduler: Scheduling Dns: DNS Security: Security Gpu: GPU Image: Image
Versions.Compatibilities.KubernetesVersions	Array of String	no	["v1.20.4"]	Kubernetes versions supported by the add-on. For a list of Kubernetes versions in VKE, see Kubernetes version release history.

Sample requests

Response parameters

The following table contains the response parameters of this API. See Response results for details about public response parameters.

Parameter	Type	Sample value	Description
Items	Array of SupportedAddon	[]	Details of add-ons supported by VKE.
TotalCount	Integer	10	Total number of add-ons that VKE supports.

SupportedAddon

Parameters	Type	Sample value	Description
Name	String	ingress-nginx	The name of the add-on.
Versions	Array of AddonVersion	[{"Versoin":"v1.0.0","CompatibleVersions":["v0.9.0"]}]	Supported versions of the add-on.
PodNetworkModes	Array of String	["Flannel"]	The network model (CNI) of the pods. Values: Flannel: Flannel, an independent Underlay container network model. VpcCniShared: VPC-CNI, an Underlay container network model implemented based on the ENI of private networks.
DeployMode	String	Unmanaged	The add-on deployment mode. Values: Unmanaged: Unmanaged mode. Managed: Managed mode.
DeployNodeTypes	Array of String	["Node"]	Deployment node type. Values: Node: The deployment node type is nodes (ECS). VirtualNode: The deployment node type is virtual nodes (VCI). This parameter is returned only when DeployModes is set to Unmanaged.
Necessary	String	Required	The installation necessity level of the add-on. Parameter values: Required: Required Recommended: Recommended OnDemand: Optional
Categories	Array of String	["Storage"]	Add-on categories. Values: Network: Network Monitor: Monitoring Scheduler: Scheduling Dns: DNS Security: Security Gpu: GPU Image: Image If an empty array is returned, the add-on does not have a defined category.

AddonVersion

Parameter	Type	Sample value	Description
Version	String	v0.44.0	The version of the add-on.
CompatibleVersions	Array of String	["v0.42.0", "v0.43.0"]	A list of lower versions that can be upgraded to the current version.

Sample responses

Error code

There are no error codes proprietary to this API. See Public error codes for details about public error codes.

Volcengine Kubernetes Engine