DescribeDBClusterSnapshots - Amazon DocumentDB
Parametri della richiestaElementi di rispostaErroriVedi anche

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

DescribeDBClusterSnapshots

Restituisce informazioni sulle istantanee del cluster. Questa operazione API supporta l'impaginazione.

Parametri della richiesta

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

DBClusterIdentifier

L'ID del cluster per cui recuperare l'elenco delle istantanee del cluster. Questo parametro non può essere utilizzato con il DBClusterSnapshotIdentifier parametro. Questo parametro non distingue tra maiuscole e minuscole.

Vincoli:

  • Se fornito, deve corrispondere all'identificatore di un esistenteDBCluster.

▬Tipo: stringa

Campo obbligatorio: no

DBClusterSnapshotIdentifier

Un identificatore di istantanea del cluster specifico da descrivere. Questo parametro non può essere utilizzato con il DBClusterIdentifier parametro. Questo valore è archiviato come stringa in caratteri minuscoli.

Vincoli:

  • Se fornito, deve corrispondere all'identificatore di un esistenteDBClusterSnapshot.

  • Se questo identificatore è per uno snapshot automatizzato, anche il parametro SnapshotType deve essere specificato.

▬Tipo: stringa

Campo obbligatorio: no

Filtri.Filtro.N

Questo parametro non è attualmente supportato.

Tipo: matrice di oggetti Filter

Campo obbligatorio: no

IncludePublic

Impostato true per includere istantanee manuali del cluster che sono pubbliche e possono essere copiate o ripristinate da chiunque e in altro modo. Account AWSfalse Il valore predefinito è false.

Tipo: Booleano

Campo obbligatorio: no

IncludeShared

È impostata true per includere istantanee manuali condivise del cluster provenienti da altri utenti per Account AWS le quali Account AWS è stata concessa l'autorizzazione a copiare o ripristinare e in altro modo. false Il valore predefinito è false.

Tipo: Booleano

Campo obbligatorio: no

Marker

Token di paginazione opzionale fornito da una richiesta precedente. Se questo parametro viene specificato, la risposta include solo i record oltre il contrassegno, fino al valore specificato da MaxRecords.

▬Tipo: stringa

Campo obbligatorio: no

MaxRecords

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

Impostazione predefinita: 100

Vincoli: minimo 20, massimo 100.

Tipo: integer

Campo obbligatorio: no

SnapshotType

Il tipo di istantanee del cluster da restituire. È possibile specificare uno dei seguenti valori:

  • automated- Restituisci tutte le istantanee del cluster che Amazon DocumentDB ha creato automaticamente per te. Account AWS

  • manual- Restituisci tutte le istantanee del cluster che hai creato manualmente per il tuo. Account AWS

  • shared- Restituisci tutte le istantanee manuali del cluster che sono state condivise con il tuo. Account AWS

  • public- Restituisce tutte le istantanee del cluster che sono state contrassegnate come pubbliche.

Se non si specifica un SnapshotType valore, vengono restituite sia le istantanee automatiche che quelle manuali del cluster. È possibile includere istantanee condivise del cluster con questi risultati impostando il IncludeShared parametro su. true È possibile includere istantanee pubbliche del cluster con questi risultati impostando il IncludePublic parametro su. true

I parametri IncludePublic e IncludeShared non sono applicabili ai valori SnapshotType di manual o automated. Il parametro IncludePublic non è applicabile quando SnapshotType è impostato su shared. Il parametro IncludeShared non è applicabile quando SnapshotType è impostato su public.

▬Tipo: stringa

Campo obbligatorio: no

Elementi di risposta

I seguenti elementi vengono restituiti dal servizio.

DB ClusterSnapshots D.B.N. ClusterSnapshot

Fornisce un elenco di istantanee del cluster.

Tipo: matrice di oggetti DBClusterSnapshot

Marker

Token di paginazione opzionale fornito da una richiesta precedente. Se questo parametro viene specificato, la risposta include solo i record oltre il contrassegno, fino al valore specificato da MaxRecords.

▬Tipo: stringa

Errori

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

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifiernon fa riferimento a un'istantanea del cluster esistente.

Codice di stato HTTP: 404

Vedi anche

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