All Products
Search
Document Center

ApsaraDB RDS:UpgradeDBInstanceKernelVersion

Last Updated:Feb 29, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:UpgradeDBInstanceKernelVersionWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

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
    UpgradeTimestringNo

    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
    SwitchTimestringNo

    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
    TargetMinorVersionstringNo

    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.

    xcluster80_20210305

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    DBInstanceNamestring

    The ID of the instance.

    rm-bpxxxxx
    TargetMinorVersionstring

    The new minor engine version of the instance.

    xcluster80_20210305
    RequestIdstring

    The ID of the request.

    DA2ECBA0-4745-4491-9166-799FF8984AC9
    TaskIdstring

    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 codeError codeError messageDescription
    400InvalidMinorVerison.NotFoundSpecify minor version not founud.The operation failed. The minor engine version cannot be found.
    400InstanceMissingMinorVersionAttrSpecify instance has no minor_version attribute.The operation failed. The minor_version parameter is empty. Submit a ticket.
    400InvalidMinorVersionLowerThanInstanceSpecify 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.
    400InvalidMinorVersionAlreadyLatestMinor version for instance is already the latest version.The RDS instance runs the latest minor engine version.
    400MissingParameter.MinorVersionTagYou must specify the parameter MinorVersionTag.The minor engine version cannot be left unspecified.
    400EngineNotSupportedThe engine does not support the operation.The operation is not supported for the database engine that is run on the RDS instance.
    400IncorrectDBInstanceStateThe current instance state does not support this operation.The operation is not supported. The RDS instance is not in a ready state.
    400TaskExistsSpecified task have existed.The task already exists.
    400UpgradeSQLServerMinorVersionFailUpgrade Minor Version for SQLServer failed.Failed to update the minor version of SQL Server.
    400UnsupportExtendDisk.NotSupportSpecified DB instance is unsupport extend disk.Disk expansion is not supported on the specified instance.
    400InvalidSwitchMode.NotFoundSpecified Parameter UpgradeTime is Invalid.-
    400InvalidDBInstanceConnType.ClassicSpecified DB instance ConnectionAddress include classic net.-
    400IncorrectDBInstanceTdeStatusSource DB instance and Target DB instance TDEStatus does not support this operation.-
    400InstanceIsSnapshotBackupNotSupportThisOperationThe instance backup method is snapshot backup, this operation is not supportedThis operation is not supported for instances that have snapshot backup enabled.
    400TDEInstanceNotSupportThisOperationThe instance opened TDE, this operation is not supportedThis operation is not supported for instances that have TDE enabled.
    400SSLInstanceNotSupportThisOperationThe instance opened SSL, upgrade is not this operationThis operation is not supported for instances that have SSL enabled.
    400BYOLInstanceNotSupportThisOperationThe BYOL instance is not supported this operationThis operation is not supported for instances that are created from BYOL images.
    400BYOKInstanceNotSupportThisOperationThe BYOK instance is not supported this operationThis operation is not supported for instances that have disk encryption enabled.
    400ADInstanceNotSupportThisOperationThe AD instance is not supported this operationThis operation is not supported for instances that have been joined to an AD domain.
    400MinorVersionNotSupportThe current database minor version does not support the operation.The operation is not supported for the minor engine version of the instance.
    403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
    403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.The operation failed. The RDS instance is locked.
    403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
    403SSLNotSupportThe CharacterType of instance does not support SSL-
    403OperationDenied.PrePayTypeNotSupportedThe operation is not permitted due to pay type of instance.Subscription instances cannot be directly deleted.
    403CurrentRecoveryModelNotSupportThisActionCurrent recovery model not supported this action.The current recovery model does not support.
    403MaxscaleMinorVersionNotSupportThe 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.
    404InvalidDBInstanceName.NotFoundThe database instance does not exist.The name of the RDS instance cannot be found. Check the name of the RDS instance.
    404InvalidMaxscaleMinorVersion.FormatSpecified Maxscale Minor Version is Invalid.-

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

    Change history

    Change timeSummary of changesOperation
    2023-12-14The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 403 change
      delete Error Codes: 400
      delete Error Codes: 404
    2023-11-21The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2023-11-07The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 403 change
      delete Error Codes: 400
      delete Error Codes: 404
    2023-09-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 403 change
      delete Error Codes: 404
    2023-06-09The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    2023-05-16The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 403 change
      delete Error Codes: 404
    2023-03-01The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2022-06-23API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    2022-06-23The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 404 change
      delete Error Codes: 403