本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
RestoreDBClusterFromSnapshot
從快照或叢集快照建立新的叢集。
如果指定快照,則會使用預設組態和預設安全群組,從來源資料庫快照建立目標叢集。
如果指定叢集快照,則會從與原始來源資料庫叢集具有相同組態的來源叢集還原點建立目標叢集,但會使用預設安全群組建立新叢集。
請求參數
如需所有動作的一般參數資訊,請參閱《Common Parameters》。
- DBClusterIdentifier
-
要從快照或叢集快照建立的叢集名稱。此參數不區分大小寫。
限制條件:
-
必須包含 1 到 63 個字母、數字或連字號。
-
第一個字元必須是字母。
-
不能以連字號結尾,或包含兩個連續連字號。
範例:
my-snapshot-id類型:字串
必要:是
-
- Engine
-
用於新叢集的資料庫引擎。
預設:與來源相同。
限制條件:必須與來源的引擎相容。
類型:字串
必要:是
- SnapshotIdentifier
-
還原來源的快照或叢集快照識別碼。
您可以使用名稱或 Amazon Resource Name (ARN) 來指定叢集快照。不過,您可以只使用 ARN 來指定快照。
限制條件:
-
必須符合現有快照的識別碼。
類型:字串
必要:是
-
- AvailabilityZones.AvailabilityZone.N
-
提供還原資料庫叢集中執行個體可在其中建立的 Amazon EC2 可用區域的清單。
類型:字串陣列
必要:否
- DBClusterParameterGroupName
-
要與此資料庫叢集建立關聯的資料庫叢集參數群組名稱。
類型:字串 必要:否。
如果省略此引數,則會使用預設資料庫叢集參數群組。如果提供, 必須符合現有預設資料庫叢集參數群組的名稱。字串必須包含 1 到 255 個字母、數字或連字號。其第一個字元必須是字母,且不能以連字號結尾或包含兩個連續連字號。
類型:字串
必要:否
- DBSubnetGroupName
-
用於新叢集的子網路群組名稱。
限制條件:如果提供, 必須符合現有 的名稱
DBSubnetGroup。範例:
mySubnetgroup類型:字串
必要:否
- DeletionProtection
-
指定是否可以刪除此叢集。如果
DeletionProtection已啟用,除非修改並DeletionProtection停用,否則無法刪除叢集。 會DeletionProtection保護叢集免於意外刪除。類型:布林值
必要:否
- EnableCloudwatchLogsExports.member.N
-
必須啟用才能匯出至 Amazon CloudWatch Logs 的日誌類型清單。
類型:字串陣列
必要:否
- EngineVersion
-
用於新叢集的資料庫引擎版本。
類型:字串
必要:否
- KmsKeyId
-
從資料庫快照或叢集快照還原加密叢集時要使用的 AWS KMS 金鑰識別符。
AWS KMS 金鑰識別符是 AWS KMS 加密金鑰的 Amazon Resource Name (ARN)。如果您要使用擁有用來加密新叢集之 AWS KMS 加密金鑰 AWS 帳戶 的相同 來還原叢集,則可以使用 AWS KMS 金鑰別名,而非 AWS KMS 加密金鑰的 ARN。
如果您未指定
KmsKeyId參數的值,會發生以下情況:-
如果 中的快照或叢集快照
SnapshotIdentifier已加密,則還原的叢集會使用用來加密快照或叢集快照的 AWS KMS 金鑰進行加密。 -
如果 中的快照或叢集快照
SnapshotIdentifier未加密,則還原的資料庫叢集不會加密。
類型:字串
必要:否
-
- NetworkType
-
叢集的網路類型。
網路類型是由為叢集
DBSubnetGroup指定的 決定。只能DBSubnetGroup支援 IPv4 通訊協定或 IPv4 和 IPv6 通訊協定 (DUAL)。如需詳細資訊,請參閱《Amazon DocumentDB 開發人員指南》中的 VPC 中的 DocumentDB 叢集。 Amazon DocumentDB
有效值:
IPV4|DUAL類型:字串
必要:否
- Port
-
新叢集接受連線的連接埠號碼。
限制條件:必須是從
1150到 的值65535。預設:與原始叢集相同的連接埠。
類型:整數
必要:否
- ServerlessV2ScalingConfiguration
-
包含 Amazon DocumentDB Serverless 叢集的擴展組態。
類型:ServerlessV2ScalingConfiguration 物件
必要:否
- StorageType
-
和資料庫叢集相關聯的儲存類型。
如需 Amazon DocumentDB 叢集儲存類型的資訊,請參閱《Amazon DocumentDB 開發人員指南》中的叢集儲存組態。
儲存類型的有效值 -
standard | iopt1預設值為
standard類型:字串
必要:否
- Tags.Tag.N
-
要指派給還原叢集的標籤。
類型:Tag 物件陣列
必要:否
- VpcSecurityGroupIds.VpcSecurityGroupId.N
-
新叢集所屬的虛擬私有雲端 (VPC) 安全群組清單。
類型:字串陣列
必要:否
回應元素
服務會傳回下列元素。
- DBCluster
-
叢集的詳細資訊。
類型:DBCluster 物件
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- DBClusterAlreadyExistsFault
-
您已擁有具有指定識別符的叢集。
HTTP 狀態碼:400
- DBClusterQuotaExceededFault
-
無法建立叢集,因為您已達到叢集允許的配額上限。
HTTP 狀態碼:403
- DBClusterSnapshotNotFoundFault
-
DBClusterSnapshotIdentifier不會參考現有的叢集快照。HTTP 狀態碼:404
- DBSnapshotNotFound
-
DBSnapshotIdentifier不會參考現有的快照。HTTP 狀態碼:404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupName不會參考現有的子網路群組。HTTP 狀態碼:404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupName不會參考現有的子網路群組。HTTP 狀態碼:404
- InsufficientDBClusterCapacityFault
-
叢集沒有足夠的容量可進行目前的操作。
HTTP 狀態碼:403
- InsufficientStorageClusterCapacity
-
目前動作的可用儲存空間不足。您可以透過更新子網路群組以使用具有更多可用儲存空間的不同可用區域來解決此錯誤。
HTTP 狀態碼:400
- InvalidDBClusterSnapshotStateFault
-
提供的值不是有效的叢集快照狀態。
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
- StorageQuotaExceeded
-
請求將導致您超過所有執行個體允許的可用儲存量。
HTTP 狀態碼:400
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: