RestoreDBClusterToPointInTime - Amazon DocumentDB
AnforderungsparameterAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

RestoreDBClusterToPointInTime

Stellt einen Cluster zu einem beliebigen Zeitpunkt wieder her. Benutzer können den Zustand jedes beliebigen Zeitpunkts vor LatestRestorableTime bis zu BackupRetentionPeriod Tagen wiederherstellen. Der Zielcluster wird aus dem Quellcluster mit derselben Konfiguration wie der ursprüngliche Cluster erstellt, mit der Ausnahme, dass der neue Cluster mit der Standardsicherheitsgruppe erstellt wird.

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

DBClusterIdentifier

Der Name des neuen Clusters, der erstellt werden soll.

Einschränkungen:

  • Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.

  • Das erste Zeichen muss ein Buchstabe sein.

  • Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.

Typ: Zeichenfolge

Erforderlich: Ja

SourceDBClusterIdentifier

Die Kennung des Quell-Clusters, von dem wiederhergestellt werden soll.

Einschränkungen:

  • Muss mit der Kennung eines vorhandenen DBCluster übereinstimmen.

Typ: Zeichenfolge

Erforderlich: Ja

DBSubnetGroupName

Der Name der Subnetzgruppe, die für den neuen Cluster verwendet werden soll.

Einschränkungen: Falls angegeben, muss er mit dem Namen eines vorhandenen DBSubnetGroup übereinstimmen.

Beispiel: mySubnetgroup

Typ: Zeichenfolge

Erforderlich: Nein

DeletionProtection

Gibt an, ob dieser Cluster gelöscht werden kann. Wenn DeletionProtection aktiviert, kann der Cluster nur gelöscht werden, wenn er geändert und DeletionProtection deaktiviert wurde. DeletionProtectionschützt Cluster davor, versehentlich gelöscht zu werden.

Typ: Boolesch

Erforderlich: Nein

EnableCloudwatchLogsExports.Mitglied.N

Eine Liste von Protokolltypen, die für den Export nach Amazon CloudWatch Logs aktiviert sein müssen.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

KmsKeyId

Die AWS KMS Schlüssel-ID, die bei der Wiederherstellung eines verschlüsselten Clusters aus einem verschlüsselten Cluster verwendet werden soll.

Die AWS KMS Schlüssel-ID ist der Amazon-Ressourcenname (ARN) für den AWS KMS Verschlüsselungsschlüssel. Wenn Sie einen Cluster mit demselben wiederherstellen AWS-Konto , dem der AWS KMS Verschlüsselungsschlüssel gehört, mit dem der neue Cluster verschlüsselt wurde, können Sie den AWS KMS Schlüsselalias anstelle des ARN für den AWS KMS Verschlüsselungsschlüssel verwenden.

Sie können auf einem neuen Cluster wiederherstellen und den neuen Cluster mit einem AWS KMS Schlüssel verschlüsseln, der sich von dem Schlüssel unterscheidet, der AWS KMS zum Verschlüsseln des Quellclusters verwendet wurde. Der neue DB-Cluster wird mit dem durch den Parameter identifizierten AWS KMS Schlüssel verschlüsselt. KmsKeyId

Wenn Sie keinen Wert für den KmsKeyId-Parameter angeben, geschieht folgendes:

  • Wenn der Cluster verschlüsselt ist, wird der wiederhergestellte Cluster mit dem AWS KMS Schlüssel verschlüsselt, der zur Verschlüsselung des Quellclusters verwendet wurde.

  • Wenn der Cluster nicht verschlüsselt ist, ist der wiederhergestellte Cluster nicht verschlüsselt.

Wenn es DBClusterIdentifier sich auf einen Cluster bezieht, der nicht verschlüsselt ist, wird die Wiederherstellungsanforderung abgelehnt.

Typ: Zeichenfolge

Erforderlich: Nein

Port

Die Portnummer, auf der der neue Cluster Verbindungen akzeptiert.

Einschränkungen: Muss ein Wert von 1150 bis sein65535.

Standard: Der Standardanschluss für die Engine.

Typ: Ganzzahl

Erforderlich: Nein

RestoreToTime

Das Datum und die Uhrzeit für die Wiederherstellung des Clusters.

Gültige Werte: Eine Uhrzeit im UTC-Format (Universal Coordinated Time).

Einschränkungen:

  • Muss vor dem letzten wiederherstellbaren Zeitpunkt für die Instance liegen.

  • Muss angegeben werden, wenn der Parameter UseLatestRestorableTime nicht angegeben ist.

  • Kann nicht angegeben werden, wenn der Parameter UseLatestRestorableTime auf true festgelegt ist.

  • Kann nicht angegeben werden, wenn der Parameter RestoreType auf copy-on-write festgelegt ist.

Beispiel: 2015-03-07T23:45:00Z

