CloneDBInstance - 恢複資料（複製執行個體） - ApsaraDB RDS

該介面用於將歷史資料恢複至一個新執行個體（稱為複製執行個體）。

介面說明

適用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

rds:CloneDBInstance

create

DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag

無

請求參數

名稱	類型	必填	描述	樣本值
ClientToken	string	否	用於保證請求的等冪性，防止重複提交請求。由用戶端產生該參數值，要保證在不同請求間唯一，最大值不超過 64 個 ASCII 字元，且該參數值中不能包含非 ASCII 字元。	0c593ea1-3bea-11e9-b96b-88**********
RegionId	string	否	地區 ID。可以通過介面 DescribeRegions 查看地區 ID。	cn-hangzhou
ZoneId	string	否	主可用性區域 ID。可以通過介面 DescribeRegions 查看可用性區域 ID。說明預設為源執行個體的可用性區域。	cn-hangzhou-b
DBInstanceClass	string	否	執行個體規格，詳見執行個體規格表。說明預設規格和主執行個體一致。	mysql.n1.micro.1
DBInstanceStorage	integer	否	執行個體儲存空間，單位：GB。每 5GB 進行遞增，詳見執行個體規格表。說明預設儲存空間和主執行個體一致。	1000
DBInstanceDescription	string	否	執行個體名稱。長度為 2~255 個字元。以中文、英文字母開頭，可以包含數字、中文、英文、底線（_）、虛線（-）。說明不能以 http:// 和 https:// 開頭。	testInstance
DbNames	string	否	資料庫名稱，格式如下：`原庫名 1,原庫名 2`。	test1,test2
PayType	string	是	付費類型，取值： Postpaid：後付費（隨用隨付） Prepaid：預付費（訂用帳戶） Serverless：Serverless 付費類型，不支援 MariaDB 執行個體。更多資訊，請參見MySQL Serverless 執行個體簡介、SQL Server Serverless 執行個體簡介、PostgreSQL Serverless 執行個體簡介。	Postpaid
InstanceNetworkType	string	否	執行個體的網路類型，取值： VPC：專用網路 Classic：傳統網路說明預設網路類型和主執行個體一致。	VPC
DBInstanceId	string	是	執行個體 ID。	rm-uf6wjk5****
BackupId	string	否	備份組 ID。您可以通過 DescribeBackups 介面擷取備份列表。說明 BackupId 和 RestoreTime 兩者至少傳入一個。	902****
RestoreTime	string	否	備份保留周期內的任意時間點。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。說明 BackupId 和 RestoreTime 兩者至少傳入一個。	2011-06-11T16:00:00Z
VPCId	string	否	Virtual Private Cloud ID。說明請確保 VPC 屬於對應的地區。	vpc-uf6f7l4fg90****
VSwitchId	string	否	虛擬交換器 ID。虛擬交換器所在的可用性區域必須和 ZoneId 中傳入的可用性區域 ID 相對應。網路類型 InstanceNetworkType 需為 VPC。若您填寫了 ZoneSlaveId1（備可用性區域 ID），此處需填寫兩個交換器 ID，並使用半形逗號（,）隔開。	vsw-uf6adz52c2p****
PrivateIpAddress	string	否	新執行個體的內網 IP，需要在指定交換器的 IP 位址範圍內。系統預設通過 VPCId 和 VSwitchId 自動分配。	172.XX.XX.69
UsedTime	integer	否	購買時間長度，取值：當參數 Period 為 Year 時，UsedTime 取值為1~3。當參數 Period 為 Month 時，UsedTime 取值為1~9。說明若付費類型為 Prepaid 則該參數必須傳入。	1
Period	string	否	預付費執行個體為包年或者包月類型，取值： Year：包年 Month：包月說明若付費類型為 Prepaid 則該參數必須傳入。	Year
Category	string	否	執行個體系列，取值： Basic：基礎系列 HighAvailability：高可用系列 AlwaysOn：叢集系列（SQL Server） cluster：叢集系列（MySQL） Finance：金融版（僅中國站支援） Serverless 執行個體 serverless_basic：Serverless 基礎系列（僅適用 MySQL 和 PostgreSQL） serverless_standard：MySQL Serverless 高可用系列 serverless_ha：SQL Server Serverless 高可用系列說明該參數不需要傳遞，複製時會保持和源執行個體相同。	HighAvailability
ZoneIdSlave1	string	否	備節點可用性區域 ID。如果和 ZoneId 相同，則為單可用性區域部署；如果和 ZoneId 不同，則為多可用性區域部署。	cn-hangzhou-c
ZoneIdSlave2	string	否	日誌節點可用性區域 ID。如果和 ZoneId 相同，則為單可用性區域部署；如果和 ZoneId 不同，則為多可用性區域部署。	cn-hangzhou-d
DBInstanceStorageType	string	否	執行個體儲存類型，取值： general_essd：高效能雲端硬碟（推薦） local_ssd：高效能本地碟 cloud_ssd：SSD 雲端硬碟 cloud_essd：ESSD PL1 雲端硬碟 cloud_essd2：ESSD PL2 雲端硬碟 cloud_essd3：ESSD PL3 雲端硬碟說明 Serverless 執行個體僅支援 ESSD PL1 雲端硬碟和高效能雲端硬碟。	general_essd
RestoreTable	string	否	是否進行庫表恢複，取值為 1 時表示進行庫表恢複，否則不填。	1
TableMeta	string	否	進行庫表恢複時，指定恢複的庫表資訊。格式： [{"type":"db","name":"資料庫 1 名稱","newname":"新資料庫 1 名稱","tables":[{"type":"table","name":"資料庫 1 內的表 1 名稱","newname":"新的表 1 名稱"},{"type":"table","name":"資料庫 1 內的表 2 名稱","newname":"新的表 2 名稱"}]},{"type":"db","name":"資料庫 2 名稱","newname":"新資料庫 2 名稱","tables":[{"type":"table","name":"資料庫 2 內的表 1 名稱","newname":"新的表 1 名稱"},{"type":"table","name":"資料庫 2 內的表 2 名稱","newname":"新的表 2 名稱"}]}]	[{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}]
DedicatedHostGroupId	string	否	專屬叢集 ID。	dhg-7a9****
BackupType	string	否	備份類型，取值： FullBackup：全量備份 IncrementalBackup：增量備份	FullBackup
DeletionProtection	boolean	否	是否開啟釋放保護功能。取值： true：開啟 false（預設）：關閉	true
ServerlessConfig	object	否	Serverless 選項。僅在需要將資料複製至 Serverless 執行個體時傳入。說明該參數僅支援中國站。
AutoPause	boolean	否	是否開啟 MySQL Serverless 執行個體的自動啟停功能。10 分鐘無任何串連進入暫停狀態，串連進入時會自動喚醒。取值： true：啟用 false（預設）：不啟用說明僅 MySQL Serverless 執行個體支援該參數。該參數僅支援中國站。	true
MaxCapacity	number	否	執行個體 RCU（RDS Capacity Unit）的自動擴縮範圍最大值。取值： MySQL：1~8 SQL Server：2~8 PostgreSQL：1~12 說明該參數的值必須大於等於 MinCapacity，且僅支援傳入整數。該參數僅支援中國站。	8
MinCapacity	number	否	執行個體 RCU（RDS Capacity Unit）的自動擴縮範圍最小值。取值： MySQL：0.5~8 SQL Server：2~8（僅支援整數） PostgreSQL：0.5~12 說明該參數的值必須小於等於 MaxCapacity。該參數僅支援中國站。	0.5
SwitchForce	boolean	否	是否開啟 MySQL Serverless 執行個體的強制彈性擴縮容。執行個體 RCU 的彈性擴縮容通常會立刻生效，但在某些特殊情況下無法即時完成擴縮容，此時可開啟本參數進行強制擴縮容。取值： true：啟用 false（預設）：不啟用說明僅 MySQL Serverless 執行個體支援該參數。該參數僅支援中國站。	false
BpeEnabled	string	否	棄用參數，無需配置。	0
IoAccelerationEnabled	string	否	高效能雲端硬碟的 Buffer Pool Extension（BPE）功能開關，取值： 1：開啟 0：不開啟說明 Buffer Pool Extension（BPE）功能的更多資訊，請參見Buffer Pool Extension（BPE）。	0
BurstingEnabled	boolean	否	高效能雲端硬碟的 IO 效能突發功能開關。 true：開啟 false：關閉說明瞭解 IO 效能突發功能的更多資訊，請參見什麼是高效能雲端硬碟。	false
AutoPay	boolean	否	是否自動支付。取值範圍： true：自動支付。您需要確保賬戶餘額充足。 false：只產生訂單不計費。說明預設值為 true。如果您的支付方式餘額不足，可以將參數 AutoPay 設定為 false，此時會產生未支付訂單，您可以登入 RDS 管理主控台自行支付。	true
CustomExtraInfo	string	否

返回參數

名稱	類型	描述	樣本值
	object	返回參數詳情。
DBInstanceId	string	執行個體 ID。	rm-uf6wjk5****
OrderId	string	訂單 ID。	100789370****
RequestId	string	請求 ID。	1E43AAE0-BEE8-43DA-860D-EAF2****

樣本

正常返回樣本

JSON格式

{
  "DBInstanceId": "rm-uf6wjk5****",
  "OrderId": "100789370****",
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidAvZone.Format	Specified AvZone is not valid.	指定的AvZone不合法，請檢查該參數的正確性。
400	InvalidAvZone.NotSupport	Specified availableArea multiZone does not support in RDS.	指定的availableArea multiZone在RDS中不支援。
400	CannotDecreaseEssdPerfLevel	cannot decrease cloud essd performance level.	儲存類型變更校正失敗，SQL Server雲端硬碟執行個體只能轉為雲端硬碟，SSD只能升級到SSD或ESSD。
400	InvalidIPAddress.Conflict	IP address conflict.	IP地址衝突。
400	CDDC.AvailableHostsNotEnoughInZone	Not enough available hosts are in the target zone.	目標可用性區域沒有足夠的主機資源，請在可用性區域中建立主機。
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	當前執行個體規格不支援該儲存類型。
400	InvalidRecoveryDbInstance.StorageType	The disk local_ssd can not clone to cloud disk type	本地碟無法複製為雲端硬碟
400	InvalidRecoveryDbInstance.StorageSize	The disk space of the new instance cannot be less than that of the current instance	操作失敗，新執行個體的磁碟空間不能小於當前執行個體的空間。
400	InvalidDBInstanceClass.Offline	The specified instance type is no longer provided. Please specify another instance type.	當前所選的執行個體規格已下線，請更換其他執行個體規格。
400	InvalidTunnelId	Specified conn tunnel is not valid.	指定的串連通道無效。
400	ZoneId.NotMatchWithCategory	The number of available zones does not match the database engine or instance edition. Please reset it.	可用性區域數量與資料庫類型或執行個體系列不匹配，請重新設定。
400	UnsupportExtendDisk.NotSupport	Specified DB instance is unsupport extend disk.	指定的執行個體不支援擴充磁碟。
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	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	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.	指定的地區無效。
400	StopService.Clone	The service has been discontinued and cloning operations on classic network instances are no longer permitted.	因傳統網路下線且已超過停止服務時間，不允許複製出傳統網路類型的執行個體。
400	InvalidParam.UsedTime	The clone expiration date cannot exceed %s.	因傳統網路下線，複製出的傳統網路執行個體的使用時間不能超過限制時間。
400	MinorVersionTag.NotFound	Minor version tags cannot be parsed by the instance.
400	InvalidBakset.Invalid	Specified bakset is not valid.	指定的備份組不支援此操作。
400	InvalidParamForXfs	Xfs instance must be single tenant standard instance.	Xfs執行個體必須是獨享高可用執行個體。
400	AtLeastThreeVSwitchAvailableIp	The primary vswitch requires at least three available IP addresses.	主交換器至少需要3個可用ip。
400	AtLeastTwoVSwitchAvailableIp	The primary vswitch requires at least two available IP addresses.	主交換器至少需要2個可用的ip。
400	DiskSize.NotEnough	The disk size is not enough to restore tables.	磁碟剩餘空間不足。
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	IncorrectMinorVersion	Current engine minor version does not support operations.	當前引擎小版本不支援此操作。
403	IncorrectCharacterType	Current DB instance character type does not support this operation.	當前執行個體字元類型不支援此操作。
403	CloudDiskEncryptionNotSupport	The encryption key is not allowed for general-purpose instance.	通用型規格執行個體不支援雲端硬碟加密。
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	InvalidMeta.TooLarge	Meta information is too large.	中繼資料資訊太大，請檢查執行個體表個數是否超過50000。
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.	沒有找到指定的執行個體，請檢查執行個體的正確性。
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.	指定的主機資訊不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。

ApsaraDB RDS：CloneDBInstance - 恢複資料（複製執行個體）