You need to enable JavaScript to run this app.
导航
容器服务
  • 文档首页
    • /
  • 容器服务

UpdateAddonConfig

最近更新时间：2024.02.26 20:17:37

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

我的收藏

更新指定集群下的指定组件配置。

使用说明

  • 调用该接口前，请先调用 ListSupportedAddons 接口，获取您待更新组件的名称、安装模式（DeployMode）等参数值，以减少不必要的更新失败。
  • 此接口为异步接口，当此接口返回成功时，组件将进入{Updating, [Progressing]}状态，直到更新执行成功，进入{Running, [Ok]}状态。请调用 ListAddons 接口获取该组件当前的状态，查看组件是否更新成功。

请求参数

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

参数名称类型是否必选示例值描述
ActionString是UpdateAddonConfig公共参数，本接口值：UpdateAddonConfig。
VersionString是2022-05-12公共参数，本接口值：2022-05-12。

ClusterId

String

是

cc5silumrsf******

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

注意

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

Name

String

是

ingress-nginx

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

注意

  • 仅个别组件支持更新组件配置信息，包括：cr-credential-controller、apmplus-opentelemetry-collector、cluster-autoscaler、ingress-nginx、p2p-accelerator。
  • 组件必须处于{Running, [*]}或除{Failed, [ResourceCleanupFailed]}、{Failed, [ClusterNotRunning]}以外的{Failed, [*]}状态。可调用 ListAddons 接口获取组件当前状态。

Config

String

否

组件配置。
详细说明，请参见 组件配置信息。

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

请求示例

POST /?Action=UpdateAddonConfig&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
        "ClusterId": "cc5silumrsf******",
        "Name": "ingress-nginx",
        "Config": "{\"Replica\":1,\"Resource\":{\"Request\":{\"Cpu\":\"0.25\",\"Memory\":\"512Mi\"},\"Limit\":{\"Cpu\":\"0.5\",\"Memory\":\"1024Mi\"}},\"PrivateNetwork\":{\"SubnetId\":\"subnet-2d61qn69iji****\",\"IpVersion\":\"IPV4\"}}",
        "ClientToken": "BC028527-33B9-4990-A633-84E9F9******"
}

返回参数

本接口无专有返回参数，公共返回参数请参见 返回结果。

返回示例

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

错误码

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

HTTP 状态码错误码错误信息描述
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.指定的组件不支持更新。仅支持更新该接口 Name 参数说明中列出的组件。