調用CloneDBInstance介面將歷史資料恢複至一個新執行個體(稱為複製執行個體)。

調用該介面時,執行個體必須滿足以下條件,否則將操作失敗:

  • 執行個體狀態為運行中;
  • 執行個體當前沒有正在執行的遷移任務;
  • 執行個體已開啟記錄備份(用於按時間點恢複);
  • 若要按備份組複製執行個體,則主執行個體必須至少有一個已完成備份的備份組。
    说明 RDS支援RAM子帳號建立複製執行個體,請務必保證子帳號已添加複製執行個體的授權策略,添加授權請參見。雲資料庫RDS授權 雲資料庫RDS授權

執行個體內資料庫帳號資訊複製以及其他功能的設定複製將遵循如下方式:

  • 執行個體內的白名單設定、SQL審計設定、閾值警示設定、備份設定、參數設定將和當前執行個體狀態保持一致;
  • 執行個體內的資料資訊、帳號資訊與備份檔案或時間點當時資訊一致。

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
Action String CloneDBInstance

系統規定參數,取值:CloneDBInstance

PayType String Postpaid

付費類型,取值:

  • Postpaid:後付費(隨用隨付);
  • Prepaid:預付費(訂用帳戶)。
DBInstanceStorageType String cloud_essd

執行個體儲存類型,取值:

  • local_ssd/ephemeral_ssd:本地SSD盤;
  • cloud_ssd:SSD雲端硬碟;
  • cloud_essd:ESSD雲端硬碟。
RegionId String cn-hangzhou

地區ID,可以通過介面DescribeRegions查看可用的地區ID。

ZoneId String cn-hangzhou-b

可用性區域ID。

DBInstanceClass String mysql.n1.micro.1

執行個體規格,詳見執行個體規格表

说明 預設規格和主執行個體一致。
DBInstanceStorage Integer 1000

執行個體儲存空間,單位:GB。每5GB進行遞增,詳見執行個體規格表

说明 預設儲存空間和主執行個體一致。
DbNames String testDB

資料庫名稱。

InstanceNetworkType String VPC

執行個體的網路類型,取值:

  • VPC:專用網路;
  • Classic:傳統網路。
说明 預設網路類型和主執行個體一致。
BackupId String 9026262

備份組ID。

您可以通過DescribeBackups介面擷取備份列表。

说明 BackupIdRestoreTime兩者至少傳入一個。
DBInstanceId String rm-uf6wjk5xxxxxxxxxx

執行個體ID。

RestoreTime String 2011-06-11T16:00:00Z

備份保留周期內的任意時間點。格式:yyyy-MM-ddTHH:mm:ssZ(UTC時間)。

说明 BackupIdRestoreTime兩者至少傳入一個。
VPCId String vpc-uf6f7l4fg90xxxxxxxxxx

VPC ID。

VSwitchId String vsw-uf6adz52c2pxxxxxxxxxx

VSwitch ID。

PrivateIpAddress String 172.16.201.69

新執行個體的內網IP,需要在指定交換器的IP位址範圍內。系統預設通過VPCIdVSwitchId自動分配。

UsedTime String 1

購買時間長度,取值:

  • 當參數PeriodYear時,UsedTime取值為1~3
  • 當參數PeriodMonth時,UsedTime取值為1~9
说明 若付費類型為 Prepaid則該參數必須傳入。
Period String Year

預付費執行個體為包年或者包月類型,取值:

  • Year:包年;
  • Month:包月。
说明 若付費類型為 Prepaid則該參數必須傳入。
Category String HighAvailability

執行個體系列,取值:

  • Basic:基礎版;
  • HighAvailability:高可用版;
  • AlwaysOn:叢集版;
  • Finance:金融版(僅中國站支援)。
RestoreTable String 1

是否進行庫表恢複,取值為1時表示進行庫表恢複,否則不填。

TableMeta String [{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}]

進行庫表恢複時,指定恢複的庫表資訊。格式:

[{"type":"db","name":"<資料庫1名稱>","newname":"<新資料庫1名稱>","tables":[{"type":"table","name":"<資料庫1內的表1名稱>","newname":"<新的表1名稱>"},{"type":"table","name":"<資料庫1內的表2名稱>","newname":"<新的表2名稱>"}]},{"type":"db","name":"<資料庫1名稱>","newname":"<新資料庫2名稱>","tables":[{"type":"table","name":"<資料庫2內的表3名稱>","newname":"<新的表3名稱>"},{"type":"table","name":"<資料庫2內的表4名稱>","newname":"<新的表4名稱>"}]}]

返回資料

名稱 類型 樣本值 描述
DBInstanceId String rm-uf6wjk5xxxxxxx

執行個體ID。

OrderId String 100789370xxxxx

訂單ID。

RequestId String 1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC

請求ID。

樣本

請求樣本


http(s)://rds.aliyuncs.com/?Action=CloneDBInstance
&BackupId=9026262
&PayType=Postpaid
&<公用請求參數>

正常返回樣本

XML 格式

<CloneDBInstanceResponse>
	  <OrderId>100789370xxxxx</OrderId>
	  <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
	  <RequestId>1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC</RequestId></CloneDBInstanceResponse>

JSON 格式

{
	"RequestId":"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
	"DBInstanceId":"rm-uf6wjk5xxxxxxx",
	"OrderId":"100789370xxxxx"
}

錯誤碼

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