RestoreClusterFromSnapshot - Amazon DocumentDB
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere 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.

RestoreClusterFromSnapshot

Stellt einen elastischen Cluster aus einem Snapshot wieder her.

Anforderungssyntax

POST /cluster-snapshot/snapshotArn/restore HTTP/1.1
Content-type: application/json

{
   "clusterName": "string",
   "kmsKeyId": "string",
   "shardCapacity": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

snapshotArn

Die ARN-ID des Elastic Cluster-Snapshots.

Erforderlich: Ja

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

clusterName

Der Name des elastischen Clusters.

Typ: Zeichenfolge

Erforderlich: Ja

kmsKeyId

Die KMS-Schlüssel-ID, die zur Verschlüsselung des neuen Amazon DocumentDB DocumentDB-Elastic-Clusters-Clusters verwendet werden soll.

Die Kennung für den KMS-Schlüssel ist der Amazon-Ressourcenname (ARN) für den KMS-Verschlüsselungsschlüssel. Wenn Sie einen Cluster mit demselben Amazon-Konto erstellen, dem dieser KMS-Verschlüsselungsschlüssel gehört, können Sie den KMS-Schlüsselalias anstelle des ARN als KMS-Verschlüsselungsschlüssel verwenden.

Wenn hier kein Verschlüsselungsschlüssel angegeben ist, verwendet Amazon DocumentDB den Standardverschlüsselungsschlüssel, den KMS für Ihr Konto erstellt. Ihr Konto hat für jede Amazon-Region einen anderen Standard-Verschlüsselungsschlüssel.

Typ: Zeichenfolge

Erforderlich: Nein

shardCapacity

Die Kapazität jedes Shards im neuen wiederhergestellten Elastic Cluster.

Typ: Ganzzahl

Erforderlich: Nein

shardInstanceCount

Die Anzahl der Replikatinstanzen, die für alle Shards im Elastic Cluster gelten. Ein shardInstanceCount Wert von 1 bedeutet, dass es eine Writer-Instance gibt, und alle weiteren Instances sind Replikate, die für Lesevorgänge und zur Verbesserung der Verfügbarkeit verwendet werden können.

Typ: Ganzzahl

Erforderlich: Nein

subnetIds

Das EC2 Amazon-Subnetz IDs für den Elastic Cluster.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

tags

Eine Liste der Tag-Namen, die dem wiederhergestellten Elastic Cluster zugewiesen werden sollen, in Form einer Reihe von Schlüssel-Wert-Paaren, wobei der Schlüssel der Tag-Name und der Wert der Schlüsselwert ist.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.

Schlüssel-Muster: (?!aws:)[a-zA-Z+-=._:/]+

Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.

Erforderlich: Nein

vpcSecurityGroupIds

Eine Liste von EC2 VPC-Sicherheitsgruppen, die dem Elastic Cluster zugeordnet werden sollen.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

cluster

Gibt Informationen über den wiederhergestellten elastischen Cluster zurück.

Typ: Cluster Objekt

Fehler

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

AccessDeniedException

Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.

message

Eine Fehlermeldung, die erklärt, warum der Zugriff verweigert wurde.

HTTP Status Code: 403

ConflictException

Es gab einen Zugriffskonflikt.

resourceId

Die ID der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.

resourceType

Der Typ der Ressource, bei der ein Zugriffskonflikt aufgetreten ist.

HTTP-Statuscode: 409

InternalServerException

Es ist ein interner Serverfehler aufgetreten.

HTTP Status Code: 500

ResourceNotFoundException

Die angegebene Ressource konnte nicht gefunden werden.

message

Eine Fehlermeldung, die den Fehler beschreibt.

resourceId

Die ID der Ressource, die nicht gefunden werden konnte.

resourceType

Der Typ der Ressource, die nicht gefunden werden konnte.

HTTP Status Code: 404

ServiceQuotaExceededException

Das Dienstkontingent für die Aktion wurde überschritten.

HTTP-Statuscode: 402

ThrottlingException

ThrottlingException wird ausgelöst, wenn die Anfrage aufgrund einer Drosselung der Anfrage abgelehnt wurde.

retryAfterSeconds

Die Anzahl der Sekunden, die gewartet werden muss, bevor der Vorgang erneut versucht wird.

HTTP-Statuscode: 429

ValidationException

Eine Struktur, die eine Validierungsausnahme definiert.

fieldList

Eine Liste der Felder, in denen die Validierungsausnahme aufgetreten ist.

message

Eine Fehlermeldung, die die Validierungsausnahme beschreibt.

reason

Der Grund, warum die Validierungsausnahme aufgetreten ist (einer von unknownOperation cannotParsefieldValidationFailed,, oderother).

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

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