本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
RestoreDBClusterToPointInTime
將叢集還原至任意時間點。使用者可以還原到 LatestRestorableTime
之前的任意時間點,最多 BackupRetentionPeriod
天。目標叢集是從具有與原始叢集相同組態的來源叢集建立的,但新叢集是使用預設安全性群組建立的。
請求參數
如需所有動作的一般參數資訊,請參閱《Common Parameters》。
- DBClusterIdentifier
-
要建立之新叢集的名稱。
約束:
-
必須包含 1 到 63 個字母、數字或連字號。
-
第一個字元必須是字母。
-
不能以連字號結尾或連續包含兩個連字號。
類型:字串
必要:是
-
- SourceDBClusterIdentifier
-
還原來源之來源叢集的識別符。
約束:
-
必須符合現有
DBCluster
的識別碼。
類型:字串
必要:是
-
- DBSubnetGroupName
-
要用於新叢集的子網路群組名稱。
條件約束:如果提供,則必須與現有的名稱相符
DBSubnetGroup
。範例:
mySubnetgroup
類型:字串
必要:否
- DeletionProtection
-
指定是否可以刪除此叢集。如果啟
DeletionProtection
用,除非已修改並DeletionProtection
停用叢集,否則無法刪除叢集。DeletionProtection
防止叢集遭到意外刪除。類型:布林值
必要:否
- EnableCloudwatchLogsExports. 成員.
-
匯出至 Amazon CloudWatch 日誌時必須啟用的記錄類型清單。
類型:字串陣列
必要:否
- KmsKeyId
-
從加密叢集還原加密叢集時使用的 AWS KMS 金鑰識別碼。
AWS KMS 金鑰識別碼是加 AWS KMS 密金鑰的 Amazon 資源名稱 (ARN)。如果您要使用擁有用於加密新叢集之 AWS KMS 加密金鑰的叢集來還原叢集,則可以使用 AWS KMS 金鑰別名而非 ARN 作為 AWS KMS 加密金鑰。 AWS 帳戶
您可以還原到新叢集,並使用與用來加密來源叢集的金 AWS KMS 鑰不同的 AWS KMS 金鑰來加密新叢集。新的資料庫叢集會使用
KmsKeyId
參數所識別的 AWS KMS 金鑰加密。如果您未指定
KmsKeyId
參數的值,會發生以下情況:-
如果叢集已加密,則還原的叢集會使用用來加密來源叢集的 AWS KMS 金鑰加密。
-
如果叢集未加密,則不會加密還原的叢集。
如果
DBClusterIdentifier
指的是未加密的叢集,則會拒絕還原要求。類型:字串
必要:否
-
- Port
-
新叢集接受連線的連接埠號碼。
限制:必須是從
1150
到的值65535
。預設值:引擎的預設連接埠。
類型:整數
必要:否
- RestoreToTime
-
將叢集還原至此日期和時間。
有效值:國際標準時間 (UTC) 格式的時間。
約束:
-
必須在執行個體最近一次可還原時間之前。
-
如果未提供
UseLatestRestorableTime
參數,則必須指定。 -
如果
UseLatestRestorableTime
參數為true
,則無法指定。 -
如果
RestoreType
參數為copy-on-write
,則無法指定。
範例:
2015-03-07T23:45:00Z
類型:Timestamp
必要:否
-
- RestoreType
-
要執行的還原類型。您可以指定下列其中一個值:
-
full-copy
- 新資料庫叢集將還原為來源資料庫叢集的完整複本。 -
copy-on-write
- 新資料庫叢集將還原為來源資料庫叢集的複製品。
限制:如果來源資料庫叢集的引擎版本早於 1.11,您無法指定
copy-on-write
。如果您不指定
RestoreType
值,則新資料庫叢集會還原為來源資料庫叢集的完整複本。類型:字串
必要:否
-
- StorageType
-
和資料庫叢集相關聯的儲存類型。
如需 Amazon DocumentDB 叢集的儲存類型的相關資訊,請參閱 Amazon DocumentDB 開發人員指南中的叢集儲存組態。
儲存類型的有效值-
standard | iopt1
預設值為
standard
類型:字串
必要:否
- 標籤. N
-
要指派給還原叢集的標籤。
類型:Tag 物件陣列
必要:否
- UseLatestRestorableTime
-
值設定為
true
可將叢集還原到最近可還原的備份時間,否則為false
。預設:
false
限制條件:如果提供了
RestoreToTime
參數,則無法指定。類型:布林值
必要:否
- VpcSecurityGroupIds。 VpcSecurityGroupId.N
-
新叢集所屬的 VPC 安全群組清單。
類型:字串陣列
必要:否
回應元素
服務會傳回下列元素。
- DBCluster
-
叢集的詳細資訊。
類型:DBCluster 物件
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- DBClusterAlreadyExistsFault
-
您已經擁有具有指定識別碼的叢集。
HTTP 狀態碼:400
- DBClusterNotFoundFault
-
DBClusterIdentifier
不參考現有叢集。HTTP 狀態碼:404
- DBClusterQuotaExceededFault
-
無法建立叢集,因為您已達到叢集允許的最大配額。
HTTP 狀態碼:403
- DBClusterSnapshotNotFoundFault
-
DBClusterSnapshotIdentifier
不會參考現有的叢集快照。HTTP 狀態碼:404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupName
不參照現有的子網路群組。HTTP 狀態碼:404
- InsufficientDBClusterCapacityFault
-
叢集沒有足夠的容量進行目前的作業。
HTTP 狀態碼:403
- InsufficientStorageClusterCapacity
-
沒有足夠的儲存空間可用於目前動作。您可以透過將子網路群組更新為使用具有更多儲存空間的不同可用區域來解決此錯誤。
HTTP 狀態碼:400
- InvalidDBClusterSnapshotStateFault
-
提供的值不是有效的叢集快照狀態。
HTTP 狀態碼:400
- InvalidDBClusterStateFault
-
叢集不是有效的狀態。
HTTP 狀態碼:400
- InvalidDBSnapshotState
-
快照的狀態不允許刪除。
HTTP 狀態碼:400
- InvalidRestoreFault
-
您無法從虛擬私有雲 (VPC) 備份還原至非 VPC 資料庫執行個體。
HTTP 狀態碼:400
- InvalidSubnet
-
要求的子網路無效,或要求多個子網路並非全部位於一般虛擬私人雲端 (VPC) 中。
HTTP 狀態碼:400
- InvalidVPCNetworkStateFault
-
子網路群組在建立之後,並不會涵蓋所有可用區域,因為已進行變更。
HTTP 狀態碼:400
- KMSKeyNotAccessibleFault
-
存取 AWS KMS 金鑰時發生錯誤。
HTTP 狀態碼:400
- StorageQuotaExceeded
-
該請求將導致您超過所有實例允許的可用存儲量。
HTTP 狀態碼:400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: