Initiates a task to upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance.
Operation description
Supported database engine
PostgreSQL
References
Fees are generated if the call is successful. Before you call this operation, read the following documentation and make sure that you fully understand the billing rules, prerequisites, and impacts of this operation.
Upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceClass | string | No | The instance type of the new instance. The CPU and memory specifications of the new instance must be higher than or equal to the CPU and memory specifications of the original instance. For example, if the instance type of the original instance is Note
For more information about instance types in ApsaraDB RDS for PostgreSQL, see Primary ApsaraDB RDS for PostgreSQL instance types.
| pg.n2.medium.2c |
DBInstanceStorage | integer | No | The storage capacity of the new instance. Unit: GB Valid values:
Note
If the original instance uses local disks, you can reduce the storage capacity of the instance when you upgrade the major engine version of the instance. For more information about the minimum available storage capacity, see Upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance.
| 20 |
PayType | string | Yes | The billing method. Set the value to Postpaid. Note
For more information about how to change the billing method of an instance after the upgrade, see Change the billing method of an instance from pay-as-you-go to subscription.
| Postpaid |
InstanceNetworkType | string | No | The network type of the new instance. Set the value to VPC. The major engine version upgrade feature is supported only for instances that reside in VPCs. If the original 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. | VPC |
SwitchTimeMode | string | No | The switchover time. This parameter is used together with SwitchOver. This parameter is available only when SwitchOver is set to true. Valid values:
| Immediate |
SwitchTime | string | No | A reserved parameter. You do not need to specify this parameter. | 2021-07-10T13:15:12Z |
SwitchOver | string | No | Specifies whether the system automatically switches your workloads over to the new instance after data is migrated to the new instance. Valid values:
Note
| false |
CollectStatMode | string | No | The time at which the system collects the statistics of the new instance. Valid values:
Note
If you set SwitchOver to false, the value Before of this parameter specifies that ApsaraDB RDS collects the statistics of the new instance before the new instance starts to process read and write requests, and the value After of this parameter specifies that ApsaraDB RDS collects the statistics of the new instance after the new instance starts to process read and write requests.
| After |
TargetMajorVersion | string | No | The major engine version of the new instance. The value of this parameter must be the major engine version on which an upgrade check is performed. Note
You can call the UpgradeDBInstanceMajorVersionPrecheck operation to perform an upgrade check.
| 13.0 |
DBInstanceId | string | No | The ID of the original instance. | pgm-bp1gm3yh0ht1**** |
VPCId | string | No | The VPC ID. You can call the DescribeDBInstanceAttribute operation to query the VPC ID. | vpc-bp1opxu1zkhn00gzv**** |
VSwitchId | string | No |
Note
The vSwitches that you specify must reside in the same zone as the original instance. You can call the DescribeVSwitches operation to query the vSwitch IDs.
| vsw-bp10aqj6o4lclxdrm****,vsw-bp10aqj6o4lclxdrm**** |
PrivateIpAddress | string | No | The internal IP address of the new instance. You do not need to specify this parameter. The system automatically assigns an internal IP address based on the values of the VPCId and vSwitchId parameters. | 172.16.XX.XX |
UsedTime | string | No | A reserved parameter. You do not need to specify this parameter. | 1 |
Period | string | No | A reserved parameter. You do not need to specify this parameter. | Month |
DBInstanceStorageType | string | No | The storage type of the new instance. Valid values:
The major engine version upgrade feature is based on cloud disk snapshots. You can select a storage type based on the following conditions:
| cloud_essd |
ZoneId | string | No | The ID of the zone to which the new primary instance belongs. You can call the DescribeRegions operation to query zone IDs. You can select a zone that belongs to the region in which the original instance resides. | cn-hangzhou-h |
ZoneIdSlave1 | string | No | The ID of the zone to which the new secondary instance belongs. This parameter is available only when the original instance runs RDS High-availability Edition. You can select a zone that belongs to the region in which the original instance resides. You can call the DescribeRegions operation to query zone IDs. | cn-hangzhou-h |
ZoneIdSlave2 | string | No | A reserved parameter. You do not need to specify this parameter. | cn-hangzhou-h |
Response parameters
Examples
Sample success responses
JSON
format
{
"DBInstanceId": "pgm-bp1gm3yh0ht1****",
"RequestId": "006729E5-2A33-5955-89E3-651D3F44EBE6",
"OrderId": "21128667463****",
"TaskId": 416980000
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidUpgradePrecheckResult | The upgrade precheck failed. No successful precheck task found in the past 7 days | The upgrade precheck failed. No successful precheck task is found within the last 7 days. |
400 | TargetEngineVersion.Parameters.NotFound | targetEngineVersion is missing in the request. | The targetEngineVersion is missing in the request. |
400 | InvalidDBInstanceStorageType | The specified DBInstanceStorageType is invalid. | The specified DBInstanceStorageType parameter is invalid. |
400 | InvalidInstanceNetworkType | The specified InstanceNetworkType is invalid. | The specified InstanceNetworkType is invalid. |
400 | InvalidVPCId | The specified VPCId is invalid. | The specified VPCId parameter is invalid. |
400 | InvalidDedicatedHostGroupId | The specified DedicatedHostGroupId is invalid. | The specified DedicatedHostGroupId parameter is invalid. |
400 | InvalidPayType | The specified PayType is invalid. | The specified PayType is invalid. |
400 | InvalidEngineVersion | The specified EngineVersion is invalid. | The specified EngineVersion parameter is invalid. |
400 | InvalidDBInstanceStorage | The specified DBInstanceStorage is invalid. | The specified DBInstanceStorage parameter is invalid. |
400 | InvalidSwitchOver | The specified SwitchOver is invalid. | The specified SwitchOver parameter is invalid. |
400 | PrimaryInstanceWithReadonlyNotSupport | The specified primary instance with the read-only instance does not support the operation. | This operation is not supported for the specified primary instance that has a read-only instance. |
400 | InvalidSwitchTimeMode | The specified SwitchTimeMode is invalid. | The specified SwitchTimeMode parameter is invalid. |
400 | InvalidSwitchTime | The specified SwitchTime is invalid. | The specified SwitchTime parameter is invalid. |
400 | InvalidCollectStats | The specified CollectStats is invalid. | The specified CollectStats parameter is invalid. |
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 | InvalidDBinstanceClass.ValueNotSupported | The specified parameter DBinstanceClass is invalid. | The specified parameter DBinstanceClass is invalid. |
400 | InvalidDBInstanceClass.Offline | The specified instance type is no longer provided. Please specify another instance type. | The instance type that you select is no longer available. Select another instance type. |
400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | A package instance is not allowed to operate independently. |
400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | Pricing plan price result not found. |
400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. |
400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | Your account available limit is less than 0, please recharge before trying to purchase. |
400 | CommodityServiceCalling.Exception | Failed to call commodity service. | Failed to call commodity service return. |
400 | RegionDissolvedEOM | Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. | Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support. |
400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | The module you purchased is not legal, please buy it again. |
400 | RegionEndTimeDissolvedIndia | Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024. | Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024. |
400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. |
400 | Price.CommoditySys | Commodity system call exception. | Commodity system call exception. |
400 | Pay.InsufficientBalance | Insufficient available balance. | Insufficient available balance. |
400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | There is a problem with the period you selected, please choose again. |
400 | pay.noCreditCard | Account not bound to credit card. | - |
400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. |
400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | - |
400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | Your basic information is not complete, please complete your basic information before operation. |
400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | Your account is abnormal, please contact customer service for details. |
400 | BasicInfoUncompleted | Your information is incomplete, Complete your information before the operation. | - |
400 | Api.NotSupport | Specified api is not supported. | The current interface does not support. |
400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor. |
400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | The DBInstanceId provided does not exist. |
400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | The current instance type does not support the specified storage type. |
400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica. |
400 | KmsApiError | User secret key invalid. | The user key is invalid. |
400 | System.SaleValidateFailed | Sales expression validation system error. | A system error occurs when the sales expression is verified. |
400 | Abs.InvalidAccount.NotFound | account is not found. | The account does not exist. |
400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | SQL command execution failed or timed out |
403 | TargetMajorVesionNotSupported | The specified major version is not supported. | Target large version not supported |
403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | The instance has an unpaid order. Please pay first and try again. |
403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | The scale-in target capacity cannot be less than the current storage space usage |
403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | - |
403 | InvalidUserOperatorPermission | The user permission does not support this operation. | The user is not authorized to perform this operation. |
403 | InvalidVswitchId | Specified conn vswitch id is not valid. | - |
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 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | The operation failed. The RDS instance is locked. |
404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | The instance does not have permissions to access Key Management Service (KMS). |
500 | ExternalFailure | The request processing has failed due to external service failure. | The request processing has failed due to external service failure. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-06-03 | The Error code has changed | View Change Details |
2024-05-22 | The Error code has changed | View Change Details |