該介面用於遷移RDS執行個體的可用性區域。
介面說明
適用引擎
RDS MySQL
RDS PostgreSQL
RDS SQL Server
相關功能文檔
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBInstanceId |
string |
是 |
執行個體 ID。可調用 DescribeDBInstances 擷取。 |
rm-uf6wjk5**** |
| VPCId |
string |
否 |
Virtual Private Cloud ID。遷移可用性區域時 VPC 不能變更,需保持不變。
|
vpc-**** |
| ZoneId |
string |
是 |
目標可用性區域 ID,可調用 DescribeRegions 擷取。 |
cn-hangzhou-b |
| EffectiveTime |
string |
否 |
生效時間,取值:
說明
如果在本參數中傳入 ScheduleTime,則還需要傳入 SwitchTime 參數。 |
Immediate |
| VSwitchId |
string |
否 |
交換器 ID。
|
vsw-uf6adz52c2p**** |
| Category |
string |
否 |
執行個體系列,取值:
|
HighAvailability |
| ZoneIdSlave1 |
string |
否 |
備可用性區域 1。 說明
非基礎系列執行個體需要傳入該參數。 |
cn-hangzhou-c |
| ZoneIdSlave2 |
string |
否 |
備可用性區域 2。 說明
僅三節點企業系列執行個體可傳入該參數。 |
cn-hangzhou-d |
| SwitchTime |
string |
否 |
切換可用性區域的自訂生效時間。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
本參數配合 EffectiveTime 參數使用,僅在 EffectiveTime 為 ScheduleTime 時需要傳入。 |
2021-12-14T15:15:15Z |
| IsModifySpec |
string |
否 |
是否在遷移可用性區域時變更配置。
說明
該參數僅 RDS MySQL 執行個體適用。 |
true |
| DBInstanceClass |
string |
否 |
目標執行個體規格代碼,只支援變更規格,不支援變更儲存類型。 當 IsModifySpec 參數配置為 true 時,至少需要配置本參數和 DBInstanceStorage 中的一個。 執行個體規格代碼請參見RDS MySQL 主執行個體規格列表。 |
mysql.x4.xlarge.2 |
| DBInstanceStorage |
integer |
否 |
目標儲存空間大小。當 IsModifySpec 參數配置為 true 時,至少需要配置本參數和 DBInstanceClass 中的一個。 單位:GB。 取值範圍:不同規格可擴容儲存空間大小不同,具體請以RDS MySQL 主執行個體規格列表為準。 |
500 |
| IoAccelerationEnabled |
string |
否 |
高效能雲端硬碟的 Buffer Pool Extension(BPE)功能開關,參數:
說明
Buffer Pool Extension(BPE)功能的更多資訊,請參見Buffer Pool Extension(BPE)。 |
0 |
| DBInstanceStorageType |
string |
否 |
執行個體儲存類型,取值:
|
cloud_essd |
| CustomExtraInfo |
string |
否 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數詳情。 |
||
| DBInstanceId |
string |
執行個體 ID。 |
rm-uf6wjk5**** |
| OrderId |
integer |
訂單 ID,僅 MySQL 執行個體適用。 |
21334157599**** |
| RequestId |
string |
請求 ID。 |
65BDA532-28AF-4122-AA39-B382721EEE64 |
樣本
正常返回樣本
JSON格式
{
"DBInstanceId": "rm-uf6wjk5****",
"OrderId": 0,
"RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | RenewChange.Exist | The Current InstanceId existed renewChange order in RDS. | 當前存在變更配置任務未完成,請等待完成後重試。 |
| 400 | InvalidInstanceCommodityCode.NotFound | Parse commodityCode from lx and instance fail. | |
| 400 | InvalidMigrateModifyClassOrStorage | Specified parameter DBInstanceClass or Storage is invalid. | 指定的參數DBInstanceClass或Storage無效. |
| 400 | EngineNotSupported | Engine specified cannot be supported the operation. | 操作失敗,當前引擎不支援此操作,請升級核心小版本。 |
| 400 | IncorrectDBInstanceLockMode.ValueNotSupported | The Current DB instance lock mode does not support this operation. | 操作失敗,當前資料庫執行個體鎖模式不支援此操作。 |
| 400 | InvalidZoneId.NotNull | The parameter ZoneId must not be null or auto | 參數ZoneId不能為null或auto |
| 400 | InvalidZoneId.NotEqual | The parameter ZoneId is the same as the previous one | 操作失敗,兩個可用性區域相同。 |
| 400 | InvalidDispenseMode.Format | The specified dispense mode is not valid. | |
| 400 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | |
| 400 | ZoneId.NotMatchWithCategory | The Number of ZoneId specified does not match with category | |
| 400 | InvalidDefaultVSwitch.NotFound | The specified default virtual switch is not found in specified VPC. | |
| 400 | InsufficientResourceCapacityCheck | There is insufficient capacity available for the requested instance with precheck. | 具有預檢查的請求執行個體的可用容量不足。 |
| 400 | UnsupportedReadOrBakReadState | Current DB instance has read or bak read instance running in unsupported states | |
| 400 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | 當前資料庫執行個體鏡像已存在。 |
| 400 | SSLInstanceNotSupportThisOperation | The instance opened SSL, upgrade is not this operation | 開啟SSL功能的執行個體不支援此操作 |
| 400 | BYOLInstanceNotSupportThisOperation | The BYOL instance is not supported this operation | BYOL執行個體不支援此操作 |
| 400 | BYOKInstanceNotSupportThisOperation | The BYOK instance is not supported this operation | 開啟雲端硬碟加密功能的執行個體不支援此操作 |
| 400 | ADInstanceNotSupportThisOperation | The AD instance is not supported this operation | 加入AD域的執行個體不支援此操作 |
| 400 | TDEInstanceNotSupportThisOperation | The instance opened TDE, this operation is not supported | 開啟TDE功能的執行個體不支援此操作 |
| 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 | VswitchIpExhausted | No available ip in the specified vswitch. | 指定的vswitch中沒有可用的IP。 |
| 400 | OperationDenied.MasterDBInstanceState | The operation is not permitted due to status of master instance. | 操作失敗,當前唯讀執行個體正在變更,此狀態下主執行個體不支援此操作,請等待唯讀執行個體完成後,再進行重試。 |
| 400 | InvalidShareInstance.NotSupport | The share dbInstance is not support. | 共用型執行個體不支援 |
| 400 | InvalidZoneIdSlave1.Missing | The parameter ZoneIdSlave1 must be specified. | 備可用性區域ID不可為空。 |
| 400 | MigrateAlreadyExistsFault | The rds instance already has a given vpc migrate task. | RDS執行個體檔已存在一個VPC遷移任務。 |
| 400 | InvalidInstanceKind.NotSupport | The instance kind does not support this operation. | 執行個體類型不支援此操作。 |
| 400 | MissingCategory | The instance is missing a category parameter. | 執行個體缺少類別參數。 |
| 400 | InvalidInstanceNodeType.NotFound | The specified NodeType is not found. | |
| 400 | EngineVersionNotSupported | EngineVersion specified cannot be replicate with the source DB Instance. | 當前資料庫引擎版本不支援複製執行個體。 |
| 400 | CommodityCodeNotFound | CommodityCodeNotFound | 指定的參數CommodityCode無效,請檢查該參數的正確性。 |
| 400 | InvalidTunnelId | Specified conn tunnel is not valid. | 指定的串連通道無效。 |
| 400 | SSLNotSupport | The CharacterType of instance does not support SSL. | 執行個體的字元類型不支援SSL。 |
| 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. | 您的賬戶可用額度小於0,請先儲值後再嘗試購買。 |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | 調用商品服務返回失敗。 |
| 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 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | 您購買的模組不合法,請重新購買。 |
| 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 | Price.CommoditySys | Commodity system call exception. | 商品系統調用異常。 |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | 可用金不足。 |
| 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. | 提供的DBInstanceId不存在。 |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | 當前執行個體規格不支援該儲存類型。 |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | 指定的 wal_level 參數無效。執行個體中仍然存在複製槽,因此無法將其設定為replica。 |
| 400 | KmsApiError | User secret key invalid. | 使用者密鑰失效。 |
| 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. | sql命令執行失敗或執行逾時 |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | 當前執行個體引擎版本不支援歸檔冷資料。 |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | 當前核心版本不支援歸檔冷資料。 |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | 當前規格不支援此操作。 |
| 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. | DB執行個體引擎類型不支援此操作。 |
| 400 | Pay.NoCreditCard | No credit cards. | 無信用卡。 |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | vpc網路類型執行個體不支援此操作。 |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | 執行個體規格停止售賣。 |
| 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 | UnSupportDbTypeReduceDiskSize | The current instance does not support scale-in. | 當前執行個體不支援縮容。 |
| 400 | UnsupportedReduceDiskSize | Current Instance not support reduce disk size less than limit size. | 當前執行個體不支援將磁碟大小減少到小於限制大小。 |
| 400 | UnsupportExtendDisk.NotSupport | Specified DB instance is unsupport extend disk. | 指定的執行個體不支援擴充磁碟。 |
| 400 | ClassicNetDisabled | The classic network address is currently disabled, and the instance cannot perform configuration changes. | 傳統網路地址當前已禁用,執行個體無法執行配置更改。 |
| 400 | InvalidParamForXfs | Xfs instance must be single tenant standard instance. | Xfs執行個體必須是獨享高可用執行個體。 |
| 400 | InstanceHasLinkedServerInfo | The instance has linked server info, please delete linked server info first. | 當前執行個體存在連結的伺服器,請先刪除之後進行可用性區域遷移。 |
| 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. | 由於rds api服務失敗,請求處理失敗。 |
| 403 | OperationDenied.OutofUsage | The resource is out of usage. | 當前叢集的資源不足,請選擇其它可用性區域。 |
| 403 | IncorrectEffectiveTime | The specified EffectiveTime params is not valid. | EffectiveTime參數無效。 |
| 403 | InvalidTempInstance.NotSupport | The temp db Instance is not support. | 操作失敗,當前執行個體已被鎖定。 |
| 403 | OperationDenied.LockMode | The operation is not permitted due to instance being locked. | 執行個體鎖定中,不支援該操作。請檢查執行個體的儲存空間是否已滿,或者執行個體是否已到期。若磁碟空間已滿,請進行變更配置,擴大儲存空間後即可解鎖;若執行個體已到期,續約後即可解鎖。 |
| 403 | ClassicNetworkType.NotSupport | The Classic instance network create is not support. | 操作失敗,當前執行個體不支援建立傳統網路類型,請建立其他網路類型的執行個體。 |
| 403 | InstanceNetworkTypeNotFoundFault | The specified DBInstanceNetworkType is not found. | 檢查網路類型失敗,執行個體網路類型不存在。 |
| 403 | ProprietaryCloud.NotSupported | The proprietary cloud not supported. | 專有雲不支援。 |
| 403 | MigrateAlreadyReadWriteSplitExistsFault | The rds instance already has a given vpc migrate task. | RDS執行個體已存在指定VPC遷移任務。 |
| 403 | InvalidRegionAvzNotFound | Specified user does not find the region and avz. | 指定的使用者找不到地區和avz。 |
| 403 | ZoneIdNotSupported | The zone ID is not supported. | 操作失敗,不支援地區ID。 |
| 403 | InvalidVpcInfo.NotFound | Specified VPC info does not exist. | 指定的VPC資訊不存在。 |
| 403 | InvalidMultiparamZoneInfoList | Zoneinfo list is invaild. | 當前主可用性區域未對齊,無法遷移主庫 |
| 403 | MigrateSlaveNotSupport | Current DB instance state does not support migrating slave, please switch the Primary/Secondary Instance first. | 當前執行個體的狀態不支援僅遷移備庫,強行遷移會導致訪問資料庫的效能下降,請先做一次 HA 切換。 |
| 403 | CloudDiskEncryptionNotSupport | The encryption key is not allowed for general-purpose instance. | 通用型規格執行個體不支援雲端硬碟加密。 |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 當前引擎小版本不支援此操作。 |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | 執行個體當前存在未支付訂單,請支付後重試。 |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | 縮容目標容量不能小於當前儲存空間使用量 |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | SSD盤不支援此操作,請升級至ESSD。 |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | 使用者權限不支援此操作。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正確或為空白 |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | 沒有可用的庫存地區。 |
| 403 | NotInFlowController | Sorry,no permission. | 非集團上雲使用者不可用,無許可權。 |
| 403 | InvalidKmsKey | Kms key is disabled. | Kms key已禁用。 |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | 當前資料庫執行個體層級不支援此操作。 |
| 403 | InstanceEngineType.NotSupport | The instance engine and type does not support operations. | RDS MySQL執行個體引擎和類型不支援此操作,請檢查執行個體kindcode和核心小版本是否過低,升級核心小版本。 |
| 403 | UnsupportedByBlueGreenDeployment | Operation prohibited due to blue green deployment. | 操作不允許因為存在藍綠部署。 |
| 403 | CurrentRecoveryModelNotSupportThisAction | Current recovery model not supported this action. | 當前的復原模式不支援此操作 |
| 403 | UnSupportNonXfsDiskSizeTooLarge | Non xfs disk types do not support upgrading to 60T or above. | 非xfs磁碟類型不支援升級到60T或更高。 |
| 403 | ShrinkCountReachedLimit | Current DB shrink count reached the limit. | 當前資料庫收縮計數已達到限制。 |
| 403 | IncorrectReadDBInstanceDisksize | Read instance disk size must be equal or higher than primary instance. | 唯讀執行個體磁碟大小必須等於或大於主執行個體。 |
| 404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 資料庫執行個體名稱不存在。請確認資料名稱是否正確。 |
| 404 | IncorrectVswitchId | The specified parameter VSwitchId is not valid. | 交換器參數無效。 |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | 當前執行個體未授權存取金鑰管理服務。 |
| 404 | Request.NotFound | The requested resource is not available. | 請求的資源不可用。 |
| 404 | HostInfo.NotFound | The specified host info is not found. | 指定的主機資訊不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。