All Products
Search

This Product

    ApsaraDB RDS:UpgradeDBInstanceMajorVersionPrecheck

    Document Center

    ApsaraDB RDS:UpgradeDBInstanceMajorVersionPrecheck

    Last Updated:May 29, 2023

    check the compatibility between a new major engine version and an ApsaraDB RDS for PostgreSQL instance before you upgrade the instance to the new major engine version.

    Operation Description

    ApsaraDB RDS for PostgreSQL provides the major version upgrade feature. You can use this feature to upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance.

    Before you perform an upgrade, you must perform an upgrade check and make sure that the check result is Success. You can call this operation to perform an upgrade check.

    An upgrade brings impacts, such as a transient connection that lasts a few minutes. We recommend that you perform an upgrade during off-peak hours. Before you perform an upgrade, we recommend that you read Upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance.

    The instance must meet the following requirements:

    • The instance runs PostgreSQL 12, PostgreSQL 11, PostgreSQL 10, or PostgreSQL 9.4.
    • The instance runs RDS High-availability Edition or RDS Basic Edition.
    • The instance resides in a virtual private cloud (VPC). If the instance resides in the classic network, you must migrate the instance to a VPC before you call this operation. For more information about how to view or change the network type of an instance, see Change the network type of an ApsaraDB RDS for PostgreSQL instance.
    • The instance cannot be a read-only instance and cannot be created in a dedicated cluster.
    • The ID of the instance does not start with pg-cn.
    		pgm-bp1c808s731l****
    TargetMajorVersionstringYes

    The new major engine version of the instance. The new major engine version must be later than the original major engine version.

    For example, if the original major engine version is PostgreSQL 9.4, the new major engine version can be PostgreSQL 10, PostgreSQL 11, PostgreSQL 12, or PostgreSQL 13.

    		12.0

    Response parameters

    ParameterTypeDescriptionExample
    object
    DBInstanceNamestring

    The name of the instance.

    		pgm-bp1c808s731l****
    TargetMajorVersionstring

    The new major engine version of the instance.

    		12.0
    RequestIdstring

    The ID of the request.

    		99C1FEEE-FB44-5342-8EBA-DC1E1A1557A4
    TaskIdstring

    The ID of the upgrade check task.

    		41698****

    Examples

    Sample success responses

    JSONformat

    {
  "DBInstanceName": "pgm-bp1c808s731l****",
  "TargetMajorVersion": "12.0",
  "RequestId": "99C1FEEE-FB44-5342-8EBA-DC1E1A1557A4",
  "TaskId": "41698****"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidDBInstanceName.NotFoundThe specified DB instance name does not exist.The instance name does not exist.
    400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
    403ParamNotFoundThe parameter is not found for the interface.The parameter is not found for the interface.

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

    Change history

    Change timeSummary of changesOperation
    2021-10-25The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403