Upgrades the kernel version of a PolarDB for MySQL cluster.

Note You can upgrade only the revision version of a PolarDB for MySQL cluster. For example, you can upgrade the version 8.0.1.1.3 of a PolarDB for MySQL cluster to the version 8.0.1.1.4.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No UpgradeDBClusterVersion

The operation that you want to perform. Set the value to UpgradeDBClusterVersion.

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

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query the details of all the clusters for your account, such as the cluster ID.
SwitchTimeMode String No MaintainTime

Choose to immediately upgrade the cluster or run the upgrade task in the maintenance window. Valid values:

  • Immediate: immediately upgrades the cluster. This is the default value.
  • MaintainTime: runs the upgrade task in the maintenance window.
    Note You can call the ModifyDBClusterMaintainTime operation to modify the maintenance window of a cluster.
PlannedStartTime String No 2021-01-14T09:00:00Z

The earliest time when the scheduled task for upgrading the kernel version starts to be run. The scheduled task indicates that the task is run in the required period. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.

Note
  • The value range of the start time is a time point in the next 24 hours. For example, if the current time is 2021-01-14T09:00:00Z, you can enter a start time point in the range of 2021-01-14T09:00:00Z to 2021-01-15T09:00:00Z.
  • If this parameter is left blank, the task for upgrading the kernel version is immediately run by default.
PlannedEndTime String No 2021-01-14T09:30:00Z

The latest time when the scheduled task starts to be run. Specify the time in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.

Note
  • The latest time must be at least 30 minutes later than the start time.
  • If you specify the PlannedStartTime parameter but do not specify the PlannedEndTime parameter, the default latest time when the specified task starts to be run is start time + 30 minutes. For example, when the PlannedStartTime parameter is set to 2021-01-14T09:00:00Z and the PlannedEndTime parameter is left blank, the latest time when the specified task starts to be run is 2021-01-14T09:30:00Z.
FromTimeService Boolean No false

This parameter is not required when you call the operation.

Response parameters

Parameter Type Example Description
RequestId String CAE6755F-B79A-4861-B227-801FE8******

The ID of the request.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/? Action=UpgradeDBClusterVersion
&DBClusterId=pc-****************
&<common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.