RestoreDBClusterFromSnapshot - Amazon DocumentDB

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

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. 成員.

匯出至 Amazon CloudWatch 日誌時必須啟用的記錄類型清單。

類型:字串陣列

必要:否

EngineVersion

用於新叢集的資料庫引擎版本。

類型:字串

必要:否

KmsKeyId

從資料庫快照或叢集快照還原加密叢集時使用的 AWS KMS 金鑰識別碼。

AWS KMS 金鑰識別碼是加 AWS KMS 密金鑰的 Amazon 資源名稱 (ARN)。如果您要使用擁有用於加密新叢集之 AWS KMS 加密金鑰的叢集來還原叢集,則可以使用 AWS KMS 金鑰別名而非 ARN 作為 AWS KMS 加密金鑰。 AWS 帳戶

如果您未指定 KmsKeyId 參數的值,會發生以下情況:

  • 如果中的快照或叢集快照SnapshotIdentifier已加密,則還原的叢集會使用用來加密快照或叢集快照的 AWS KMS 金鑰加密。

  • 如果中的快照或叢集快照SnapshotIdentifier未加密,則還原的資料庫叢集不會加密。

類型:字串

必要:否

Port

新叢集接受連線的連接埠號碼。

限制:必須是從1150到的值65535

預設值:與原始叢集相同的連接埠。

類型:整數

必要:否

StorageType

和資料庫叢集相關聯的儲存類型。

如需 Amazon DocumentDB 叢集的儲存類型的相關資訊,請參閱 Amazon DocumentDB 開發人員指南中的叢集儲存組態。

儲存類型的有效值-standard | iopt1

預設值為 standard

類型:字串

必要:否

標籤. 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

StorageQuotaExceeded

該請求會導致您超過所有執行個體允許的可用儲存空間量。

HTTP 狀態碼:400

StorageQuotaExceeded

該請求會導致您超過所有執行個體允許的可用儲存空間量。

HTTP 狀態碼:400

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: