You need to enable JavaScript to run this app.
RDS for MySQL

RDS for MySQL

Copy page
Download PDF
Managing instances
UpgradeDBInstanceEngineMinorVersion
Copy page
Download PDF
UpgradeDBInstanceEngineMinorVersion
Call the UpgradeDBInstanceEngineMinorVersion API to upgrade the minor kernel version of an instance.​
Request type​
Asynchronous request.​
Debug​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
​
Parameter​
Type​
Is it required?​
Sample value​
Description​
InstanceId​
String​
Yes​
mysql-19f81673****​
Instance ID.​
TargetMinorVersion​
String​
Yes​
MySQL 8.0.32_20241015​
Target kernel minor version.​
SwitchType​
String​
No​
MaintainTime​
Execution time. The valid values are:​
  • Immediate: switch now (default).​
  • MaintainTime: switch during the maintenance window.​
  • SpecifiedTime: switch during the specified time period.​
tip​
  • When the value is SpecifiedTime, the start and end time for the time period must be set in the SpecifiedSwitchStartTime and SpecifiedSwitchEndTime parameters.​
SpecifiedSwitchStartTime​
String​
No​
2024-12-25T14:00:00Z​
The start time of the specific time period for execution(UTC time). The format is yyyy-MM-ddTHH:mm:ssZ.​
tip​
  • When SwitchType is set to SpecifiedTime, this parameter is required.​
  • The start time of the task cannot be later than seven days after the current date.​
SpecifiedSwitchEndTime​
String​
No​
2024-12-25T15:59:00Z​
The end time of the specific time period for execution (UTC time). The format is yyyy-MM-ddTHH:mm:ssZ.​
tip​
  • When SwitchType is set to SpecifiedTime, this parameter is required.​
  • The minimum time period is one hour and fifty-nine minutes.​
  • Time periods cannot be set across days. The task's start and end times must be within a 24-hour window.​
EstimateOnly​
Boolean​
No​
true​
Whether to start an evaluation. Values:​
  • true: yes.​
  • false: no. Default value.​
tip​
If you start a configuration change evaluation, the system evaluates the specifications determined by other fields, but the change is not actually executed.​
ObservationHours​
Integer​
No​
1​
Set the observation duration after the instance upgrade. The value can be set to an integer between 0 and 72, in hours. The default value is 0.​
​
Response parameters​
​
Parameter​
Type​
Sample value​
Description​
PreparedMinutes​
Integer​
18​
The duration of the preparation phase, in minutes.​
​
Sample​
Sample request 1​
Execute directly without an evaluation.​
​
POST /?Action=UpgradeDBInstanceEngineMinorVersion&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mysql.cn-beijing.volcengineapi.com​
X-Date: 20211202T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "mysql-19f81673****",​
"TargetMinorVersion": "MySQL 5.7.32_20241015",​
"SwitchType": "SpecifiedTime",​
"SpecifiedSwitchStartTime": "2024-12-25T14:00:00Z",​
"SpecifiedSwitchEndTime": "2024-12-25T16:00:00Z"​
}​
​
Sample response 1​
​
{​
"ResponseMetadata": {​
"RequestId": "20241219210327DD68F5A1B8E261523184-a8158f",​
"Action": "UpgradeDBInstanceEngineMinorVersion",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": null​
}​
​
Sample request 2​
Initiates an assessment without actual execution and returns the duration of the preparation phase.​
​
POST /?Action=UpgradeDBInstanceEngineMinorVersion&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mysql.cn-beijing.volcengineapi.com​
X-Date: 20211202T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "mysql-19f81673****",​
"TargetMinorVersion": "MySQL 5.7.32_20241015",​
"SwitchType": "SpecifiedTime",​
"SpecifiedSwitchStartTime": "2024-12-25T14:00:00Z",​
"SpecifiedSwitchEndTime": "2024-12-25T16:00:00Z",​
"EstimateOnly": true​
}​
​
Sample response 2​
​
{​
"ResponseMetadata": {​
"RequestId": "2024122011191734C36BC883C95F08F2BB-184ccd",​
"Action": "UpgradeDBInstanceEngineMinorVersion",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": {​
"PreparedMinutes": 18​
}​
}​
​
Error code​
For more details, refer to Error codes.​
Last updated: 2026.06.12 17:17:50