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.
DescribeDBClusters
Renvoie des informations sur les clusters Amazon DocumentDB provisionnés. Cette opération d'API prend en charge la pagination. Pour certaines fonctionnalités de gestion telles que la gestion du cycle de vie des clusters et des instances, Amazon DocumentDB utilise une technologie opérationnelle partagée avec Amazon RDS et Amazon Neptune. Utilisez le paramètre filterName=engine,Values=docdb
filter pour renvoyer uniquement les clusters Amazon DocumentDB.
Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.
- DBClusterIdentifier
-
L'identifiant de cluster fourni par l'utilisateur. Si ce paramètre est spécifié, les informations provenant uniquement du cluster spécifique sont renvoyées. Ce paramètre n'est pas sensible à la casse.
Contraintes :
-
S'il est fourni, il doit correspondre à un existant
DBClusterIdentifier
.
Type : chaîne
Obligatoire : non
-
- Filtres.Filter.N
-
Filtre qui spécifie un ou plusieurs clusters à décrire.
Filtres pris en charge :
-
db-cluster-id
- Accepte les identifiants de cluster et les Amazon Resource Names (ARN) des clusters. La liste des résultats inclut uniquement des informations sur les clusters identifiés par ces ARN.
Type : tableau d’objets Filter
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
Éléments de réponse
Les éléments suivants sont renvoyés par le service.
- DbClusters.DBCluster.n
-
Une liste de clusters.
Type : tableau d’objets DBCluster
- 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.
- DBClusterNotFoundFault
-
DBClusterIdentifier
ne fait pas référence à un 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 :