UpgradeDBInstanceKernelVersion - ApsaraDB RDS - Alibaba Cloud Documentation Center

Updates the minor engine version of an ApsaraDB RDS instance.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID. Note If your instance runs PostgreSQL, you must make sure that the instance uses cloud disks. If the instance uses local disks, you must call the RestartDBInstance operation to restart the instance. The system automatically updates the minor engine version of the instance to the latest version during the restart. If your instance runs SQL Server, you must make sure that the instance runs SQL Server 2019.	rm-bpxxxxx
UpgradeTime	string	No	The time when the update takes effect. Valid values: Immediate (default): The update takes effect immediately. MaintainTime: The update takes effect during the maintenance window that you specify. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime. SpecifyTime: The update takes effect at the point in time you specify.	Immediate
SwitchTime	string	No	The update time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note This parameter takes effect only when you set UpgradeTime to SpecifyTime.	2020-01-15T00:00:00Z
TargetMinorVersion	string	No	The minor engine version to which you want to update. Format: PostgreSQL: `rds_postgres_<Major engine version>00_<Minor engine version>`. Example: `rds_postgres_1200_20200830`. MySQL: `<RDS edition and MySQL version>_<Minor engine version>`. Examples: `rds_20200229`, `xcluster_20200229`, and `xcluster80_20200229`. The following RDS editions and MySQL versions are supported: rds: RDS Basic Edition or RDS High-availability Edition xcluster: MySQL 5.7 on RDS Enterprise Edition xcluster80: MySQL 8.0 on RDS Enterprise Edition SQLServer: `<Minor engine version>`. Example: `15.0.4073.23`. If you do not specify this parameter, the instance is updated to the latest minor engine version. Note For more information about minor engine versions, see Release notes of AliPG, Release notes of AliSQL, and Release notes of minor engine versions of ApsaraDB RDS for SQL Server.	xcluster80_20210305

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
DBInstanceName	string	The ID of the instance.	rm-bpxxxxx
TargetMinorVersion	string	The new minor engine version of the instance.	xcluster80_20210305
RequestId	string	The ID of the request.	DA2ECBA0-4745-4491-9166-799FF8984AC9
TaskId	string	The ID of the task.	226917****

Examples

Sample success responses

JSONformat

{
  "DBInstanceName": "rm-bpxxxxx",
  "TargetMinorVersion": "xcluster80_20210305",
  "RequestId": "DA2ECBA0-4745-4491-9166-799FF8984AC9",
  "TaskId": "226917****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidMinorVerison.NotFound	Specify minor version not founud.	The operation failed. The minor engine version cannot be found.
400	InstanceMissingMinorVersionAttr	Specify instance has no minor_version attribute.	The operation failed. The minor_version parameter is empty. Submit a ticket.
400	InvalidMinorVersionLowerThanInstance	Specify minor version cannot not be lower than current instance.	The new database engine version cannot be earlier than the database engine version that is run on the RDS instance. Check the new database engine version.
400	InvalidMinorVersionAlreadyLatest	Minor version for instance is already the latest version.	The RDS instance runs the latest minor engine version.
400	MissingParameter.MinorVersionTag	You must specify the parameter MinorVersionTag.	The minor engine version cannot be left unspecified.
400	EngineNotSupported	The engine does not support the operation.	The operation is not supported for the database engine that is run on the RDS instance.
400	IncorrectDBInstanceState	The current instance state does not support this operation.	The operation is not supported. The RDS instance is not in a ready state.
400	TaskExists	Specified task have existed.	The task already exists.
400	UpgradeSQLServerMinorVersionFail	Upgrade Minor Version for SQLServer failed.	Failed to update the minor version of SQL Server.
400	UnsupportExtendDisk.NotSupport	Specified DB instance is unsupport extend disk.	Disk expansion is not supported on the specified instance.
400	InvalidSwitchMode.NotFound	Specified Parameter UpgradeTime is Invalid.	-
400	InvalidDBInstanceConnType.Classic	Specified DB instance ConnectionAddress include classic net.	-
400	IncorrectDBInstanceTdeStatus	Source DB instance and Target DB instance TDEStatus does not support this operation.	-
400	InstanceIsSnapshotBackupNotSupportThisOperation	The instance backup method is snapshot backup, this operation is not supported	This operation is not supported for instances that have snapshot backup enabled.
400	TDEInstanceNotSupportThisOperation	The instance opened TDE, this operation is not supported	This operation is not supported for instances that have TDE enabled.
400	SSLInstanceNotSupportThisOperation	The instance opened SSL, upgrade is not this operation	This operation is not supported for instances that have SSL enabled.
400	BYOLInstanceNotSupportThisOperation	The BYOL instance is not supported this operation	This operation is not supported for instances that are created from BYOL images.
400	BYOKInstanceNotSupportThisOperation	The BYOK instance is not supported this operation	This operation is not supported for instances that have disk encryption enabled.
400	ADInstanceNotSupportThisOperation	The AD instance is not supported this operation	This operation is not supported for instances that have been joined to an AD domain.
400	MinorVersionNotSupport	The current database minor version does not support the operation.	The operation is not supported for the minor engine version of the instance.
400	InvalideStatus.Format	The instance status does not support this operation.	-
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 user center 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.	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
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.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	-
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
400	RequiredParam.NotFound	Required input param is not found.	-
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	The operation failed. The RDS instance is locked.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	The operation failed. The RDS instance is not in a ready state.
403	SSLNotSupport	The CharacterType of instance does not support SSL	-
403	OperationDenied.PrePayTypeNotSupported	The operation is not permitted due to pay type of instance.	Subscription instances cannot be directly deleted.
403	CurrentRecoveryModelNotSupportThisAction	Current recovery model not supported this action.	The current recovery model does not support.
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	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	-
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	-
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.	-
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
404	InvalidDBInstanceName.NotFound	The database instance does not exist.	The name of the RDS instance cannot be found. Check the name of the RDS instance.
404	InvalidMaxscaleMinorVersion.Format	Specified Maxscale Minor Version is Invalid.	-
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
404	HostInfo.NotFound	The specified host info is not found.	-
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	The service request failed. Please try again later or contact service personnel.

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

Change history

Change time	Summary of changes	Operation
2024-07-11	The Error code has changed	View Change Details
2023-12-14	The Error code has changed	View Change Details
2023-11-21	The Error code has changed	View Change Details
2023-11-07	The Error code has changed	View Change Details
2023-09-20	The Error code has changed	View Change Details
2023-06-09	The Error code has changed	View Change Details
2023-05-16	The Error code has changed	View Change Details
2023-03-01	The Error code has changed	View Change Details
2022-06-23	API Description Update. The Error code has changed	View Change Details
2022-06-23	The Error code has changed	View Change Details