Update the version of a specified add-on in a specified cluster.

Usage instructions

Before calling this API, first call the ListSupportedAddons API to obtain the values of parameters (such as Version) for the specified add-on. This helps reduce update failures.

This API is asynchronous. When the API call returns success, the add-on is in the {Updating, [Progressing]} state until the update is executed successfully and the add-on enters the {Running, [Ok]} state. Call the ListAddons API to obtain the current status of the add-on and view whether the add-on version has been updated successfully.

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=UpdateAddonVersion&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	UpdateAddonVersion	The API name. The name of the current API is UpdateAddonVersion.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
ClusterId	String	Yes	cc5silum****	The ID of the cluster to which the add-on to be updated belongs. Cluster IDs can be fetched 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 obtain the current status of the cluster.
Name	String	Yes	ingress-nginx	The name of the add-on to be updated. You can call the ListAddons API to obtain the add-on name. Warning The add-on must be in the {Running, [*]} state. You can call the ListAddons API to obtain the current status of the add-on.
Version	String	Yes	v0.44.0	The target version (the version to which the add-on will be updated). You can call the ListSupportedAddons API to obtain the available target versions.
ClientToken	String	no	BC028527-33B9-4990-A633-84E9F9******	A string used to ensure the idempotency of the request. This string is passed in by the caller and must be unique across different requests. ClientToken is case-sensitive and can consist of 64 ASCII characters at most.

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 an add-on update. Please confirm the required add-on status for this API and try again later.
400	OperationDenied.GracefulUpgrade	The addon does not support graceful upgrade from the current version to the target version.	The add-on does not support graceful upgrade from the current version to the target version. Please call the ListSupportedAddons API to obtain the available target versions of the add-on and upgrade sequentially.
400	NotSupported.{{parameter}}	The specified {{resourceType}} {{resourceContent}} is not supported.	The specified add-on does not support upgrading. Please call the ListSupportedAddons API to confirm the list of supported add-ons and try again later.

Volcengine Kubernetes Engine