該介面用於變更RDS執行個體的規格和儲存空間等。
介面說明
適用引擎
RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB
計費說明
本 API 操作涉及變配費用,請仔細閱讀相關功能文件後再進行操作。
相關功能文件
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
rds:ModifyDBInstanceSpec |
update |
*DBInstance
|
|
無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBInstanceId |
string |
是 |
執行個體 ID,可呼叫 DescribeDBInstances 取得。 |
rm-uf6wjk5**** |
| DBInstanceClass |
string |
否 |
目標執行個體規格,可呼叫 DescribeAvailableClasses 查詢執行個體可變更規格。 說明
|
mysql.n8.large.2c |
| DBInstanceStorage |
integer |
否 |
目標儲存空間大小,單位 GB,可呼叫 DescribeAvailableClasses 介面查詢目標執行個體規格中可用的儲存空間範圍。 說明
|
100 |
| PayType |
string |
否 |
執行個體當前的付費類型,取值:
說明
如需變更為 Serverless 類型,必須在後續參數中配置自動啟停(AutoPause)、擴縮容範圍(MaxCapacity、MinCapacity)和彈性策略(SwitchForce)。更多資訊,請參見MySQL Serverless 執行個體簡介、SQL Server Serverless 執行個體簡介、PostgreSQL Serverless 執行個體簡介。 |
Postpaid |
| EffectiveTime |
string |
否 |
新配置生效時間,取值: 說明
變更部分配置可能對執行個體產生影響,請仔細閱讀功能文件內的影響章節,再配置該參數,建議在業務低峰期進行。
枚舉值:
|
MaintainTime |
| EngineVersion |
string |
否 |
資料庫版本號,取值: 。 |
8.0 |
| DBInstanceStorageType |
string |
否 |
執行個體儲存類型,取值:
如需變更儲存類型,請注意: 對於 PostgreSQL 執行個體可以將 SSD 雲端硬碟升級為任何 PL 等級的 ESSD 雲端硬碟,但不支援將 ESSD 雲端硬碟降級為 SSD 雲端硬碟。。 |
local_ssd |
| ReadOnlyDBInstanceClass |
string |
否 |
MySQL 高可用高效能本機磁碟執行個體變配為雲端硬碟執行個體時,唯讀執行個體的目標規格。 |
mysqlro.n2.large.1c |
| Direction |
string |
否 |
執行個體變配類型,取值:
說明
如果僅變更 DBInstanceStorageType 參數,例如將 SSD 雲端硬碟變更為 ESSD 雲端硬碟,則此參數留空。 |
Up |
| SourceBiz |
string |
否 |
棄用參數,無需配置。 |
test |
| DedicatedHostGroupId |
string |
否 |
專屬叢集 ID。 |
dhg-7a9**** |
| ZoneId |
string |
否 |
可用區 ID。 |
cn-hangzhou-b |
| SwitchTime |
string |
否 |
指定執行變配的時間,建議在業務低峰期執行變配。 格式:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
|
2019-07-10T13:15:12Z |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-acfmy**** |
| UsedTime |
integer |
否 |
SQL Server彈性升級時間。單位:天。 |
3 |
| ServerlessConfiguration |
object |
否 |
變配 Serverless 執行個體。 |
|
| AutoPause |
boolean |
否 |
MySQL Serverless 或 PostgreSQL Serverless 執行個體的智慧暫停和啟動,取值:
說明
如果 10 分鐘無任何連線將進入暫停狀態,當連線進入時會自動喚醒。 |
true |
| MaxCapacity |
number |
否 |
Serverless 執行個體 RCU 的自動擴縮範圍最大值,取值:
說明
該值必須大於等於 MinCapacity。 |
8 |
| MinCapacity |
number |
否 |
Serverless 執行個體 RCU 的自動擴縮範圍最小值,取值:
說明
該值必須小於等於 MaxCapacity。 |
0.5 |
| SwitchForce |
boolean |
否 |
MySQL Serverless 或 PostgreSQL Serverless 執行個體的強制彈性擴縮容。執行個體 RCU 的彈性擴縮容通常會立刻生效,但在某些特殊情況下(例如大事務執行中)無法即刻完成擴縮容,此時可開啟本參數進行強制擴縮容。取值:
說明
開啟該參數後,執行個體進行強制擴縮容時會出現 30~120 秒的服務不可用,請根據實際情況謹慎使用。 |
false |
| Category |
string |
否 |
執行個體系列,取值: 說明
EngineVersion 為 SQL Server 版本號時,此項必填。 。 |
HighAvailability |
| BurstingEnabled |
boolean |
否 |
高效能雲端硬碟 IO 效能突發功能開關,取值:
|
false |
| AutoUseCoupon |
boolean |
否 |
是否使用代金券抵扣費用,取值:
|
true |
| TargetMinorVersion |
string |
否 |
PostgreSQL 執行個體核心小版本號。當變更執行個體規格並且報錯核心小版本不支援時,需要傳入核心小版本號,用於在變更執行個體規格時升級核心小版本。 格式: |
rds_postgres_1200_20200830 |
| IoAccelerationEnabled |
string |
否 |
高效能雲端硬碟Buffer Pool Extension(BPE)功能,取值:
|
0 |
| ColdDataEnabled |
boolean |
否 |
高效能雲端硬碟資料歸檔功能,取值:
|
true |
| ZoneIdSlave1 |
string |
否 |
備節點可用區 ID。如果和 ZoneId 相同,則為單可用區部署;如果和 ZoneId 不同,則為多可用區部署。 說明
僅 SQL Server 執行個體選擇升級大版本時(AllowMajorVersionUpgrade)需要指定備可用區,或者切換備可用區時需要設定該參數。 |
cn-hangzhou-c |
| VSwitchId |
string |
否 |
虛擬交換機 ID。虛擬交換機所在的可用區必須和 ZoneId 中傳入的可用區 ID 相對應。
說明
僅 SQL Server 執行個體選擇升級大版本時(AllowMajorVersionUpgrade)需要指定交換機,或者切換交換機時需要設定該參數。 |
vsw-bp1oxflciovg9l7****** |
| AllowMajorVersionUpgrade |
boolean |
否 |
SQL Server 執行個體大版本升級,取值:
說明
|
false |
| PromotionCode |
string |
否 |
優惠券 code。 |
72329885**** |
| OptimizedWrites |
string |
否 |
MySQL 16K 原子寫功能開關,取值:
|
optimized |
| CompressionMode |
string |
否 |
MySQL儲存壓縮功能,取值:
|
on |
| AllocateStrategy |
string |
否 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數詳情。 |
||
| DBInstanceId |
string |
執行個體 ID。 |
rm-uf6wjk5**** |
| OrderId |
integer |
訂單 ID。 |
20793850608**** |
| RequestId |
string |
請求 ID。 |
3C5CFDEE-F774-4DED-89A2-1D76EC63C575 |
樣本
正常返回樣本
JSON格式
{
"DBInstanceId": "rm-uf6wjk5****",
"OrderId": 0,
"RequestId": "3C5CFDEE-F774-4DED-89A2-1D76EC63C575"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidAllocateStrategy | The Specified Allocate Strategy is not valid. | |
| 400 | DbVersionUpgradeNotSatisfied | message:%s | |
| 400 | UnsupportedReduceDiskSize | %s%s | |
| 400 | CannotDecreaseEssdPerfLevel | cannot decrease cloud essd performance level. | |
| 400 | InvalidEssdStorageSize | invalid cloud essd storage size. | |
| 400 | Postpaid.NotSupport | Postpaid not supported. | |
| 400 | InvalidConcurrentOperate | System concurrent operate. | |
| 400 | NotSupportReduceDiskSize | Not support reduce 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. | |
| 400 | InvalidParameter | The specified parameter "%s" is not valid. | |
| 400 | InvalidAvZone.Format | Specified AvZone is not valid. | |
| 400 | OperationDenied.OrderUnPaid | The operation is not permitted due to the wrong Order status (Unpaid). | |
| 400 | OperationDenied.InvalidStorageSize | The storage size limit is exceeded. | |
| 400 | InsufficientResourceCapacity | The instance cluster does not support this operation. | |
| 400 | InvalidUsedTime | The parameter usedTime is invalid. | |
| 400 | CannotChangeStorageType | Temp upgrade does not support changing storage type. | |
| 400 | TempUpgrade.NotSupport | The instance does not support temp upgrade. | |
| 400 | EngineNotSupported | Engine specified cannot be supported the operation. | |
| 400 | MaxscaleNotSupport | Maxscale not supported | |
| 400 | ADInstanceNotSupportThisOperation | The AD instance is not supported this operation | |
| 400 | BYOKInstanceNotSupportThisOperation | The BYOK instance is not supported this operation | |
| 400 | BYOLInstanceNotSupportThisOperation | The BYOL instance is not supported this operation | |
| 400 | SSLInstanceNotSupportThisOperation | The instance opened SSL, upgrade is not this operation | |
| 400 | TDEInstanceNotSupportThisOperation | The instance opened TDE, this operation is not supported | |
| 400 | InstanceIsSnapshotBackupNotSupportThisOperation | The instance backup method is snapshot backup, this operation is not supported | |
| 400 | InstanceHasReadOnlyInstanceNotSupportThisOperation | The instance has read-only instance or is read-only instance, this operation is not supported | |
| 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. | |
| 400 | MinorVersionNotSupport | The current database minor version does not support the operation. | |
| 400 | LX.ARGUMENT.ILLEGAL | 变配,当前实例无有效配置 | |
| 400 | ORD.S.QUERY.PROD.ERROR | An error occurred while querying the ordering information | |
| 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. | |
| 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. | |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | |
| 400 | InvalidPayType.NotSupported | current instance pay type 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. | |
| 400 | InvalidDBInstanceStorageType | The specified DBInstanceStorageType is invalid. | |
| 400 | EncryptionInstancesNotSupport | Cloud disk encryption instances that use byok do not support modify to multi tenant. | |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | |
| 400 | Price.CommoditySys | Commodity system call exception. | |
| 400 | CurrentInsHasColdDB | The current instance has cold storage db. | |
| 400 | CurrentInsHasColdStorage | Current instance has cold storage. | |
| 400 | InsufficientResourceCapacityCheck | There is insufficient capacity available for the requested instance with precheck. | |
| 400 | InvalidStorageSize.Direction | The specified parameter StorageSize does not meet the updating direction constraint requirements. | |
| 400 | InvalidStorageType.Direction | The specified parameter StorageType does not meet the updating direction constraint requirements. | |
| 400 | EngineNotSupportShrinkStorage | The current engine does not support shrinking storage space. | |
| 400 | InvalidSourceCategory | specified source category is invalid. | |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | |
| 400 | InvalidRCUValue | scaleMin and scaleMax range is not valid. | |
| 400 | ServiceLinkedRole.NotExist | SLR does not exist, you needs to create SLR first. | |
| 400 | ParamGroupOptionValue.NotSupport | Specified option value unsupported. | |
| 400 | CreateUpgradeOrderBusinessException | The parameter is illegal or empty. | |
| 400 | InvalidReadDBInstanceStorage.Format | Specified Storage is not valid, Read DB Instance storage size must be greater than or equal to primary DB Instance. | |
| 400 | UnsupportedModifyParam | Burst param must be only modified. | |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | |
| 400 | InvalidRequestId | The request is copy, check your token. | |
| 400 | UnsupportExtendDisk.NotSupport | Specified DB instance is unsupport extend disk. | |
| 400 | Order.InstHasUnsettledBills | You currently have outstanding bills, please settle them first. | |
| 400 | CheckAllowMajorVersionUpgradeFailed | We have detected that you want to upgrade the version of the instance, but the parameter allowMajorVersionUpgrade is false. If you want to upgrade the version of the instance, please set the parameter allowMajorVersionUpgrade to true. | |
| 400 | IncorrectDBSslStatus | Specified DB SSLStatus does not support this operation. | |
| 400 | UpgradeEngineVersionCannotChangeStorage | Upgrade engine version can not change storage size. | |
| 400 | ReadOnlyInsNotSupported | Instances containing read-only instances do not allow this operation. | |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | |
| 400 | Price.PricingPlanResultNotFound | 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. | |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | |
| 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. | |
| 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. | |
| 400 | Order.PeriodInvalid | 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. | |
| 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. | |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | |
| 400 | Api.NotSupport | Specified api is not supported. | |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | |
| 400 | RequiredParam.NotFound | Required input param is not found. | |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | |
| 400 | Pay.NoCreditCard | No credit cards. | |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | |
| 400 | OrdTCommodityQueryError | Failed to query for product. | |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | |
| 400 | InvalidDBInstanceClass.NotSupport | The target primary db instance class can not lower than the original primary db instance class. | |
| 400 | InvalidPayType.NotSame | All primary and read-only instances should have the same payment type. | |
| 400 | InvalidReadOnlyDBInstanceClass.NotSupport | The target read-only db instance class can not lower than the original read-only db instance class. | |
| 400 | InvalidStorageSize.CannotChange | Can not change storage size in this operation. If you need to change disk type, please change storage size first, and the storage size must meet your target disk type's constraint requirements. | |
| 400 | InvalidStorageSize.ConstraintUnsatisfied | The db instance's storage size dose not meet the constraint requirements of the parameter DBInstanceStorageType. If you still want to change disk type, please change storage size to meet the target disk type's constraint in other operation. | |
| 400 | ReadonlyDBInstanceClassEmpty | The read-only target instance class should not be empty. | |
| 400 | ReadonlyDBInstanceClassNotSame | All readonly db instances should have the same instance class. | |
| 400 | StopService.ModifyDBInstanceSpec | The service has been discontinued and does not permit resizing operations on instances using the classic network. | |
| 400 | InvalidParam.DiskSize | %s. | |
| 400 | InvalidOrder.NotFound | Specified order does not exist in RDS. | |
| 400 | NotFindAvailableVswitch | Secondary zone, no available switch found under the current vpc. | |
| 400 | InvalidStorageType.NotSupport | The current storage type does not support this operation. | |
| 400 | IncorrectReadDBInstanceMemSize | The instance type of read-only instance is too small. | |
| 400 | DBInstanceNotServerless | The dbinstance is not serverless. | |
| 400 | UnSupportDbTypeReduceDiskSize | The current instance does not support scale-in. | |
| 400 | ClassicNetDisabled | The classic network address is currently disabled, and the instance cannot perform configuration changes. | |
| 400 | SecondaryAddrNotSupportThisOperation | The instance has a secondary instance address, so updates are not allowed. | |
| 400 | InvalidMasterDBInstanceName.NotFound | The master instance does not exist under the target account. | |
| 500 | CallLxSdkFailed | Error calling the order system, please try again later or contact service personnel. | |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | |
| 403 | IncorrectDBInstanceType | The database instance type does not support the operation. | |
| 403 | OperationDenied.NotSupportedBackupMethod | When the storage is larger than 4000 GB, only snapshot backup is supported. | |
| 403 | IncorrectReadDBInstanceDisksize | Read instance disk size must be equal or higher than 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. | |
| 403 | ReadOnlyInstanceNotSupport | Read-only instance does not support this operation. | |
| 403 | MinorVersionNotSupport | The current database minor version does not support the operation. | |
| 403 | ShrinkCountReachedLimit | Current DB shrink count reached the limit. | |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | |
| 403 | CloudDiskEncryptionNotSupport | The encryption key is not allowed for general-purpose instance. | |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | |
| 403 | NotInFlowController | Sorry,no permission. | |
| 403 | InvalidKmsKey | Kms key is disabled. | |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | |
| 403 | UnsupportedByBlueGreenDeployment | Operation prohibited due to blue green deployment. | |
| 403 | UnSupportNonXfsDiskSizeTooLarge | Non xfs disk types do not support upgrading to 60T or above. | |
| 403 | OperationDenied.SystemConcurrent | Failure caused by Concurrent operations. | |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | |
| 404 | InvalidParam | The parameter is invalid. | |
| 404 | Request.NotFound | The requested resource is not available. | |
| 404 | HostInfo.NotFound | The specified host info is not found. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。