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.
DescribeGlobalClusters
Devuelve información sobre los clústeres globales de Amazon DocumentDB. Esta API admite la paginación.
nota
Esta acción solo se aplica a los clústeres de Amazon DocumentDB.
Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
- Filters.Filter.N
-
Un filtro que especifica uno o varios clústeres de bases de datos globales a describir.
Filtros admitidos:
db-cluster-id
acepta identificadores de clúster y Nombres de recursos de Amazon (ARN) de clúster. La lista de resultados solo incluirá información sobre los clústeres identificados por estos ARN.Tipo: matriz de objetos Filter
Obligatorio: no
- GlobalClusterIdentifier
-
El identificador de clúster de base de datos suministrado por el usuario. Si se especifica este parámetro, se devuelve información solo del clúster específico. Este parámetro no distingue entre mayúsculas y minúsculas.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.
Patrón:
[A-Za-z][0-9A-Za-z-:._]*
Obligatorio: no
- Marker
-
Un token de paginación opcional proporcionado por una solicitud
DescribeGlobalClusters
anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado porMaxRecords
.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 que se conoce como marcador, de modo que usted pueda recuperar el resto de los resultados.Tipo: entero
Obligatorio: no
Elementos de respuesta
El servicio devuelve los siguientes elementos.
- GlobalClusters. GlobalClusterMemberN.
-
Tipo: matriz de objetos GlobalCluster
- Marker
-
Tipo: cadena
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- GlobalClusterNotFoundFault
-
GlobalClusterIdentifier
no hace referencia a un clúster global existente.Código de estado HTTP: 404
Véase también
Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: