DescribeDBClusterSnapshots - Amazon DocumentDB
Parámetros de la solicitudElementos de respuestaErroresVéase también

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

DescribeDBClusterSnapshots

Devuelve información acerca de instantáneas del clúster. La operación 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.

DBClusterIdentifier

El ID del clúster para recuperar la lista de instantáneas del clúster. Este parámetro no puede utilizarse con el parámetro DBClusterSnapshotIdentifier. Este parámetro no distingue entre mayúsculas y minúsculas.

Restricciones:

  • De ser proporcionado, debe coincidir con el identificador de un DBCluster existente.

Tipo: cadena

Requerido: no

DBClusterSnapshotIdentifier

Un identificador de instantánea de clúster específica para describir. Este parámetro no puede utilizarse con el parámetro DBClusterIdentifier. Este valor se almacena como una cadena en minúsculas.

Restricciones:

  • De ser proporcionado, debe coincidir con el identificador de un DBClusterSnapshot existente.

  • Si este identificador es para una instantánea automatizada, también se debe especificar el parámetro SnapshotType.

Tipo: cadena

Requerido: no

Filters.Filter.N

Este parámetro es incompatible en estos momentos.

Tipo: matriz de objetos Filter

Requerido: no

IncludePublic

Se establece en true para incluir instantáneas manuales del clúster que son públicas y que pueden ser copiadas o restauradas por cualquier Cuenta de AWS, o de otro modo false. El valor predeterminado es false.

Tipo: Booleano

Requerido: no

IncludeShared

Se establece en true para incluir instantáneas manuales compartidas del clúster de otras Cuentas de AWS a las que esta Cuenta de AWS ha recibido permiso para copiar o restaurar, y de otro modo false. El valor predeterminado es false.

Tipo: Booleano

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 MaxRecords especificado, 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

SnapshotType

El tipo de instantáneas del clúster que se van a devolver. Puede especificar uno de los siguientes valores:

  • automated: se devuelven todas las instantáneas del clúster que Amazon DocumentDB haya creado automáticamente para su Cuenta de AWS.

  • manual: se devuelven todas las instantáneas del clúster que haya creado manualmente para su Cuenta de AWS.

  • shared: se devuelven todas las instantáneas manuales del clúster que se han compartido a su Cuenta de AWS.

  • public: se devuelven todas las instantáneas del clúster que se han marcado como públicas.

Si no se especifica ningún valor para SnapshotType, se devuelve las instantáneas del clúster automatizadas y manuales. Puede incluir instantáneas del clúster compartidas con estos resultados estableciendo el parámetro IncludeShared en true. Puede incluir instantáneas del clúster de base de datos públicas con estos resultados estableciendo el parámetro IncludePublic en true.

Los parámetros IncludeShared y IncludePublic no se aplican para los valores de SnapshotType de manual o automated. El parámetro IncludePublic no se aplica cuando se establece SnapshotType en shared. El parámetro IncludeShared no se aplica cuando se establece SnapshotType en public.

Tipo: cadena

Requerido: no

Elementos de respuesta

El servicio devuelve los siguientes elementos.

DBClusterSnapshots.DBClusterSnapshot.N

Proporciona una lista de instantáneas del clúster.

Tipo: matriz de objetos DBClusterSnapshot

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.

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifier no hace referencia a una instantánea de un clúster 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: