該介面用於跨地區恢複資料到新執行個體。
介面說明
使用建議
恢複前建議先調用 CheckCreateDdrDBInstance 介面預檢查目標 RDS 執行個體的跨地區備份組是否可以用於進行跨地區恢複。
適用引擎
RDS MySQL
RDS PostgreSQL
RDS SQL Server
相關功能文檔
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
rds:CreateDdrInstance |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
目標地區 ID,可以通過介面 DescribeRegions 查看地區 ID。 |
cn-hangzhou |
| Engine |
string |
是 |
目標資料庫類型,取值:
|
MySQL |
| EngineVersion |
string |
是 |
目標資料庫版本。根據 Engine 參數取值的不同,本參數取值如下:
說明
SQL Server 執行個體中 |
5.6 |
| DBInstanceClass |
string |
否 |
目標執行個體規格,詳見執行個體規格表。 |
rds.mysql.s1.small |
| DBInstanceStorage |
integer |
否 |
目標執行個體儲存空間,取值:5~2000。 每 5 GB 進行遞增,單位:GB。詳見執行個體規格表。 |
20 |
| SystemDBCharset |
string |
否 |
目標執行個體的字元集,取值:
|
uft8 |
| DBInstanceNetType |
string |
是 |
目標執行個體的網路連接類型,取值:
|
Intranet |
| DBInstanceDescription |
string |
否 |
目標執行個體名稱,長度為 2~256 個字元。以中文、英文字母開頭,可以包含數字、中文、英文、底線(_)、虛線(-)。 說明
不能以 |
testdb |
| SecurityIPList |
string |
是 |
目標執行個體的 IP 白名單,多個 IP 位址請以半形逗號(,)隔開,不可重複,最多 1000 個。支援如下兩種格式:
|
127.0.0.1 |
| ClientToken |
string |
否 |
用於保證請求的等冪性,防止重複提交請求。由用戶端產生該參數值,要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字元,且該參數值中不能包含非 ASCII 字元。 |
ETnLKlblzczshOTUbOCz**** |
| PayType |
string |
是 |
目標執行個體的付費類型,取值:
|
Prepaid |
| ZoneId |
string |
否 |
目標執行個體的可用性區域 ID。多可用性區域用英文冒號(:)分隔。 說明
指定了 VPC 和交換器時,為匹配交換器對應的可用性區域,該參數必填。 |
cn-hangzhou-b |
| InstanceNetworkType |
string |
否 |
目標執行個體的網路類型,取值:
說明
選擇 VPC 時,還需要傳入參數 VpcId、VSwitchId。 |
Classic |
| ConnectionMode |
string |
否 |
目標執行個體的訪問模式,取值:
|
Standard |
| VPCId |
string |
否 |
目標執行個體的 VPC ID。 說明
|
vpc-**** |
| VSwitchId |
string |
否 |
目標執行個體的虛擬交換器 ID,多個值用半形逗號(,)隔開。 說明
|
vsw-**** |
| PrivateIpAddress |
string |
否 |
設定目標執行個體的內網 IP,需要在指定交換器的 IP 位址範圍內。系統預設通過 VPCId 和 VSwitchId 自動分配。 |
172.XX.XX.69 |
| UsedTime |
string |
否 |
指定購買時間長度,取值:
說明
若付費類型為 Prepaid,本參數必填。 |
2 |
| Period |
string |
否 |
指定預付費目標執行個體為包年或者包月類型,取值:
說明
若付費類型為 Prepaid,本參數必填。 |
Year |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-acfmy**** |
| RestoreType |
string |
是 |
恢複方式,取值:
|
BackupSet |
| BackupSetId |
string |
否 |
基於備份組恢複時,使用的備份組的 ID。可以通過介面 DescribeCrossRegionBackups 查看備份組 ID。 說明
RestoreType=BackupSet 時,本參數必填。 |
14**** |
| BackupSetRegion |
string |
否 |
備份組所在地區。 |
cn-beijing |
| RestoreTime |
string |
否 |
基於時間點恢複時,要恢複的時間節點,需要早於目前時間。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
RestoreType=BackupTime 時,本參數必填。 |
2019-05-30T03:29:10Z |
| SourceRegion |
string |
否 |
基於時間點恢複時,源地區的 ID。 說明
RestoreType=BackupTime 時,本參數必填。 |
cn-hangzhou |
| SourceDBInstanceName |
string |
否 |
基於時間點恢複時,源執行個體的 ID。 說明
RestoreType=BackupTime 時,本參數必填。 |
rm-uf6wjk5**** |
| DBInstanceStorageType |
string |
否 |
目標執行個體儲存類型,取值: 說明
建議和源執行個體的儲存類型保持一致。 |
local_ssd |
| RoleARN |
string |
否 |
SQL Server 執行個體主帳號授權 RDS 雲端服務帳號訪問 KMS 許可權的全域資源描述符(ARN)。您可以通過 CheckCloudResourceAuthorized 介面查看 ARN 資訊。 |
acs:ram::1406****:role/aliyunrdsinstanceencryptiondefaultrole |
| EncryptionKey |
string |
否 |
SQL Server 執行個體使用者自訂雲端硬碟加密的金鑰識別碼。傳入此參數表示開啟雲端硬碟加密(開啟後無法關閉),並且需要傳入 RoleARN。 您可以在Key Management Service控制台查看金鑰識別碼,也可以建立新的密鑰。 說明
您也可不傳此參數,僅需要傳入 RoleARN,表示設定執行個體的雲端硬碟加密類型為 RDS 託管的服務密鑰(Default Service CMK)。 |
749c1df7-****-****-****-**** |
SQL Server 使用樣本
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數詳情。 |
||
| ConnectionString |
string |
新執行個體串連地址。 說明
參數 DBInstanceNetType 決定該地址為內網或外網。 |
rm-****.mysql.rds.aliyuncs.com |
| DBInstanceId |
string |
新執行個體 ID。 |
rm-**** |
| OrderId |
string |
訂單 ID。 |
2038691**** |
| Port |
string |
新執行個體串連連接埠。 說明
參數 DBInstanceNetType 決定該連接埠為內網連接埠或外網連接埠。 |
3306 |
| RequestId |
string |
請求 ID。 |
E52666CC-330E-418A-8E5B-A19E3FB42D13 |
樣本
正常返回樣本
JSON格式
{
"ConnectionString": "rm-****.mysql.rds.aliyuncs.com",
"DBInstanceId": "rm-****",
"OrderId": "2038691****",
"Port": "3306",
"RequestId": "E52666CC-330E-418A-8E5B-A19E3FB42D13"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidZoneId.NotSupported | The Specified vpc Zone not supported. | 當前可用性區域不支援建立VPC網路類型執行個體,請更換可用性區域。 |
| 400 | InvalidDBInstanceName.Format | Specified DB instance name is not valid. | 當前執行個體不存在,請檢查該執行個體是否存在。 |
| 400 | InvalidDBInstanceName.Duplicate | Specified DB instance name already exists in the Aliyun RDS. | 操作失敗,執行個體名稱已存在,請修改執行個體名稱後重試。 |
| 400 | InvalidRegion.Format | Specified Region is not valid. | 指定的地區不合法,請檢查該參數的正確性。 |
| 400 | InvalidServiceType.Format | Specified service type is not valid. | 無效的服務類型。請重新設定,0為aliyun服務,1為jst服務。 |
| 400 | InvalidEngine.Malformed | Specified engine is not valid. | 當前資料庫引擎無效,請選擇正確的資料庫引擎。 |
| 400 | InvalidEngineVersion.Malformed | Specified engine version is not valid. | 資料庫引擎版本無效,請確認後重試。 |
| 400 | InvalidConnectionString.Format | Specified connection string is not valid. | 執行個體串連地址的字串格式不正確。字串前置長度為5~40。 |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the Aliyun RDS. | |
| 400 | InvalidCharacterSetName.Format | Specified character set name is not valid. | 字元集格式不正確。RDS支援如下格式的字元集:gbk,utf8,euckr,ascii。 |
| 400 | InvalidDBInstanceType.Format | Specified instance type is not valid. | 操作失敗,指定執行個體類型無效。請選擇正確的執行個體類型。 |
| 400 | InvalidPort.Malformed | Specified port is not valid. | 指定的連接埠無效。 |
| 400 | InvalidBackupRetentionPeriod.Malformed | Specified backup retention period is not valid. | 備份周期無效。備份周期需大於1天或小於等於30天。 |
| 400 | InvalidPreferredBackupTime.Format | Specified preferred backup time is not valid. | 期望備份日期的格式不正確。格式要求為標準GMT格式,即YYYY-MM-DDThh:mmZ。例如:2012-06-11T15:00Z |
| 400 | InvalidPreferredBackupPeriod.Malformed | Specified backup period is not valid. | 備份時間無效。 |
| 400 | InvalidOptmizationService | Specified optmization service is not valid. | |
| 400 | InvalidExpiredTime.Format | Specified expired time is not valid. | 失效時間格式(ExpiredTime)不正確,格式要求如下:yyyy-MM-ddTHH:mm:ssZ(UTC時間)。 |
| 400 | InvalidSecurityIPList.Format | Specified security IP list format is not valid. | 指定的IP List格式不符合要求,請檢查格式規範 |
| 400 | InvalidSecurityIPList.Duplicate | Specified security IP list is not valid: Duplicate IP address in the list | 指定的安全IP列表無效。其中包含重複值。 |
| 400 | InvalidSecurityIPList.QuotaExceeded | Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list. | 指定的安全IP列表中包含的IP地址數超過允許上限。SecurityIPList支援最多1000個IP地址。 |
| 400 | InvalidDBInstanceDescription.Format | Specified DB instance description is not valid. | 參數DBInstanceDescription無效,請檢查參數正確性。參數需符合以下規則:長度為2~256個字元。以中文、英文字母開頭,可以包含數字、中文、英文、底線(_)、虛線(-)。 |
| 400 | InvalidStorage.Format | Specified Storage is not valid. | Storage參數值無效。請設定合理的參數取值。 |
| 400 | InvalidDBInstanceConnType.Format | Specified DB instance conn type is not valid. | 操作失敗,當前資料庫執行個體的連線類型不支援此操作。 |
| 400 | PreCheckInvalid | CreateDdrInstance PreCheck Is Invalid | 跨地區恢複資料到新執行個體(CreateDdrInstance)預檢查無效。 |
| 400 | IncorrectDBInstanceType | Current DB instance engine and type does not support operations. | |
| 400 | InvalidRestoreType.Format | Specified restore type is not valid. | 指定的恢複類型無效。請設定合理的恢複類型。 |
| 400 | NoBackupSetRegion | BackupSetRegion is absence. | 操作失敗,備份地區不存在。 |
| 400 | IncorrectBackupSetType | Backup set type should be value ddr. | |
| 400 | NoBaksetName | BaksetName is absence. | 操作失敗,備份組名稱不存在。 |
| 400 | NoSourceInstanceName | No SourceDBInstanceName. | 操作失敗,沒有源執行個體名稱。 |
| 400 | NoAvailableDisasterRestoreBakset | No available disaster restore bakset. | 操作失敗,當前沒有可用的恢複集。 |
| 400 | InvalidBackupType.Format | Specified backup type is not valid. | 操作失敗,指定的備份類型無效。 |
| 400 | IncorrectEngineVersion | Current engine version does not support operations. | 操作失敗,當前資料庫版本不支援此操作。 |
| 400 | DisasterRestoreRegionNotMatched | Disaster restore should be operated in the ddr region or source region. | 災難恢複應在ddr地區或來源區域中進行。 |
| 400 | InvalidVpcIdRegion.NotSupported | The Specified vSwitchId zone not supported. | |
| 400 | VswitchIpExhausted | No available ip in the specified vswitch. | 指定的vswitch中沒有可用的IP。 |
| 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 | 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 | InvalideStatus.Format | The instance status does not support this operation. | 執行個體狀態不支援此操作。 |
| 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 | MirrorInsExists | Specified DB instance mirror ins already existed. | 當前資料庫執行個體鏡像已存在。 |
| 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. | 指定的地區無效。 |
| 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 | IncorrectBackupSetMethod | Current backup set method does not support operations. | 操作失敗,指定的備份組不支援庫表恢複。 |
| 403 | IncorrectBaksetVersion | Current bakset version does not support operations. | |
| 403 | CrossRegionUnsupportTDE | Cross-region disaster restore not support TDE bakset. | |
| 403 | OperationDenied.Resource | Specified DB instance class or storage is not available in all Availability Zones. | 資源不足,請變更執行個體規格或儲存規格後再試。 |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | 沒有可用的庫存地區。 |
| 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 | IncorrectMinorVersion | Current engine minor version does not support operations. | 當前引擎小版本不支援此操作。 |
| 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. | 當前資料庫執行個體層級不支援此操作。 |
| 404 | InvalidRegion.NotFound | Specified Region does not exist in the RDS | 地區無效。 |
| 404 | InvalidClusterName.NotFound | The specified cluster name is not available. | 操作失敗,叢集名稱不存在。請檢查叢集名稱後重試。 |
| 404 | InvalidDBInstanceClass.NotFound | Specified DB instance class is not found. | 當前選擇的配置或規格不存在或已停售,請重新選擇。 |
| 404 | InvalidDBInstanceNetType.NotFound | Specified DB instance net type is not found. | 操作失敗,執行個體網路類型不正確。請檢查網路類型。 |
| 404 | RestoreType.NotFound | RestoreType is not found. | 恢複方式(RestoreType)未找到。 |
| 404 | InvalidBackupSetID.NotFound | Specified backup set ID does not exist. | 備份組不存在。請查看已存在的備份組。 |
| 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. | 指定的主機資訊不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。