Query the details of installed add-ons that meet the criteria.

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=ListAddons&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	ListAddons	The API name. The name of the current API is ListAddons.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
Filter	Object of ListAddonsFilter	no	-	Filters for the add-ons to be queried.
PageNumber	Integer	no	1	The starting page number when querying. The default number is 1.
PageSize	Integer	no	10	The number of results per page: Minimum value: 1 Maximum value: 100 Default value: 10

ListAddonsFilter

Parameters	Type	Required	Sample value	Description
ClusterIds	Array of String	no	["cc5silumrsfeq****"]	A list of cluster IDs. Cluster IDs can be fetched by calling ListClusters API. Up to 100 cluster IDs can be included in a single query. tip If this parameter is an empty array, filtering is performed based on all clusters in the specified region within the account.
Names	Array of String	no	["ingress-nginx"]	A list of add-on names. You can call the ListSupportedAddons API to obtain the cluster add-on names. A maximum of 100 add-on names can be specified in a single request. tip If this parameter is an empty array, filtering will be performed on all add-ons in the specified cluster.
DeployModes	Array of String	no	["Unmanaged"]	Supported deployment modes. Values: Unmanaged: Query add-ons deployed in unmanaged mode. Managed: Query 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	["VirtualNode"]	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.
Statuses	Array of AddonStatusFilter	no	[{"Phase":"Running","Conditions.Type":"Ok"}]	Add-on status. Up to 15 array elements can be provided at a time. The logic OR is applied to represent relations among multiple statuses.
CreateClientToken	String	no	ed6b1190-dc17-11ec-9519-eb58a7******	The ClientToken generated upon successful creation. The ClientToken is a string that ensures request idempotency. This string is provided by the caller.
UpdateClientToken	String	no	BC028527-33B9-4990-A633-54A859******	Filter by update idempotency token for precise querying. The ClientToken generated for the last successful update. The ClientToken is a string that ensures request idempotency. This string is provided by the caller.

AddonStatusFilter

Parameters	Type	Required	Sample value	Description
Phase	String	no	Running	Add-on status. Values: Running Failed Creating Deleting Updating Warning At least one of Phase and Conditions.Type must be provided. Otherwise, it is an invalid array element. For valid combinations of Phase and Conditions.Type, see Resources status description.
Conditions.Type	String	no	Ok	The condition under which the add-on enters the primary status. You can specify multiple conditions. Valid values: Unknown ClusterNotRunning CrashLoopBackOff ImagePullBackOff SchedulingFailed NameConflict ResourceCleanupFailed ClusterVersionUpgrading Ok Degraded Progressing Warning At least one of Phase and Conditions.Type must be provided. Otherwise, it is an invalid array element. For valid combinations of Phase and Conditions.Type, see Resources status description.

Sample requests

Response parameters

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

Parameters	Type	Sample value	Description
Items	Array of Addon	-	A list of add-ons.
PageNumber	Integer	1	The current page number.
PageSize	Integer	10	The number of add-ons displayed per page.
TotalCount	Integer	100	Total number of items in the returned data list.

Add-on

Parameters	Type	Sample value	Description
ClusterId	String	cc5sil****	The ID of the cluster where the add-on belongs.
Name	String	ingress-nginx	The name of the add-on.
Version	String	v0.44.0	The version of the add-on.
DeployMode	String	Unmanaged	The add-on deployment mode. Values: Unmanaged: Deployed in unmanaged mode. Managed: Deployed in managed mode.
DeployNodeType	String	VirtualNode	Deployment node type. Values: Node: Deployed using the node type. VirtualNode: Deployed using the virtual node type. This parameter is returned only when DeployMode is set to Unmanaged.
Config	String		Add-on configuration. For parameter details, see Add-on configuration information.
CreateTime	String	2021-10-27T10:33:30Z	The time when the add-on was installed. UTC+0 time in standard RFC3339 format.
UpdateTime	String	2021-10-29T10:33:30Z	The time when the add-on was updated. UTC+0 time in standard RFC3339 format.
Status	Object of AddonStatus		Add-on status.
CreateClientToken	String	ed6b1190-dc17-11ec-9519-eb58a7******	The ClientToken generated upon successful creation.
UpdateClientToken	String	BC028527-33B9-4990-A633-54A859******	The ClientToken generated for the last successful update.

AddonStatus

Parameters	Type	Sample value	Description
Phase	String	Running	Add-on status. Values: Running Failed Creating Deleting Updating tip For valid combinations of Phase and Conditions.Type, see Resources status description.
Conditions	Array of AddonCondition	["Type":"Ok"]	Conditions under which the add-on enters the primary status. tip For valid combinations of Phase and Conditions.Type, see Resources status description.

AddonCondition

Parameter	Type	Sample value	Description
Type	String	Ok	The condition under which the add-on enters the primary status. You can specify multiple conditions. Valid values: Progressing ClusterVersionUpgrading Unknown Degraded NameConflict ClusterNotRunning CrashLoopBackOff SchedulingFailed ResourceCleanupFailed

Sample responses

Error code

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

Volcengine Kubernetes Engine