UpgradeCluster - 升级集群

为避免过期版本集群潜在的安全和稳定性风险,同时享用新集群版本的新功能,请随ACK集群的版本发布节奏升级集群。升级集群前,请参考Kubernetes版本说明帮助文档了解待升级版本的版本解读、废弃资源API、升级注意事项等,避免因高版本的功能变更导致业务功能不兼容,继而影响集群正常运行。升级集群前请先进行集群升级检查。升级集群版本可能会影响业务,请评估影响后在业务低峰期操作并提前做好相关的数据备份。

接口说明

成功调用 UpgradeCluster 接口后,该 API 将返回此次升级任务的task_id,您可以通过调用任务 API 管理该操作任务:

调试

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

授权信息

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

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

请求语法

POST /api/v2/clusters/{ClusterId}/upgrade HTTP/1.1

请求参数

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

集群 ID。

c82e6987e2961451182edacd74faf****
bodyobject

请求体参数。

component_namedeprecatedstring

已废弃,无需传递。

k8s
next_versionstring

集群升级的目标版本。

1.24.6-aliyun.1
versiondeprecatedstring

已废弃,无需传递,请使用 next_version 参数传入升级目标版本。

1.24.6-aliyun.1
master_onlyboolean

是否仅升级 master。

  • true:仅升级 master。
  • false:升级 master 和 worker。
true
rolling_policyobject

轮转配置。

max_parallelisminteger

每批执行最大数量。

3

返回参数

名称类型描述示例值
object
cluster_idstring

集群 ID。

c82e6987e2961451182edacd74faf****
task_idstring

任务 ID。

T-5faa48fb31b6b8078d00****
request_idstring

请求 ID。

0527ac9a-c899-4341-a21a-****

示例

正常返回示例

JSON格式

{
  "cluster_id": "c82e6987e2961451182edacd74faf****",
  "task_id": "T-5faa48fb31b6b8078d00****",
  "request_id": "0527ac9a-c899-4341-a21a-****"
}

错误码

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

变更历史

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