Typ: Zeitstempel

Erforderlich: Nein

RestoreType

Der Typ der auszuführenden Wiederherstellung. Sie können einen der folgenden Werte angeben:

  • full-copy – Der neue DB-Cluster wird als vollständige Kopie des Quell-DB-Clusters wiederhergestellt.

  • copy-on-write – Der neue DB-Cluster wird als Klon des Quell-DB-Clusters wiederhergestellt.

Einschränkungen: Sie können copy-on-write nicht angeben, wenn die Engine-Version des Quell-DB-Clusters älter als 1.11 ist.

Wenn Sie keinen Wert für RestoreType angeben, wird der neue DB-Cluster als vollständige Kopie des Quell-DB-Clusters wiederhergestellt.

Typ: Zeichenfolge

Erforderlich: Nein

StorageType

Der Speichertyp, der dem DB-Cluster zugeordnet werden soll.

Informationen zu Speichertypen für Amazon DocumentDB-Cluster finden Sie unter Cluster-Speicherkonfigurationen im Amazon DocumentDB Developer Guide.

Gültige Werte für den Speichertyp - standard | iopt1

Der Standardwert ist standard

Typ: Zeichenfolge

Erforderlich: Nein

Tags.Tag.N

Die Tags, die dem wiederhergestellten Cluster zugewiesen werden sollen.

Typ: Array von Tag-Objekten

Erforderlich: Nein

UseLatestRestorableTime

Ein Wert, der auf true festgelegt ist, um den Cluster auf den letzten wiederherstellbaren Sicherungszeitpunkt wiederherzustellen, und sonst false anzeigt.

Standard: false

Einschränkungen: Darf nicht angegeben werden, wenn der Parameter RestoreToTime angegeben ist.

Typ: Boolesch

Erforderlich: Nein

VpcSecurityGroupIds. VpcSecurityGroupIdN

Eine Liste der VPC-Sicherheitsgruppen, zu denen der neue Cluster gehört.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

Antwortelemente

Das folgende Element wird vom Dienst zurückgegeben.

DBCluster

Detaillierte Informationen zu einem Cluster.

Typ: DBCluster Objekt

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

DBClusterAlreadyExistsFault

Sie haben bereits einen Cluster mit der angegebenen Kennung.

HTTP Status Code: 400

DBClusterNotFoundFault

DBClusterIdentifierbezieht sich nicht auf einen vorhandenen Cluster.

HTTP Status Code: 404

DBClusterQuotaExceededFault

Der Cluster kann nicht erstellt werden, da Sie das maximal zulässige Kontingent an Clustern erreicht haben.

HTTP Status Code: 403

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifierbezieht sich nicht auf einen vorhandenen Cluster-Snapshot.

HTTP Status Code: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupNamebezieht sich nicht auf eine bestehende Subnetzgruppe.

HTTP Status Code: 404

InsufficientDBClusterCapacityFault

Der Cluster verfügt nicht über genügend Kapazität für den aktuellen Vorgang.

HTTP Status Code: 403

InsufficientStorageClusterCapacity

Für die aktuelle Aktion ist nicht genügend Speicherplatz verfügbar. Möglicherweise können Sie diesen Fehler beheben, indem Sie Ihre Subnetzgruppe so aktualisieren, dass sie verschiedene Availability Zones verwendet, in denen mehr Speicherplatz verfügbar ist.

HTTP Status Code: 400

InvalidDBClusterSnapshotStateFault

Der angegebene Wert ist kein gültiger Cluster-Snapshot-Status.

HTTP Status Code: 400

InvalidDBClusterStateFault

Der Cluster befindet sich nicht in einem gültigen Zustand.

HTTP Status Code: 400

InvalidDBSnapshotState

Der Status des Snapshots erlaubt kein Löschen.

HTTP Status Code: 400

InvalidRestoreFault

Sie können keine Wiederherstellung von einem Virtual Private Cloud (VPC) -Backup auf eine Nicht-VPC-DB-Instance durchführen.

HTTP Status Code: 400

InvalidSubnet

Das angeforderte Subnetz ist ungültig, oder es wurden mehrere Subnetze angefordert, die sich nicht alle in einer gemeinsamen Virtual Private Cloud (VPC) befinden.

HTTP Status Code: 400

InvalidVPCNetworkStateFault

Die Subnetzgruppe deckt nach ihrer Erstellung nicht alle Availability Zones ab, da Änderungen vorgenommen wurden.

HTTP Status Code: 400

KMSKeyNotAccessibleFault

Beim Zugriff auf einen AWS KMS Schlüssel ist ein Fehler aufgetreten.

HTTP Status Code: 400

StorageQuotaExceeded

Die Anfrage würde dazu führen, dass Sie die zulässige Menge an Speicherplatz überschreiten, die für alle Instanzen verfügbar ist.

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: