All Products
Search
Document Center

ApsaraDB RDS:UpgradeDBInstanceMajorVersionPrecheck

Last Updated:May 11, 2024

Performs a precheck before the upgrade of the major engine version of an ApsaraDB RDS for PostgreSQL instance.

Operation description

Supported database engine

PostgreSQL

References

Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance

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

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.

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.

12.0

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

DBInstanceNamestring

The instance name.

pgm-bp1c808s731l****
TargetMajorVersionstring

The new major engine version of the instance.

12.0
RequestIdstring

The request ID.

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

The task ID.

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 code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403