调用UpgradeDBClusterVersion接口更新PolarDB MySQL引擎集群的内核版本。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UpgradeDBClusterVersion

系统规定参数。取值:UpgradeDBClusterVersion

DBClusterId String pc-****************

集群ID。

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

内核版本升级策略。取值:

  • HOT:热升级
  • COLD:冷升级。目前仅PolarDB MySQL引擎8.0集群版支持该升级方式。
UpgradeLabel String INNOVATE

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

说明 当传入该参数时,UpgradePolicy必须传入COLD
PlannedStartTime String 2021-01-14T09:00:00Z

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

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

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

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

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

  • false(默认值):定时执行
  • true:立即执行
说明 调用该接口时无需使用该参数。
UpgradeType String PROXY

升级类型。取值:

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

返回数据

名称 类型 示例值 描述
RequestId String CAE6755F-B79A-4861-B227-801FE8******

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=UpgradeDBClusterVersion
&DBClusterId=pc-****************
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpgradeDBClusterVersionResponse>
<RequestId>CAE6755F-B79A-4861-B227-801FE8******</RequestId>
</UpgradeDBClusterVersionResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 ScheduleTaskExist The specified dbCluster already has a scheduled task. 指定的实例已经存在定时任务。
400 InvalidUpgradeLabel.Malformed The specified parameter UpgradeLabel is not valid. 指定 UpgradeLabel 参数无效
403 OperationDenied.UpgradeType The operation is not permitted due to gdn limit 由于 GDN 限制,当前升级操作并不支持
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。

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