DescribeSnapshots - Amazon MemoryDB

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

DescribeSnapshots

Restituisce informazioni sulle istantanee del cluster. Per impostazione predefinita, DescribeSnapshots elenca tutte le istantanee; facoltativamente può descrivere una singola istantanea o solo le istantanee associate a un particolare cluster.

Sintassi della richiesta

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

Parametri della richiesta

Per informazioni sui parametri comuni per tutte le azioni, consulta Parametri comuni.

La richiesta accetta i seguenti dati in formato JSON.

ClusterName

Un identificatore di cluster fornito dall'utente. Se viene specificato questo parametro, vengono descritte solo le istantanee associate a quel cluster specifico.

Tipo: string

Campo obbligatorio: no

MaxResults

Numero massimo di record da includere nella risposta. Se esistono più record rispetto al MaxResults valore specificato, nella risposta viene incluso un token in modo da poter recuperare i risultati rimanenti.

Tipo: integer

Campo obbligatorio: no

NextToken

Un argomento opzionale da utilizzare nel caso in cui il numero totale di record superi il valore di. MaxResults Se viene restituito nextToken, ci sono più risultati disponibili. Il valore di nextToken è un token di impaginazione unico per ogni pagina. Effettua nuovamente la chiamata utilizzando il token restituito per recuperare la pagina successiva. Mantieni invariati tutti gli altri argomenti.

Tipo: string

Campo obbligatorio: no

ShowDetail

Un valore booleano che, se vero, la configurazione dello shard è inclusa nella descrizione dello snapshot.

Tipo: Booleano

Campo obbligatorio: no

SnapshotName

Un nome dell'istantanea fornito dall'utente. Se viene specificato questo parametro, viene descritta solo l'istantanea con nome.

Tipo: string

Campo obbligatorio: no

Source

Se impostato su system, l'output mostra le istantanee create automaticamente da MemoryDB. Se impostato su user, l'output mostra le istantanee create manualmente. Se omesso, l'output mostra le istantanee create automaticamente e manualmente.

Tipo: string

Campo obbligatorio: no

Sintassi della risposta

{ "NextToken": "string", "Snapshots": [ { "ARN": "string", "ClusterConfiguration": { "Description": "string", "EngineVersion": "string", "MaintenanceWindow": "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" } ] }

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

NextToken

Un argomento opzionale da utilizzare nel caso in cui il numero totale di record superi il valore di. MaxResults Se viene restituito nextToken, ci sono più risultati disponibili. Il valore di nextToken è un token di impaginazione unico per ogni pagina. Effettua nuovamente la chiamata utilizzando il token restituito per recuperare la pagina successiva. Mantieni invariati tutti gli altri argomenti.

Tipo: stringa

Snapshots

Un elenco di istantanee. Ogni elemento dell'elenco contiene informazioni dettagliate su un'istantanea.

Tipo: matrice di oggetti Snapshot

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

InvalidParameterCombinationException

Codice di stato HTTP: 400

InvalidParameterValueException

Codice di stato HTTP: 400

ServiceLinkedRoleNotFoundFault

Codice di stato HTTP: 400

SnapshotNotFoundFault

Codice di stato HTTP: 400

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli SDK AWS specifici della lingua, consulta quanto segue: