全部产品
Search
文档中心

云原生数据库 PolarDB:UpgradeDBClusterVersion - 升级PolarDB MySQL版集群的内核版本

更新时间:Feb 20, 2024

升级PolarDB MySQL版集群的内核版本。

接口说明

说明
  • 当前仅支持升级 PolarDB MySQL 版集群的修订版本(Revision Version),如从 8.0.1.1.3 升级至 8.0.1.1.4。
  • 仅允许阿里云主账号执行定时(即在目标时间段内执行)内核版本升级任务,RAM 账号不支持定时内核版本升级任务。
  • 调试

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

    授权信息

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

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

    请求参数

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

    集群 ID。

    说明 您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息(如集群 ID)。
    pc-****************
    UpgradePolicystring

    内核版本升级策略。取值范围如下:

    • HOT:热升级

    • COLD:冷升级。目前仅 PolarDB MySQL 版 8.0 集群版支持该升级方式。

    HOT
    UpgradeLabelstring

    内核版本升级标签。取值固定为 INNOVATE

    说明
  • 该参数仅适用于 PolarDB MySQL 版 8.0.1 版本升级至 PolarDB MySQL 版 8.0.2 版本。
  • 当传入该参数时,UpgradePolicy必须传入 COLD
  • INNOVATE
    PlannedStartTimestring

    开始执行定时(即在目标时间段内执行)内核版本升级任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ(UTC)。

    说明
  • 开始时间的取值范围为未来 24 小时内的任意时间点。例如当前时间为2021-01-14T09:00:00Z,此处允许填入的开始时间范围为2021-01-14T09:00:00Z~2021-01-15T09:00:00Z
  • 若该参数留空,默认立即执行内核版本升级任务。
  • 2021-01-14T09:00:00Z
    PlannedEndTimestring

    开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ(UTC)。

    说明
  • 最晚时间需晚于开始时间的 30 分钟或以上。
  • 若设置了PlannedStartTime但未指定该参数,执行目标任务的最晚时间默认为开始时间+30 分钟。例如当设置PlannedStartTime2021-01-14T09:00:00Z且该参数留空时,目标任务最晚将于2021-01-14T09:30:00Z开始执行。
  • 2021-01-14T09:30:00Z
    FromTimeServiceboolean

    立即执行或定时执行内核版本升级。取值范围如下:

    • false(默认值):定时执行

    • true:立即执行

    说明 调用该接口时无需使用该参数。
    false
    UpgradeTypestring

    升级类型。取值范围如下:

    • PROXY:仅升级数据库代理(Proxy)

    • DB:仅升级内核引擎

    • ALL(默认值):同时升级数据库代理(Proxy)和内核引擎

    PROXY
    TargetDBRevisionVersionCodestring

    目标版本的 VersionCode,参数取值可从 DescribeDBClusterVersion 接口获取。

    20230707

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    CAE6755F-B79A-4861-B227-801FE8******

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "CAE6755F-B79A-4861-B227-801FE8******"
    }

    错误码

    HTTP status code错误码错误信息描述
    400ScheduleTaskExistThe specified dbCluster already has a scheduled task.指定的实例已经存在定时任务。
    400InvalidUpgradeLabel.MalformedThe specified parameter UpgradeLabel is not valid.指定 UpgradeLabel 参数无效
    400InvalidEngine.UnsupportedThe specified Engine does not support this feature.指定的引擎不支持此功能
    400InvalidEngineMinorVersion.MalformedThe specified parameter MinorVersion is not valid.指定的参数MinorVersion无效。
    400InvalidEngineVersion.UnsupportedThe specified engineVersion is not supported.不支持指定的engineVersion。
    400InvalidUpgradePolicy.MalformedThe specified parameter UpgradePolicy is not valid.指定的参数UpgradePolicy无效
    400InvalidSwitchTimeMode.MalformedThe specified parameter SwitchTimeMode is not valid.指定的参数SwitchTimeMode无效。
    403OperationDenied.UpgradeTypeThe operation is not permitted due to gdn limit由于 GDN 限制,当前升级操作并不支持
    403IncorrectGdnStandbyDBVersionCurrent gdn standby cluster is not the latest db version.当前gdn备用集群不是最新的db版本
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效

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

    变更历史

    变更时间变更内容概要操作
    2023-09-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      错误码 404 变更
      删除错误码:403
    2023-07-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:TargetDBRevisionVersionCode
    2022-07-14OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:404
      新增错误码:403
    2022-07-06OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
    2022-07-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:UpgradePolicy
      新增入参:UpgradeLabel