UpgradeClusterAddons - 升级集群实例组件

您可以调用UpgradeClusterAddons接口升级集群组件实例的版本,从而享受新版本带来的功能优化体验。

接口说明

  • 升级集群组件实例版本可能会影响业务,请评估影响后在业务低峰期操作并提前做好相关的数据备份。
  • 升级组件前,请参考组件发布记录了解指定组件的变更内容和变更影响。
  • 请依次逐个组件升级,确认一个组件升级成功后再升级下一个组件。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:UpgradeK8sComponentsupdate
*Cluster
acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

请求语法

POST /clusters/{ClusterId}/components/upgrade HTTP/1.1

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

cf4299b79b3e34226abfdc80a4bda****
bodyarray<object>

请求参数。

object

组件信息。

component_namestring

组件名称。

coredns
next_versionstring

待升级的目标版本。您可以调用DescribeAddon接口查看组件可升级的版本。

v1.11.3.5-5321daf49-aliyun
versionstring

当前组件版本。

v1.11.3.2-f57ea7ed6-aliyun
configstring

组件自定义参数,使用 JSON 字符串编码。

{\"CpuRequest\":\"800m\"}
policystring

组件升级策略。可选值:

  • overwrite:覆盖升级。
  • canary:金丝雀升级。
canary

返回参数

名称类型描述示例值
object
cluster_idstring

集群 ID。

cf4299b79b3e34226abfdc80a4bda****
request_idstring

请求 ID。

bfd12953-31cb-42f1-8a36-7b80ec34****
task_idstring

任务 ID。

T-62a944794ee141074400****

示例

正常返回示例

JSON格式

{
  "cluster_id": "cf4299b79b3e34226abfdc80a4bda****",
  "request_id": "bfd12953-31cb-42f1-8a36-7b80ec34****",
  "task_id": "T-62a944794ee141074400****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-24OpenAPI 返回结构发生变更查看变更详情
2024-03-12API 内部配置变更,不影响调用查看变更详情