DescribeDBClusterSnapshots - Amazon DocumentDB
Paramètres de demandeÉléments de réponseErreursconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

DescribeDBClusterSnapshots

Renvoie des informations sur les instantanés du cluster. Cette opération d'API prend en charge la pagination.

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

DBClusterIdentifier

ID du cluster pour lequel récupérer la liste des instantanés du cluster. Ce paramètre ne peut pas être utilisé avec le DBClusterSnapshotIdentifier paramètre. Ce paramètre n'est pas sensible à la casse.

Contraintes :

  • S'il est fourni, il doit correspondre à l'identifiant d'un existantDBCluster.

Type : chaîne

Obligatoire : non

DBClusterSnapshotIdentifier

Identifiant de capture d'écran spécifique du cluster à décrire. Ce paramètre ne peut pas être utilisé avec le DBClusterIdentifier paramètre. Cette valeur est stockée sous la forme d'une chaîne en minuscules.

Contraintes :

  • S'il est fourni, il doit correspondre à l'identifiant d'un existantDBClusterSnapshot.

  • Si cet identifiant est destinée à un instantané automatisé, le paramètre SnapshotType doit également être spécifié.

Type : chaîne

Obligatoire : non

Filtres.Filter.N

Ce paramètre n'est actuellement pas pris en charge.

Type : tableau d’objets Filter

Obligatoire : non

IncludePublic

Définissez sur true pour inclure les instantanés de cluster manuels qui sont publics et peuvent être copiés ou restaurés par n'importe qui Compte AWS, ou autrementfalse. L’argument par défaut est false.

Type : booléen

Obligatoire : non

IncludeShared

Définissez sur true pour inclure les instantanés de cluster manuels partagés provenant d'autres Comptes AWS entités autorisées à copier ou à restaurer, etc. Compte AWS false L’argument par défaut est false.

Type : booléen

Obligatoire : non

Marker

Jeton de pagination facultatif fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par MaxRecords.

Type : chaîne

Obligatoire : non

MaxRecords

Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la MaxRecords valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.

Par défaut : 100

Contraintes : Minimum 20, maximum 100.

Type : entier

Obligatoire : non

SnapshotType

Type de snapshots de cluster à renvoyer. Vous pouvez spécifier l’une des valeurs suivantes :

  • automated- Renvoie tous les instantanés de cluster qu'Amazon DocumentDB a automatiquement créés pour vous. Compte AWS

  • manual- Renvoie tous les instantanés de cluster que vous avez créés manuellement pour votre Compte AWS.

  • shared- Renvoie tous les instantanés de cluster manuels qui ont été partagés avec votre Compte AWS.

  • public- Renvoie tous les instantanés du cluster marqués comme publics.

Si vous ne spécifiez aucune SnapshotType valeur, les instantanés de cluster automatisés et manuels sont renvoyés. Vous pouvez inclure des instantanés de cluster partagés avec ces résultats en définissant le IncludeShared paramètre sur. true Vous pouvez inclure des instantanés de clusters publics avec ces résultats en définissant le IncludePublic paramètre sur. true

Les paramètres IncludeShared et IncludePublic ne s'appliquent pas pour les valeurs SnapshotType de manual ou automated. Le paramètre IncludePublic ne s'applique pas lorsque SnapshotType est défini sur shared. Le paramètre IncludeShared ne s'applique pas lorsque SnapshotType est défini sur public.

Type : chaîne

Obligatoire : non

Éléments de réponse

Les éléments suivants sont renvoyés par le service.

ClusterSnapshotsDB D.B. N. ClusterSnapshot

Fournit une liste des instantanés du cluster.

Type : tableau d’objets DBClusterSnapshot

Marker

Jeton de pagination facultatif fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par MaxRecords.

Type : chaîne

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifierne fait pas référence à un instantané de cluster existant.

Code d’état HTTP : 404

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :