Updates the kernel version of an ApsaraDB PolarDB MySQL-compatible edition cluster.

Note
  • You can update the kernel version of an ApsaraDB PolarDB MySQL-compatible edition cluster only to a revision version. For example, you can update the kernel version of a cluster from V8.0.1.1.3 to V8.0.1.1.4.
  • You must use the credentials of your Alibaba Cloud account to update the kernel version of an ApsaraDB PolarDB MySQL-compatible edition cluster. RAM users are not authorized to create scheduled tasks that are used to update kernel versions for ApsaraDB PolarDB MySQL-compatible edition clusters.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. 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 Yes UpgradeDBClusterVersion

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

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

The ID of the ApsaraDB PolarDB MySQL-compatible edition cluster.

Note You can call the DescribeDBClusters operation to query the information about each cluster that belongs to your Alibaba Cloud account. The returned information includes the ID of each cluster.
PlannedStartTime String No 2021-01-14T09:00:00Z

The earliest start time to run the task to update the kernel version of the specified cluster. The task runs within a specified period of time. The value of this parameter must be in the YYYY-MM-DDThh:mm:ssZ UTC format.

Note
  • The earliest start time of the task can be a point in time within the next 24 hours. For example, if the current time is 2021-01-14T09:00:00Z, you can specify a point in the time range from 2021-01-14T09:00:00Z to 2021-01-15T09:00:00Z.
  • If you do not specify this parameter, the kernel upgrading task runs immediately after the request is submitted.
PlannedEndTime String No 2021-01-14T09:30:00Z

The latest start time to run the task. The value of this parameter must be in the YYYY-MM-DDThh:mm:ssZ UTC format.

Note
  • The value of this parameter must be at least 30 minutes later than the value of the PlannedStartTime parameter.
  • If you specify the PlannedStartTime parameter but do not specify a value for the PlannedEndTime parameter, the latest start time of the task is set to a value that is calculated by the value of the PlannedEndTime parameter + 30 minutes by default. For example, if you set the PlannedStartTime parameter to 2021-01-14T09:00:00Z and you do not specify the PlannedEndTime parameter, the latest start time of the task is set to 2021-01-14T09:30:00Z.
FromTimeService Boolean No false

A hidden parameter. You do not need to specify this parameter.

UpgradeType String No PROXY

The update type. Valid values:

  • PROXY: specifies to update the database proxy
  • DB: specifies to update the kernel version
  • ALL: specifies to update both the database proxy and the kernel version

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 

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

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

JSON format 

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

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

Error codes

HttpCode Error code Error message Description
400 ScheduleTaskExist The specified dbCluster already has a scheduled task. The error code returned because a different task is scheduled to run on the specified cluster.

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