DescribeDBInstances
Devuelve información acerca de las instancias de Amazon DocumentDB aprovisionadas. Esta API admite la paginación.
Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
- DBInstanceIdentifier
-
El identificador de instancia proporcionado por el usuario. Si se especifica este parámetro, solo se devuelve información de la instancia específica. Este parámetro no distingue entre mayúsculas y minúsculas.
Restricciones:
-
De ser proporcionado, debe coincidir con el identificador de un
DBInstanceexistente.
Tipo: cadena
Requerido: no
-
- Filters.Filter.N
-
Un filtro que especifica una o varias instancias para describir.
Filtros compatibles:
-
db-cluster-id: acepta identificadores de clúster y clústeres de los Nombres de recursos de Amazon (ARN). La lista de resultados solo incluye información sobre las instancias asociadas con los clústeres identificados por estos ARN. -
db-instance-id: admite identificadores de instancia y ARN de instancia. La lista de resultados solo incluirá información sobre las instancias identificadas por estos ARN.
Tipo: matriz de objetos Filter
Requerido: no
-
- Marker
-
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por
MaxRecords.Tipo: cadena
Requerido: no
- MaxRecords
-
El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor
MaxRecordsespecificado, se incluye en la respuesta un token de paginación (marcador) de modo que se puedan recuperar el resto de los resultados.Predeterminado: 100
Restricciones: mínimo 20, máximo 100.
Tipo: entero
Requerido: no
Elementos de respuesta
El servicio devuelve los siguientes elementos.
- DBInstances.DBInstance.N
-
Información detallada sobre una o varias instancias.
Tipo: matriz de objetos DBInstance
- Marker
-
Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por
MaxRecords.Tipo: cadena
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- DBInstanceNotFound
-
DBInstanceIdentifierno hace referencia a una instancia existente.Código de estado HTTP: 404
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
