CreateClusterSnapshot - 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.

CreateClusterSnapshot

Erstellt einen Snapshot eines elastischen Clusters.

Anforderungssyntax

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

{
   "clusterArn": "string",
   "snapshotName": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

clusterArn

Die ARN-ID des Elastic Clusters, von dem Sie einen Snapshot erstellen möchten.

Typ: Zeichenfolge

Erforderlich: Ja

snapshotName

Der Name des neuen Elastic Cluster-Snapshots.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 63 Zeichen.

Erforderlich: Ja

tags

Die Tags, die dem neuen Elastic Cluster-Snapshot zugewiesen werden sollen.

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

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "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.

snapshot

Gibt Informationen über den neuen Elastic Cluster-Snapshot zurück.

Typ: ClusterSnapshot 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.

HTTP Status Code: 403

ConflictException

Es gab einen Zugriffskonflikt.

HTTP-Statuscode: 409

InternalServerException

Es ist ein interner Serverfehler aufgetreten.

HTTP Status Code: 500

ResourceNotFoundException

Die angegebene Ressource konnte nicht gefunden werden.

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.

HTTP-Statuscode: 429

ValidationException

Eine Struktur, die eine Validierungsausnahme definiert.

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: