View a markdown version of this page

DescribeSnapshots - Amazon MemoryDB
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerWeitere 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.

DescribeSnapshots

Gibt Informationen über Cluster-Snapshots zurück. DescribeSnapshots Listet standardmäßig alle Ihre Snapshots auf. Es kann optional einen einzelnen Snapshot oder nur die Snapshots beschreiben, die einem bestimmten Cluster zugeordnet sind.

Anforderungssyntax

{
   "ClusterName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ShowDetail": boolean,
   "SnapshotName": "string",
   "Source": "string"
}

Anforderungsparameter

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

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ClusterName

Eine vom Benutzer angegebene Cluster-ID. Wenn dieser Parameter angegeben ist, werden nur Snapshots beschrieben, die diesem bestimmten Cluster zugeordnet sind.

Typ: Zeichenfolge

Erforderlich: Nein

MaxResults

Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehr Datensätze als der angegebene MaxResults Wert vorhanden sind, ist ein Token in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.

Typ: Ganzzahl

Erforderlich: Nein

NextToken

Ein optionales Argument, das übergeben wird, falls die Gesamtzahl der Datensätze den Wert von überschreitet MaxResults. Wenn nextToken zurückgegeben wird, sind mehr Ergebnisse verfügbar. Der Wert von nextToken ist ein eindeutiges Paginierungstoken für jede Seite. Rufen Sie den Anruf erneut mit dem zurückgegebenen Token auf, um die nächste Seite abzurufen. Lassen Sie alle anderen Argumente unverändert.

Typ: Zeichenfolge

Erforderlich: Nein

ShowDetail

Ein boolescher Wert. Wenn der Wert wahr ist, ist die Shard-Konfiguration in der Snapshot-Beschreibung enthalten.

Typ: Boolesch

Erforderlich: Nein

SnapshotName

Ein vom Benutzer eingegebener Name des Snapshots. Wenn dieser Parameter angegeben ist, wird nur dieser benannte Snapshot beschrieben.

Typ: Zeichenfolge

Erforderlich: Nein

Source

Wenn der Wert auf System gesetzt ist, zeigt die Ausgabe Schnappschüsse, die automatisch von MemoryDB erstellt wurden. Wenn die Einstellung auf user gesetzt ist, zeigt die Ausgabe Schnappschüsse, die manuell erstellt wurden. Wenn nicht angegeben, werden in der Ausgabe sowohl automatisch als auch manuell erstellte Schnappschüsse angezeigt.

Typ: Zeichenfolge

Erforderlich: Nein

Antwortsyntax

{
   "NextToken": "string",
   "Snapshots": [ 
      { 
         "ARN": "string",
         "ClusterConfiguration": { 
            "Description": "string",
            "Engine": "string",
            "EngineVersion": "string",
            "MaintenanceWindow": "string",
            "MultiRegionClusterName": "string",
            "MultiRegionParameterGroupName": "string",
            "Name": "string",
            "NodeType": "string",
            "NumShards": number,
            "ParameterGroupName": "string",
            "Port": number,
            "Shards": [ 
               { 
                  "Configuration": { 
                     "ReplicaCount": number,
                     "Slots": "string"
                  },
                  "Name": "string",
                  "Size": "string",
                  "SnapshotCreationTime": number
               }
            ],
            "SnapshotRetentionLimit": number,
            "SnapshotWindow": "string",
            "SubnetGroupName": "string",
            "TopicArn": "string",
            "VpcId": "string"
         },
         "DataTiering": "string",
         "KmsKeyId": "string",
         "Name": "string",
         "Source": "string",
         "Status": "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.

NextToken

Ein optionales Argument, das übergeben wird, falls die Gesamtzahl der Datensätze den Wert von MaxResults überschreitet. Wenn nextToken zurückgegeben wird, sind mehr Ergebnisse verfügbar. Der Wert von nextToken ist ein eindeutiges Paginierungstoken für jede Seite. Rufen Sie den Anruf erneut mit dem zurückgegebenen Token auf, um die nächste Seite abzurufen. Lassen Sie alle anderen Argumente unverändert.

Typ: Zeichenfolge

Snapshots

Eine Liste von Schnappschüssen. Jedes Element in der Liste enthält detaillierte Informationen zu einem Snapshot.

Typ: Array von Snapshot-Objekten

Fehler

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

InvalidParameterCombinationException

HTTP-Statuscode: 400

InvalidParameterValueException

HTTP-Statuscode: 400

ServiceLinkedRoleNotFoundFault

HTTP-Statuscode: 400

SnapshotNotFoundFault

HTTP-Statuscode: 400

Weitere Informationen finden Sie unter:

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