Updates the minor engine version of an ApsaraDB RDS instance.
Operation description
Debugging
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 |
|
| none |
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
| rm-bpxxxxx |
UpgradeTime | string | No | The time when the update takes effect. Valid values:
| 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:
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
Examples
Sample success responses
JSON
format
{
"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. |
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. |
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-12-14 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2023-11-21 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2023-11-07 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2023-09-20 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2023-06-09 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2023-05-16 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2023-03-01 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2022-06-23 | API Description Update. The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2022-06-23 | The Error code has changed | see changesets | ||||||||||
|