Changes the instance type and storage capacity of an ApsaraDB RDS instance.
Operation Description
debugging
debuggingAuthorization 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 Resourcesis 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:ModifyDBInstanceSpec | WRITE |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance. | rm-uf6wjk5******* |
| DBInstanceClass | string | No | The new instance type of the instance. For more information, see Primary ApsaraDB RDS instance types. You can also call the DescribeAvailableClasses operation to query the instance types that are supported by an instance.
| rds.mys2.small |
| DBInstanceStorage | integer | No | The new storage capacity of the instance. Unit: GB. You can increase the storage capacity in increments of 5 GB. For more information, see Primary ApsaraDB RDS instance types. You can call the DescribeAvailableClasses operation to query the storage capacity range that is supported by the new instance type.
| 20 |
| PayType | string | No | The billing method of the instance. Valid values:
| Postpaid |
| EffectiveTime | string | No | The time when you want the change to take effect. Valid values:
| MaintainTime |
| EngineVersion | string | No | The database engine version of the instance.
| 5.6 |
| DBInstanceStorageType | string | No | The storage type of the instance. Valid values:
To change the storage type, take note of the following items: If the instance runs PostgreSQL, you can upgrade the storage type of the instance from standard SSD to ESSD. However, you cannot downgrade the storage type of the instance from ESSD to standard SSD. ESSDs provide the following PLs: PL1, PL2, and PL3. You can upgrade or downgrade the storage type between ESSD of PL1, ESSD of PL2, and ESSD of PL3. For more information, see Configuration items. | local_ssd |
| Direction | string | No | The type of change that you want to perform on the instance. Valid values:
Note
If you specify only DBInstanceStorageType, you can leave Direction empty. For example, if you want to change only the storage type of the instance from standard SSD to ESSD, you do not need to specify Direction.
| Up |
| SourceBiz | string | No | A deprecated parameter. You do not need to specify this parameter. | Specifies whether to enable the automatic suspension feature. |
| DedicatedHostGroupId | string | No | The ID of the dedicated cluster. | dhg-7a9******** |
| ZoneId | string | No | The RDS edition of the instance. Valid values:
Note
If you set EngineVersion to an SQL Server version number, you must also specify this parameter.
| cn-hangzhou-b |
| SwitchTime | string | No | The response parameters. | 2019-07-10T13:15:12Z |
| ResourceGroupId | string | No | The ID of the resource group. | rg-acfmy********** |
| UsedTime | long | No | The ID of the order. | 3 |
| ServerlessConfiguration | object | No | The serverless instance on which you want to perform the specification change. | |
| MaxCapacity | double | No | The maximum number of RDS Capacity Units (RCUs). Valid values:
Note
The value of this parameter must be greater than or equal to the value of MinCapacity and can be specified only to an integer.
| 8 |
| MinCapacity | double | No | The minimum number of RCUs. Valid values:
Note
The value of this parameter must be less than or equal to the value of MaxCapacity.
| 0.5 |
| AutoPause | boolean | No | Specifies whether to enable the automatic start and stop feature for the serverless instance. Valid values:
Note
This parameter is required only for serverless instances that run MySQL and PostgreSQL. After the automatic start and stop feature is enabled, if no connections to the instance are established within 10 minutes, the instance is suspended. After a connection to the instance is established, the instance is resumed.
| true |
| SwitchForce | boolean | No | Specifies whether to enable the forced scaling feature for the serverless instance.
Note
| false |
| Category | string | No | The RDS edition of the instance. Valid values:
| HighAvailability |
| BurstingEnabled | boolean | No | An invalid parameter. You do not need to specify this parameter. | false |
| AutoUseCoupon | boolean | No | Specifies whether to use vouchers to offset fees. Valid values:
| false |
| TargetMinorVersion | string | No | The number of the minor version. This parameter is required only for instances that run PostgreSQL. If the minor engine version does not support changing the instance type, you must specify the minor engine version to update the minor engine version when you change the instance type. Format: Note
For more information about minor engine versions, see Release notes for AliPG.
| rds_postgres_1200_20200830 |
Response parameters
Examples
Sample success responses
JSONformat
{
"DBInstanceId": "rm-uf6wjk5*******",
"RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575",
"OrderId": 0
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | CannotDecreaseEssdPerfLevel | cannot decrease cloud essd performance level. | The storage type change failed the verification check. The storage type of an RDS instance that runs SQL Server with standard SSDs or ESSDs cannot be changed to local SSDs. |
| 400 | InvalidEssdStorageSize | invalid cloud essd storage size. | The storage size of cloud disks is invalid. Check the storage size. |
| 400 | Postpaid.NotSupport | Postpaid not supported. | - |
| 400 | InvalidConcurrentOperate | System concurrent operate. | - |
| 400 | NotSupportReduceDiskSize | Not support reduce disk size. | You cannot decrease the disk size. |
| 400 | IncorrectStorageType | Incorrect storage type. | - |
| 400 | TargetStorageLessThanBottomLine | Target storage less than bottom line | - |
| 400 | InstanceHasUnpaidOrder | The specified Instance has unpaid order. | - |
| 400 | InsufficientBalance | Open volume paid cloud database. Your account balance is less than 100 RMB. Top-up and try again. | - |
| 400 | InvalidDBInstanceClass.NotFound | Specified DB instance class is not found. | The configuration or the instance type cannot be found or has been discontinued. Specify a different configuration or a different instance type. |
| 400 | InvalidParameter | The specified parameter "%s" is not valid. | - |
| 400 | InvalidAvZone.Format | Specified AvZone is not valid. | The value of the AvZone parameter is invalid. Check the value of this parameter. |
| 400 | OperationDenied.OrderUnPaid | The operation is not permitted due to the wrong Order status (Unpaid). | The operation failed. You have unpaid orders. Check the unpaid orders in Account Center. |
| 400 | OperationDenied.InvalidStorageSize | The storage size limit is exceeded. | The disk usage exceeds the upper limit. Free or expand disk space. |
| 400 | InsufficientResourceCapacity | The instance cluster does not support this operation. | The operation is not supported for the RDS instance. |
| 400 | InvalidUsedTime | The parameter usedTime is invalid. | The specified usedTime parameter is invalid. |
| 400 | CannotChangeStorageType | Temp upgrade does not support changing storage type. | Elastic upgrade cannot change the storage type. |
| 400 | TempUpgrade.NotSupport | The instance does not support temp upgrade. | This instance does not support elastic upgrade. |
| 400 | EngineNotSupported | Engine specified cannot be supported the operation. | The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance. |
| 400 | MaxscaleNotSupport | Maxscale not supported | Dedicated proxy is not supported by the instance. Please check the configuration information about enabling dedicated proxy. |
| 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 | BYOKInstanceNotSupportThisOperation | The BYOK instance is not supported this operation | This operation is not supported for instances that have disk encryption 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 | SSLInstanceNotSupportThisOperation | The instance opened SSL, upgrade is not this operation | This operation is not supported for instances that have SSL enabled. |
| 400 | TDEInstanceNotSupportThisOperation | The instance opened TDE, this operation is not supported | This operation is not supported for instances that have TDE enabled. |
| 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 | InstanceHasReadOnlyInstanceNotSupportThisOperation | The instance has read-only instance or is read-only instance, this operation is not supported | This operation is not supported because this instance has read-only instances or it is a read-only instance. |
| 400 | InvalidTargetStorageType | Can not change storage type when modify instance class or storage. | - |
| 400 | InvalidTargetCategory | Specified classcode is not matched with current product type. | - |
| 400 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
| 400 | BackupReadInstanceModifyNotAllowed | Modify Backup Read Instance Is Not Allowed. | You are not allowed to modify the instance from which the backup comes. |
| 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. |
| 400 | LX.ARGUMENT.ILLEGAL | The parameters that you specified for the specification change are invalid. | |
| 400 | ORD.S.QUERY.PROD.ERROR | An error occurred while querying the ordering information | An order query error occurred. |
| 400 | InvalidParameter.NotSupportDiskTypeModify | Serverless not support modify disk type! | - |
| 400 | InvalidParameter.NotSupportModifyServerlessConfigAndDiskTogether | Serverless not support modify serverlessconfig and disk together! | - |
| 400 | InvalidParameters.Malformed | One or more of the request parameters provided are not valid. | One or more of the request parameters provided are not valid, please check the API document |
| 400 | DBInstancePayTypeNotSupport | Current instance PayType not support this operation or the param PayType not match current instance PayType. | - |
| 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 | IncorrectTargetClasscode | The current instance type does not support this operation. | This operation is not supported by the instance type. |
| 400 | InvalidPayType.NotSupported | current instance pay type not support this operation. | - |
| 400 | nvalidStorageType.NotSupport | current storage type does not support this operation. | - |
| 400 | OperationDenied.DurationLimit | The duration between two operations should be greater than specified time. | - |
| 400 | AccountMoneyValidate.error | Insufficient funds available in the account. | - |
| 400 | ChangeEngineVersionNotSupported | This operation does not support modifying the engine version. | You cannot modify the major engine version during this operation. |
| 403 | IncorrectDBInstanceType | The database instance type does not support the operation. | The operation failed. The operation is not supported for the database engine of the RDS instance. |
| 403 | OperationDenied.NotSupportedBackupMethod | When the storage is larger than 4000 GB, only snapshot backup is supported. | If the storage capacity is larger than 4,000 GB, only snapshot backup is supported. |
| 403 | IncorrectReadDBInstanceDisksize | Read instance disk size must be equal or higher than primary instance. | The disk size of the read-only instance must be equal to or greater than that of the primary instance. |
| 403 | BetaServerlessNotSupportThisAction | Beta Serverless Not Support This Feature | - |
| 403 | GroupReplicationNotSupport.InvalidEngineVersion | Group Replication requires the instance engine version to be 8.0. | - |
| 403 | GroupReplicationNotSupport.InvalidNodeClassCode | Group Replication requires the ClassCode of each node to be consistent. | - |
| 403 | GroupReplicationNotSupport.InvalidNodeNum | Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3. | - |
| 403 | GroupReplicationNotSupport.InvalidXengine | Group Replication is not supported because the instance has xengine tables. | - |
| 403 | GroupReplicationNotSupport.MemoryTooSmall | Group Replication is not supported because the memory is too small. | - |
| 403 | ARMNotSupport | ARM arch does not support this operation. | - |
| 403 | HostTypeNotSupport | Host type is inconsistent, please check that the original host type is the same as the target host type. | - |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | - |
| 403 | MaxscaleInstanceNotSupport | Instances with maxscale instance do not support this operation. | - |
| 403 | ReadInstanceNotSupport | Instances with read-only do not support this operation. | - |
| 403 | UnSupportReduceDiskSize | Current instance type does not support reducing disk space. | - |
| 403 | CloudboxInstanceNotSupport | Cloud-box instance does not support this operation. | This operation is not supported for instances in cloud boxes. |
| 403 | ReadOnlyInstanceNotSupport | Read-only instance does not support this operation. | This operation is not supported for read-only instances. |
| 403 | MinorVersionNotSupport | Custins minor version does not support current action. | - |
| 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). |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-11-21 | The error codes of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2023-10-13 | The error codes of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2023-08-29 | The error codes of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2023-07-26 | The error codes of the API operation change.,The input parameters of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2023-07-04 | The error codes of the API operation change.,The input parameters of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2023-06-05 | The error codes of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2023-05-09 | The error codes of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2023-04-28 | The error codes of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2023-04-19 | The error codes of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2023-03-16 | The error codes of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2022-12-13 | The error codes of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2022-07-05 | API Description Update,The error codes of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2022-06-23 | The error codes of the API operation change. | see changesets | ||||||||||||
| ||||||||||||||
| 2021-10-19 | The error codes of the API operation change.,The input parameters of the API operation change. | see changesets | ||||||||||||
|