UpgradeDBInstanceEngineVersion - ApsaraDB RDS - Alibaba Cloud Documentation Center

Upgrades the major engine version of an ApsaraDB RDS for MySQL instance.

Operation description

Supported database engine

MySQL

References

Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.

Upgrade the major engine version of an ApsaraDB RDS for MySQL instance

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:UpgradeDBInstanceEngineVersion	update	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCzxxxxxxxxxx
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-uf6wjk5xxxxxxx
EngineVersion	string	Yes	The major engine version that the new instance runs. Valid values: 8.0 5.7 5.6	5.7
EffectiveTime	string	No	The effective time. Valid values: Immediate: This is the default value. MaintainTime: The effective time is within the maintenance window. For more information, see ModifyDBInstanceMaintainTime.	Immediate

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TaskId	string	The ID of the task.	10254125
RequestId	string	The ID of the request.	65BDA532-28AF-4122-AA39-B382721EEE64

Examples

Sample success responses

JSONformat

{
  "TaskId": "10254125",
  "RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidOrderTask.NotSupport	The Current InstanceId exist Order Task in RDS.	Uncompleted order tasks are found in the RDS instance. Please try again later.
400	InvalidEVENT	Current DB instance has event schedule, this operation is not supported.	-
400	InvalidSSLstatus	Current DB instance has SSL enabled, this operation is not supported.	This operation is not supported because this instance has SSL enabled.
400	InvalidTDEstatus	Current DB instance has TDE enabled, this operation is not supported.	This operation is not supported because TDE is enabled on the instance.
400	InvalidDBInstanceConnType.Format	Specified DB instance conn type is not valid.	The operation failed. The operation is not supported for the connection type of the RDS instance.
400	UnsupportedReadOrBakReadState	Current DB instance has read or bak read instance running in unsupported states.	-
400	InvalidSourceCategory	specified source category is invalid.	The specified source category is invalid.
400	InvalidBizType.Format	Specified biz type is not valid.	-
400	InvalidMinorVerison.NotFound	Specify minor version not founud.	The operation failed. The minor engine version cannot be found.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	Hello customer, this area has been abolished.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.	-
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	-
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	-
403	IncorrectEngineVersion	The engine version does not support the operation.	The operation failed. The operation is not supported for the database engine version of the RDS instance.
403	IncorrectEngineTypeMyisam	Current DB instance has MyISAM table, and it does not support this operation.	The major version of MySQL is upgraded. Check whether the instance has MyISAM engine tables.
403	InvalidAccountName.Format	Current DB instance has account aliyun_root,and it does not support this operation.	-
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	The operation failed. The RDS instance is locked.
403	UnsupportedReadOrBakReadState	Current DB instance has read or bak read running in unsupport states	The current instance is in the unsupported read or bak read state.
403	MaxscaleMinorVersionNotSupport	The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.	The version of the database proxy used by the instance is too low. Upgrade the version of the database proxy first.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	-
403	ReadInstanceNotSupport	Instances with read-only do not support this operation.	-
403	ClusterNotSupport	ClusterNotSupport	The operation is not supported for the RDS instance.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	The operation failed. The RDS instance is not in a ready state.
403	UnsupportedFtsIndex	Current DB instance has fts index. Please delete in space fts index.	The current instance contains full-text indexes created in the system tablespace. Delete and rebuild the corresponding full-text indexes before upgrading.
403	UnsupportedFtsIndexVersion	Current DB instance has fts index. Please upgrade the minor version to a version after 20221130 and remove the space fts index.	The current instance minor version is less than 20221130. Please upgrade the minor version before deleting or rebuilding the full-text index.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.	The RDS instance cannot be found. Check the ID or name of the RDS instance.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-03-12	The Error code has changed	View Change Details
2023-12-14	The Error code has changed	View Change Details
2022-07-19	The Error code has changed	View Change Details
2022-06-23	The Error code has changed	View Change Details
2021-12-23	The Error code has changed	View Change Details
2021-12-23	The Error code has changed	View Change Details
2021-12-23	The Error code has changed	View Change Details