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.
DescribeDBInstances
Renvoie des informations sur les instances Amazon DocumentDB provisionnées. Cette 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.
- DBInstanceIdentifier
-
L'identifiant d'instance fourni par l'utilisateur. Si ce paramètre est spécifié, les informations provenant uniquement de l'instance spécifique sont renvoyées. Ce paramètre n'est pas sensible à la casse.
Contraintes :
-
S'il est fourni, il doit correspondre à l'identifiant d'un existant
DBInstance.
Type : chaîne
Obligatoire : non
-
- Filtres.Filter.N
-
Filtre qui spécifie une ou plusieurs instances à 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 les informations relatives aux instances associées aux clusters identifiés par ces ARN. -
db-instance-id- Accepte les identifiants d'instance et les ARN d'instance. La liste des résultats inclut uniquement les informations relatives aux instances identifiées 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
MaxRecordsvaleur 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.
- DBInstances.DBInstance.n
-
Informations détaillées sur une ou plusieurs instances.
Type : tableau d’objets DBInstance
- 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.
- DBInstanceNotFound
-
DBInstanceIdentifierne fait pas référence à une instance existante.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 :
