本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# RestoreDBClusterToPointInTime
<a name="API_RestoreDBClusterToPointInTime"></a>

將叢集還原至任意時間點。使用者可以還原到 `LatestRestorableTime` 之前的任意時間點，最多 `BackupRetentionPeriod` 天。目標叢集是從來源叢集建立，其組態與原始叢集相同，但使用預設安全群組建立新叢集。

## 請求參數
<a name="API_RestoreDBClusterToPointInTime_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
要建立之新叢集的名稱。  
限制條件：  
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
類型：字串  
必要：是

 ** SourceDBClusterIdentifier **   
還原來源之來源叢集的識別符。  
限制條件：  
+ 必須符合現有 `DBCluster` 的識別碼。
類型：字串  
必要：是

 ** DBSubnetGroupName **   
用於新叢集的子網路群組名稱。  
限制條件：如果提供， 必須符合現有 的名稱`DBSubnetGroup`。  
範例：`mySubnetgroup`  
類型：字串  
必要：否

 ** DeletionProtection **   
指定是否可以刪除此叢集。如果 `DeletionProtection` 已啟用，除非修改並`DeletionProtection`停用，否則無法刪除叢集。 會`DeletionProtection`保護叢集免於意外刪除。  
類型：布林值  
必要：否

 **EnableCloudwatchLogsExports.member.N**   
必須啟用才能匯出至 Amazon CloudWatch Logs 的日誌類型清單。  
類型：字串陣列  
必要：否

 ** KmsKeyId **   
從加密叢集還原加密叢集時要使用的 AWS KMS 金鑰識別符。  
 AWS KMS 金鑰識別符是 AWS KMS 加密金鑰的 Amazon Resource Name (ARN)。如果您要使用擁有用來加密新叢集之 AWS KMS 加密金鑰 AWS 帳戶 的相同 來還原叢集，則可以使用 AWS KMS 金鑰別名，而非 AWS KMS 加密金鑰的 ARN。  
您可以還原至新的叢集，並使用與用來加密來源叢集的 AWS KMS 金鑰不同的 AWS KMS 金鑰來加密新的叢集。新的資料庫叢集會使用 `KmsKeyId` 參數識別的 AWS KMS 金鑰加密。  
如果您未指定 `KmsKeyId` 參數的值，會發生以下情況：  
+ 如果叢集已加密，則還原的叢集會使用用來加密來源叢集的 AWS KMS 金鑰進行加密。
+ 如果叢集未加密，則還原的叢集不會加密。
如果 `DBClusterIdentifier`是指未加密的叢集，則還原請求會遭到拒絕。  
類型：字串  
必要：否

 ** NetworkType **   
叢集的網路類型。  
網路類型是由為叢集`DBSubnetGroup`指定的 決定。只能`DBSubnetGroup`支援 IPv4 通訊協定或 IPv4 和 IPv6 通訊協定 (`DUAL`)。  
如需詳細資訊，請參閱《Amazon [DocumentDB 開發人員指南》中的 VPC 中的 DocumentDB 叢集](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)。 Amazon DocumentDB   
有效值: `IPV4` \$1 `DUAL`   
類型：字串  
必要：否

 ** 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` 值，則新資料庫叢集會還原為來源資料庫叢集的完整複本。  
類型：字串  
必要：否

 ** ServerlessV2ScalingConfiguration **   
包含 Amazon DocumentDB Serverless 叢集的擴展組態。  
類型：[ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 物件  
必要：否

 ** StorageType **   
和資料庫叢集相關聯的儲存類型。  
如需 Amazon DocumentDB 叢集儲存類型的資訊，請參閱《*Amazon DocumentDB 開發人員指南*》中的叢集儲存組態。  
儲存類型 - 的有效值 `standard | iopt1`   
預設值為 `standard `   
類型：字串  
必要：否

 **Tags.Tag.N**   
要指派給還原叢集的標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
必要：否

 ** UseLatestRestorableTime **   
值設定為 `true` 可將叢集還原到最近可還原的備份時間，否則為 `false`。  
預設：`false`  
限制條件：如果提供了 `RestoreToTime` 參數，則無法指定。  
類型：布林值  
必要：否

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
新叢集所屬的 VPC 安全群組清單。  
類型：字串陣列  
必要：否

## 回應元素
<a name="API_RestoreDBClusterToPointInTime_ResponseElements"></a>

服務會傳回下列元素。

 ** DBCluster **   
叢集的詳細資訊。  
類型：[DBCluster](API_DBCluster.md) 物件

## 錯誤
<a name="API_RestoreDBClusterToPointInTime_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** 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

 ** NetworkTypeNotSupported **   
`DBSubnetGroup` 或 資料庫引擎版本不支援 網路類型。  
HTTP 狀態碼：400

 ** StorageQuotaExceeded **   
請求將導致您超過所有執行個體允許的可用儲存量。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_RestoreDBClusterToPointInTime_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterToPointInTime)