UpgradeDBInstanceKernelVersion - ApsaraDB RDS - Alibaba Cloud Documentation Center

Updates the minor engine version of an instance.

Operation Description

An update to the minor engine version enhances performance, introduces new features, and fixes known bugs. For more information, see Update the minor engine version of an ApsaraDB RDS for MySQL instance, Update the minor engine version of an ApsaraDB RDS for SQL Server instance, and Update the minor engine version of an ApsaraDB RDS for PostgreSQL instance.

NoteThis operation is supported for instances that run MySQL, SQL Server, or PostgreSQL.

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:UpgradeDBInstanceKernelVersion	WRITE	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance. This parameter is supported only for instances that run MySQL, PostgreSQL, or SQL Server. Note If your instance runs PostgreSQL, you must make sure that the instance uses cloud disks. If the instance is equipped with local disks, you must call the RestartDBInstance operation to restart the instance. The system automatically updates the instance to the latest minor engine version during the restart process. 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: The update immediately takes effect. 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. Default value: Immediate.	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. NoteThis 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 the instance. 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: The instance runs RDS Basic Edition or RDS High-availability Edition. xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition. xcluster80: The instance runs 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. NoteFor more information about minor engine versions, see Release notes of minor AliPG versions, Release notes of minor AliSQL versions, and Release notes of minor engine versions of ApsaraDB RDS for SQL Server.	xcluster80_20210305

Response parameters

Parameter	Type	Description	Example
	object
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.	226917711

Examples

Sample success responses

JSONformat

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

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.	-
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	-
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.	-

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

Change history

Change time

Summary of changes

Operation

2023-05-16

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 400 change
	Error Codes 403 change
	delete Error Codes: 404

2023-03-01

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 400 change
	delete Error Codes: 403
	delete Error Codes: 404

2022-06-23

API Description Update,The error codes of the API operation change.

Change item	Change content
API Description	API Description Update
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404

2022-06-23

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 400 change
	Error Codes 404 change
	delete Error Codes: 403