You need to enable JavaScript to run this app.
导航

UpdateAddonVersion

最近更新时间2023.04.07 18:02:09

首次发布时间2022.11.07 19:55:17

更新指定集群下的指定组件版本。

使用说明

  • 调用该接口前,请先调用 ListSupportedAddons 接口,获取您指定组件的版本(Version)等参数值,以减少不必要的更新失败。
  • 此接口为异步接口,当此接口返回成功时,组件将进入{Updating, [Progressing]}状态,直到更新执行成功,进入{Running, [Ok]}状态。请调用 ListAddons 接口获取该组件当前的状态,查看组件版本是否更新成功。

请求参数

调用该 API 时的请求参数如下,除此之外还需传入公共请求参数。公共请求参数说明,请参见 公共参数

参数名称类型是否必选示例值描述
ActionStringUpdateAddonVersion公共参数,本接口值:UpdateAddonVersion。
VersionString2022-05-12公共参数,本接口值:2022-05-12。

ClusterId

String

cc5silumrsf******

待更新组件所属集群的 ID。
可以调用 ListClusters 接口,获取集群 ID。

注意

集群必须处于{Running,[Ok]}{Updating, [Progressing]}状态。可调用 ListClusters 接口获取集群当前的状态。

Name

String

ingress-nginx

待更新组件的名称。
可以调用 ListAddons 接口获取组件名称。

注意

组件必须处于{Running, [*]}状态。可调用 ListAddons 接口获取组件当前状态。

Version

String

v0.44.0

目标组件版本,即将组件更新到该版本。
可以调用 ListSupportedAddons 接口,获取组件的可升级版本。

ClientTokenStringBC028527-33B9-4990-A633-84E9F9******用于保证请求幂等性的字符串。该字符串由调用方传入,需保证不同请求之间唯一。ClientToken 对大小写敏感,且最大值不超过 64 个 ASCII 字符。

请求示例

POST /?Action=UpdateAddonVersion&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
        "ClusterId": "cc5silumrsf******",
        "Name": "ingress-nginx",
        "Version": "v0.44.0",
        "ClientToken": "BC028527-33B9-4990-A633-84E9F9******"
}

返回参数

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
        "ResponseMetadata": {
                "RequestId": "021635330810134****",
                "Action": "UpdateAddonVersion",
                "Version": "2022-05-12",
                "Service": "vke",
                "Region": "cn-beijing"
        },
        "Result": {}
}

错误码

本接口错误码如下表所示,公共错误码请参见 公共错误码

HTTP 状态码错误码错误信息描述

400

OperationDenied.GracefulUpgrade

The addon does not support graceful upgrade from the current version to the target version.

组件不支持从当前版本平滑升级到目标版本。
请调用 ListSupportedAddons 接口,获取组件的可升级版本,并逐个版本升级。

400OperationDenied.ClusterStatusThe action has been denied due to wrong cluster status {{statusPhase}} and {{statusConditions}}.当前集群状态不支持更新组件版本。请确认该接口依赖的集群状态后重试。
400OperationDenied.AddonStatusThe action has been forbidden due to wrong addon status {{statusPhase}} and {{statusConditions}}.当前组件状态不支持更新组件版本。请确认该接口依赖的组件状态后重试。
400NotSupported.{{parameter}}The specified {{resourceType}} {{resourceContent}} is not supported.指定的组件不支持升级。请调用 ListSupportedAddons 接口,确认支持的组件列表后重试。