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

RDS for MySQL

Copy page
Download PDF
Managing instances
UpgradeDBInstanceEngineMajorVersionPrecheck
Copy page
Download PDF
UpgradeDBInstanceEngineMajorVersionPrecheck
Call the UpgradeDBInstanceEngineMajorVersionPrecheck API to pre-check the instance before upgrading to a major version.​
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?​
Example​
Description​
InstanceId​
String​
Yes​
mysql-7510ba07****​
Instance ID.​
TargetMajorVersion​
String​
Yes​
MySQL 8.0.43​
The target major version for the instance upgrade. Only MySQL 8.0.43 is currently supported.​
MySQLSlaveDelayThreshold​
Integer​
Yes​
10​
Data validation latency threshold. An integer from 1 to 10. Unit: seconds.​
Recheck​
Boolean​
No​
true​
Whether to restart the pre-check. Values:​
  • true: yes. Restarts the pre-check and returns the event ID of the current pre-check.​
  • false: no. If the instance has a valid pre-check result, the system returns the event ID of the last successful pre-check without starting a new one. Otherwise, the system starts a new pre-check. Default value.​
​
Response parameters​
​
Parameter​
Type​
Sample value​
Description​
EventId​
String​
20250410145924BA7FA42A930CFDBD****-83bd31​
Event ID for the pre-check of upgrading the instance major version.​
​
Sample​
Sample request​
​
POST /?Action=UpgradeDBInstanceEngineMajorVersionPrecheck&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-7510ba07****",​
"TargetMajorVersion": "MySQL 8.0.43",​
"MySQLSlaveDelayThreshold": 10​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "20250410150011691A1F663A1C51B9BE86-253c40",​
"Action": "UpgradeDBInstanceEngineMajorVersionPrecheck",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": {​
"EventId": "20250410145924BA7FA42A930CFDBD****-83bd31"​
}​
}​
​
Error code​
For more details, refer to Error codes.​
Last updated: 2026.06.12 17:17:50