Devolver todos los clústeres en un proyecto

OBTENER /api/atlas/v1.0/groups/{groupId}/clusters
Cuentas de servicio Autorización de resumen

Devuelve los detalles de todos los clústeres del proyecto específico al que tiene acceso. Los clústeres contienen un grupo de hosts que mantienen el mismo conjunto de datos. La respuesta no incluye clústeres multinube. Para obtener clústeres multinube, utilice "Obtener todos los clústeres avanzados". Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de solo lectura del proyecto.

Este punto de conexión también se puede usar en clústeres Flex creados con el punto de conexión "Crear clúster" o en clústeres M 2/M anteriores5 que se migraron a clústeres Flex hasta el de enero.2026 Utilice el punto de conexión "Listar clústeres Flex" para clústeres Flex.

Lista de Flex clústeres

Parámetros de path

  • ID del grupo string Requerido

    string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

    NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

Parámetros de query

  • envelope booleano

    Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • includeCount booleano

    Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en la respuesta.

    El valor por defecto es true.

  • elementosPorPágina entero

    Número de elementos que la respuesta retorna por página.

    El valor mínimo es 1, el valor máximo es 500. El valor predeterminado es 100.

  • Num. de pág. entero

    Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.

    El valor mínimo es 1. El valor por defecto es 1.

  • bonito booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.

    El valor por defecto es false.

    Impresión bonita
  • incluirEliminadosConCopiasDeSeguridadConservadas booleano

    Bandera que indica si se deben devolver clústeres con copias de seguridad conservadas.

    El valor por defecto es false.

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • enlaces arreglo[objeto]

      Lista de uno o más uniform resource locators (URL) que apuntan a subrecursos de API, recursos API relacionados o ambos. RFC 5988 describe estas relaciones.

      Especificación de vinculación web (RFC...
      Ocultar atributos de enlaces Mostrar los atributos de los enlaces Objeto
      • href string

        Localizador uniforme de recursos (URL) que señala otro recurso de la API con el que esta respuesta guarda relación. Esta URL suele comenzar con https://cloud.mongodb.com/api/atlas.

      • rel string

        Localizador Uniforme de Recursos (URL) que define la relación semántica entre este recurso y otro recurso de la API. Esta URL suele comenzar con https://cloud.mongodb.com/api/atlas.

    • Resultados arreglo[objeto] Requerido

      Lista de documentos devueltos que MongoDB nube proporciona al completar esta solicitud.

      Ocultar atributos de resultados Mostrar atributos de resultados Objeto

      Grupo de configuraciones que configuran un clúster de MongoDB.

      • acceptDataRisksAndForceReplicaSetReconfig string(date-time)

        Si se requiere una reconfiguración para recuperar un primario debido a una interrupción regional, envía este campo junto con tu reconfiguración de topología para solicitar una nueva topología resistente a interrupciones regionales. Las reconfiguraciones forzadas durante una interrupción de la mayoría de los nodos elegibles conllevan un riesgo de pérdida de datos si las escrituras replicadas (incluso las escrituras comprometidas por la mayoría) no se han replicado en el nuevo nodo primario. Los Docs de MongoDB Atlas contienen más información. Para proceder con una operación que conlleva ese riesgo, establecer acceptDataRisksAndForceReplicaSetReconfig a la fecha actual. Este parámetro expresa su valor en el formato de timestamp ISO 8601 en UTC.

        Reconfiguración de un conjunto de réplicas...
      • advancedConfiguration Objeto

        Grupo de ajustes que configura un subconjunto de los detalles avanzados de configuración.

        Ocultar atributos de configuración avanzada Mostrar atributos avanzados de configuración Objeto
        • customOpensslCipherConfigTls12 array[string]

          Lista de conjuntos de cifrado OpenSSL personalizados para TLS 1.2. Este campo solo es válido cuando tlsCipherConfigMode se establece en CUSTOM.

          Los valores son TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 o TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.

        • customOpensslCipherConfigTls13 array[string]

          Lista de conjuntos de cifrado OpenSSL personalizados para TLS 1.3. Este campo solo es válido cuando tlsCipherConfigMode se establece en CUSTOM.

          No más de 4 elementos. Los valores son TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_GCM_SHA256 o TLS_AES_128_CCM_SHA256.

        • minimumEnabledTlsProtocol string

          Versión mínima de Seguridad de la Capa de Transporte (TLS) que el clúster acepta para las conexiones entrantes. Los clústeres que utilizan TLS 1.0 o 1.1 deberían considerar configurar TLS 1.2 como la versión mínima del protocolo TLS.

          Los valores son TLS1_0, TLS1_1, TLS1_2 o TLS1_3.

          Esta opción corresponde a la...
        • tlsCipherConfigMode string

          Modo de configuración del conjunto de cifrado TLS. El modo predeterminado utiliza los conjuntos de cifrado predeterminados. El modo personalizado permite especificar conjuntos de cifrado personalizados para TLS 1.2 y TLS 1.3.

          Los valores son CUSTOM o DEFAULT.

      • autoScaling Objeto

        Rango de tamaños de instancias a los que puede escalar su clúster.

        Escalado automático de clúster
        Ocultar los atributos de autoScaling Mostrar atributos de escalamiento automático Objeto
        • compute Objeto

          Colección de configuraciones que configura cómo un clúster podría escalar su nivel de clúster y si el clúster puede escalar hacia abajo. El escalado automático del nivel del clúster no está disponible para clústeres que utilizan clases de almacenamiento de baja CPU o almacenamiento NVMe.

          Ocultar atributos de cálculo Mostrar atributos computacionales Objeto
          • habilitado booleano

            Bandera que indica si el escalamiento automático reactivo del tamaño de instancia está habilitado.

            • Establézcalo en true para habilitar el escalado automático reactivo del tamaño de la instancia. Si está habilitado, debe especificar un valor para providerSettings.autoScaling.compute.maxInstanceSize.
            • Establezca en false para deshabilitar el escalamiento automático reactivo del tamaño de instancia.

            El valor por defecto es false.

          • escala descendente habilitada booleano

            Indicador que indica si el nivel de clúster puede escalar hacia abajo mediante escalado automático reactivo. Esto es necesario si autoScaling.compute.enabled es true. Si habilitas esta opción, especifica un valor para providerSettings.autoScaling.compute.minInstanceSize.

            El valor por defecto es false.

        • diskGBHabilitado booleano

          Indicador que señala si alguien habilitó el escalado automático de disco para este clúster.

          El valor por defecto es false.

      • copia de seguridad habilitada booleano

        Indicador que señala si el clúster puede realizar copias de seguridad. Si se establece en true, el clúster puede realizar copias de seguridad. Debe establecer este valor en true para clústeres NVMe. La copia de seguridad utiliza Copias de seguridad en la nube para clústeres dedicados y Copias de seguridad de clústeres compartidos para clústeres de inquilinos. Si se establece en false, el clúster no utiliza copias de seguridad en la nube de MongoDB.

      • Conector para BI Objeto

        Configuraciones necesarias para configurar el MongoDB Connector for Business Intelligence para este clúster.

        MongoDB Connector para negocios...
        Ocultar atributos de biConnector Mostrar atributos biConector Objeto
        • habilitado booleano

          Indicador que señala si el Connector de MongoDB para Business Intelligence está activo en el clúster especificado.

        • readPreference string

          Nodo fuente de datos designado para el MongoDB Connector for Business Intelligence en MongoDB nube. El MongoDB Connector for Business Intelligence en MongoDB Cloud lee datos desde el nodo principal, secundario o de análisis según tus preferencias de lectura. Por defecto en el nodo ANALYTICS, o en SECONDARY si no hay nodos ANALYTICS.

          Los valores son PRIMARY, SECONDARY o ANALYTICS.

          Leer las preferencias para el BI Connector
      • Tipo de clúster string

        Configuración de los nodos que componen el clúster.

        Los valores son REPLICASET, SHARDED o GEOSHARDED.

      • Modo de gestión del servidor de configuración string

        Modo de gestión del servidor de configuración para crear o actualizar un clúster. Cuando está configurado como ATLAS_MANAGED, Atlas puede cambiar automáticamente el tipo de servidor de configuración del clúster para un rendimiento y ahorro óptimos. Cuando está configurado como FIXED_TO_DEDICATED, el clúster siempre usará un servidor de configuración dedicado.

        Los valores son ATLAS_MANAGED o FIXED_TO_DEDICATED. El valor por defecto es ATLAS_MANAGED.

        Configuración del clúster compartido de MongoDB...
      • tipo de servidor de configuración string

        Describe el tipo de servidor de configuración de un clúster particionado.

        Los valores son DEDICATED o EMBEDDED.

        Configuración del clúster compartido de MongoDB...
      • cadenas de conexión Objeto

        Colección de localizadores de recursos uniformes que apuntan a la base de datos MongoDB.

        Formato URI de la cadena de conexión.
        Ocultar atributos de connectionStrings Mostrar los atributos de connectionStrings Objeto
        • awsPrivateLink Objeto

          Cadenas de conexión conscientes de nodos privados que usan clústeres alojados en AWS con Amazon Web Services (AWS) PrivateLink. Cada clave identifica un endpoint de la interfaz de Amazon Web Services (AWS). Cada valor identifica la cadena de conexión mongodb:// relacionada que se utiliza para conectarse a MongoDB nube a través del endpoint de la interfaz que nombra la clave.

          Conexión peering de red
          Ocultar el atributo awsPrivateLink Mostrar atributo awsPrivateLink Objeto
          • * string Propiedades adicionales

            Cadenas de conexión conscientes de nodos privados que usan clústeres alojados en AWS con Amazon Web Services (AWS) PrivateLink. Cada clave identifica un endpoint de la interfaz de Amazon Web Services (AWS). Cada valor identifica la cadena de conexión mongodb:// relacionada que se utiliza para conectarse a MongoDB nube a través del endpoint de la interfaz que nombra la clave.

            Conexión peering de red
        • awsPrivateLinkSrv Objeto

          Cadenas de conexión sensibles a nodos privados que utilizan clústeres hosteados por AWS con Amazon Web Services (AWS) PrivateLink. Cada clave identifica un endpoint de la interfaz de Amazon Web Services (AWS). Cada valor identifica la cadena de conexión mongodb:// relacionada que utiliza para conectarse a Atlas a través del endpoint de la interfaz que denomina los nombres de clave. Si el clúster utiliza una cadena de conexión optimizada, awsPrivateLinkSrv contiene la cadena de conexión optimizada. Si el clúster tiene la cadena de conexión no optimizada (heredada), awsPrivateLinkSrv contiene la cadena de conexión no optimizada aunque también esté presente una cadena de conexión optimizada.

          Conexión peering de red
          Ocultar el atributo awsPrivateLinkSrv Mostrar atributo awsPrivateLinkSrv Objeto
          • * string Propiedades adicionales

            Cadenas de conexión sensibles a nodos privados que utilizan clústeres hosteados por AWS con Amazon Web Services (AWS) PrivateLink. Cada clave identifica un endpoint de la interfaz de Amazon Web Services (AWS). Cada valor identifica la cadena de conexión mongodb:// relacionada que utiliza para conectarse a Atlas a través del endpoint de la interfaz que denomina los nombres de clave. Si el clúster utiliza una cadena de conexión optimizada, awsPrivateLinkSrv contiene la cadena de conexión optimizada. Si el clúster tiene la cadena de conexión no optimizada (heredada), awsPrivateLinkSrv contiene la cadena de conexión no optimizada aunque también esté presente una cadena de conexión optimizada.

            Conexión peering de red
        • privado string

          Cadenas de conexión peering de red para cada interfaz Punto de Interfaz de Virtual Private Cloud (VPC) que has configurado para conectarte a este clúster. Esta cadena de conexión utiliza el protocolo mongodb+srv://. El recurso entrega este parámetro una vez que alguien crea una conexión peering de red a este clúster. Este protocolo indica a la aplicación que busque la lista de nodos iniciales del host en el Sistema de Nombres de Dominio (DNS). Esta lista se sincroniza con los nodos en un clúster. Si la cadena de conexión utiliza este formato de identificador uniforme de recursos (URI), no necesitas agregar la lista de nodos iniciales ni cambiar el URI si los nodos cambian. Utiliza este formato de URI si tu driver es compatible. Si no es así, usa connectionStrings.private. Para los clústeres de Amazon Web Services (AWS), este recurso solo devuelve este parámetro si habilitas DNS personalizado.

          Conexión peering de red
        • Nodo privado arreglo[objeto]

          Lista de cadenas de conexión privadas conscientes de los puntos finales que puedes usar para conectarte a este clúster a través de un punto final privado. Este parámetro solo se devuelve si has implementado un endpoint privado para todas las regiones a las que has implementado los nodos de este clúster.

          Ocultar atributos de privateEndpoint Mostrar atributos de privateEndpoint Objeto

          Cadena de conexión consciente de nodos privados que puedes usar para conectarte a este clúster a través de un nodo privado.

          Punto final privado para dedicado...
          • cadena de conexión string

            Cadena de conexión consciente de la terminal privada que utiliza el protocolo mongodb:// para conectar con MongoDB nube a través de una terminal privada.

          • puntos finales arreglo[objeto]

            Lista que contiene los nodos privados a través de los cuales te conectas a MongoDB nube cuando usas connectionStrings.privateEndpoint[n].connectionString o connectionStrings.privateEndpoint[n].srvConnectionString.

            Ocultar atributos de los endpoints Mostrar atributos de los puntos finales Objeto

            Detalles de un endpoint privado implementado para este clúster.

            • endpointId string

              string única que el proveedor de nube utiliza para identificar el endpoint privado.

            • providerName string

              Proveedor de nube en el que MongoDB Cloud implementa el punto final privado.

              Los valores son AWS, AZURE o GCP.

            • region string

              Región donde se implementa el endpoint privado.

          • cadena de conexión srv string

            Cadena de conexión consciente de un endpoint privado que utiliza el protocolo mongodb+srv:// para conectarse a MongoDB Cloud a través de un endpoint privado. El mongodb+srv protocolo indica al driver que busque la lista de nodos iniciales de hosts en el sistema de nombres de dominio (DNS). Esta lista se sincroniza con los nodos en un clúster. Si la cadena de conexión utiliza este formato de Identificador Uniforme de Recursos (URI), no necesita agregar la lista de nodos iniciales ni cambiar el Identificador Uniforme de Recursos (URI) si cambian los nodos. Usa este formato de Identificador Uniforme de Recursos (URI) si tu aplicación lo admite. Si no es así, usa connectionStrings.privateEndpoint[n].connectionString.

          • srvShardOptimizedConnectionString string

            Cadena de conexión optimizada para clústeres particionados con terminal privado que utiliza el protocolo mongodb+srv:// para conectarse a MongoDB Cloud a través de un terminal privado. Si la cadena de conexión utiliza este formato de identificador uniforme de recursos (URI), no necesitas cambiar el identificador uniforme de recursos (URI) si los nodos cambian. Utiliza este formato de Uniform Resource Identifier (URI) si tu aplicación y el clúster de Atlas lo admiten. Si no lo hace, utiliza y consulta la documentación de connectionStrings.privateEndpoint[n].srvConnectionString.

          • tipo string

            Tipo de proceso MongoDB al que se conecta su aplicación. Utilice MONGOD para los sets de réplicas y MONGOS para los clústeres.

            Los valores son MONGOD o MONGOS.

        • privateSrv string

          Cadenas de conexión peering de red para cada uno de los endpoints de Virtual Private Cloud (VPC) de interfaz que configuraste para conectarte a este clúster. Esta cadena de conexión utiliza el protocolo mongodb+srv://. El recurso devuelve este parámetro cuando alguien crea una conexión peering de red a este clúster. Este protocolo indica a la aplicación que busque la lista de nodos iniciales de host en el Sistema de Nombres de Dominio (DNS). Esta lista se sincroniza con los nodos en un clúster. Si la cadena de conexión utiliza este formato de Identificador Uniforme de Recursos (URI), no es necesario agregar la lista de nodos iniciales ni cambiar el Identificador Uniforme de Recursos (URI) si los nodos cambian. Use este formato de Identificador Uniforme de Recursos (URI) si su controlador lo admite. Si no lo hace, utiliza connectionStrings.private. Para clústeres de Amazon Web Services (AWS), este parámetro sólo se devuelve si Activa DNS personalizada.

          Conexión peering de red
        • estándar string

          Cadena de conexión pública que puede usar para conectarse a este clúster. Esta cadena de conexión usa el protocolo mongodb://.

          Formato de URI de cadena de conexión
        • estándarSrv string

          Cadena de conexión pública que puede usar para conectarse a este clúster. Esta cadena de conexión usa el protocolo mongodb+srv://.

          Formato de URI de cadena de conexión
      • fecha de creación string(date-time)

        Fecha y hora en que MongoDB Cloud creó esta instancia sin servidor. MongoDB nube representa esta marca de tiempo en formato ISO 8601 en UTC.

      • deleteAfterCreationHours integer(int32)

        Número de horas después de la creación del clúster tras el cual este clúster se borrará automáticamente.

        Este campo se utiliza para derivar deleteAfterDate en relación con createDate.

        Cuando se establezca en nulo o cero al crear el clúster, este no se borrará automáticamente.

        Cuando se establece en un valor positivo al crear el clúster, el clúster se eliminará automáticamente después de la cantidad de horas especificada.

        Al actualizar este campo en un clúster existente (que no se ha eliminado), y si esto se configura como nulo, entonces los valores existentes se conservarán para esto y deleteAfterDate.

        Al actualizar este campo en un clúster existente (no eliminado), y se establece en cero, entonces deleteAfterDate se restablece a nulo (deshabilita la eliminación automática) independientemente de las configuraciones anteriores.

        Al actualizar este campo en un clúster existente (no eliminado), y si se establece un valor positivo, entonces createDate + deleteAfterCreationHours debe ser posterior a ahora; si no se cumple esta condición, la actualización del campo se ignora y se preservan los valores existentes para este & deleteAfterDate.

      • deleteAfterDate string(date-time)

        La fecha en la que este clúster será eliminado automáticamente.

        Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC y se deriva en base a createDate + deleteAfterCreationHours.

      • diskSizeGB número(doble)

        Capacidad de almacenamiento de los volúmenes de datos de instancia expresada en gigabytes. Aumenta este número para añadir capacidad.

        Este valor no es configurable en clústeres M0/M2/M5.

        MongoDB Cloud requiere este parámetro si configura replicationSpecs.

        Si se especifica un tamaño de disco inferior al mínimo (10 GB), este parámetro se ajusta por defecto al valor mínimo de tamaño de disco.

        Los cálculos del cargo por almacenamiento dependen de si eliges el valor por defecto o un valor personalizado.

        El valor máximo del almacenamiento en disco no puede exceder 50 veces la RAM máxima para el clúster seleccionado. Si necesita más espacio de almacenamiento, considera actualizar su clúster a un nivel superior.

        El valor mínimo es 10, el valor máximo es 4096.

      • diskWarmingMode string

        Selección de modo de calentamiento de disco.

        Los valores son FULLY_WARMED o VISIBLE_EARLIER. El valor por defecto es FULLY_WARMED.

        Reducir el calentamiento del disco secundario...
      • proveedor de cifrado en reposo string

        Proveedor de servicios en la nube que gestiona las claves de los clientes para proporcionar una capa adicional de cifrado en reposo para el clúster. Para habilitar la gestión de claves de cliente para el cifrado en reposo, la configuración del clúster replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize debe ser M10 o superior y "backupEnabled" : false o quedar completamente omitida.

        Los valores son NONE, AWS, AZURE o GCP.

        Cifrado en reposo mediante Custo...
      • Compatibilidad de funcionalidades entre versiones string

        Compatibilidad de características entre versiones del clúster.

      • featureCompatibilityVersionExpirationDate string(date-time)

        Fecha de expiración de la compatibilidad de características entre versiones. Este parámetro expresa su valor en el formato de timestamp ISO 8601 en UTC.

      • globalClusterSelfManagedSharding booleano

        Configure este campo para configurar el modo de administración de fragmentación al crear un nuevo clúster global.

        Cuando está configurado en falso, el modo de gestión se establece en Atlas-Gestionado Particionado. Este modo gestiona completamente el particionado de su clúster global y está diseñado para proporcionar una experiencia de implementación sin interrupciones.

        Cuando se configura como true, el modo de gestión se establece en particionado autogestionado. Este modo deja la gestión de particiones en tus manos y está construido para proporcionar una experiencia de implementación avanzada y flexible.

        Esta configuración no se puede cambiar una vez implementado el clúster.

        Crear un clúster global
      • ID del grupo string

        Cadena de caracteres hexadecimales 24única que identifica el proyecto.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • ID string

        string única de 24dígitos hexadecimales que identifica el clúster.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • etiquetas arreglo[objeto] Obsoleto

        Colección de pares clave-valor, entre 1 y 255 caracteres de longitud, que etiquetan y categorizan el clúster. La consola de MongoDB nube no muestra tus etiquetas.

        Las etiquetas de clúster están obsoletas y se eliminarán en una futura actualización. Recomendamos encarecidamente que utilices etiquetas de recursos en su lugar.

        Resource Tags
        Ocultar los atributos de las etiquetas Mostrar atributos de las etiquetas Objeto

        Etiquetas legibles para humanos aplicadas a este componente de MongoDB Cloud.

        • llave string

          Clave aplicada para etiquetar y categorizar este componente.

          La longitud mínima es de 1, la longitud máxima es de 255.

        • Valor string

          Valor establecido a la Llave aplicada para etiquetar y categorizar este componente.

          La longitud mínima es de 1, la longitud máxima es de 255.

      • enlaces arreglo[objeto]

        Lista de uno o más uniform resource locators (URL) que apuntan a subrecursos de API, recursos API relacionados o ambos. RFC 5988 describe estas relaciones.

        Especificación de vinculación web (RFC...
        Ocultar atributos de enlaces Mostrar los atributos de los enlaces Objeto
        • href string

          Localizador uniforme de recursos (URL) que señala otro recurso de la API con el que esta respuesta guarda relación. Esta URL suele comenzar con https://cloud.mongodb.com/api/atlas.

        • rel string

          Localizador Uniforme de Recursos (URL) que define la relación semántica entre este recurso y otro recurso de la API. Esta URL suele comenzar con https://cloud.mongodb.com/api/atlas.

      • Acceso de empleado mongoDBEmployeeAccessGrant Objeto

        Empleado de MongoDB concedió el nivel de acceso y la expiración para un clúster.

        Ocultar atributos de mongoDBEmployeeAccessGrant Mostrar los atributos de mongoDBEmployeeAccessGrant Objeto
        • expirationTime string(date-time) Requerido

          Fecha de vencimiento para la concesión de acceso del empleado. Este parámetro expresa su valor en el formato de timestamp ISO 8601 en UTC.

        • grantType string Requerido

          Nivel de acceso que se concede a los Empleados de MongoDB.

          Los valores son CLUSTER_DATABASE_LOGS, CLUSTER_INFRASTRUCTURE o CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA.

        • enlaces arreglo[objeto]

          Lista de uno o más uniform resource locators (URL) que apuntan a subrecursos de API, recursos API relacionados o ambos. RFC 5988 describe estas relaciones.

          Especificación de vinculación web (RFC...
          Ocultar atributos de enlaces Mostrar los atributos de los enlaces Objeto
          • href string

            Localizador uniforme de recursos (URL) que señala otro recurso de la API con el que esta respuesta guarda relación. Esta URL suele comenzar con https://cloud.mongodb.com/api/atlas.

          • rel string

            Localizador Uniforme de Recursos (URL) que define la relación semántica entre este recurso y otro recurso de la API. Esta URL suele comenzar con https://cloud.mongodb.com/api/atlas.

      • mongoDBMajorVersion string

        Versión principal del clúster MongoDB.

        Al crear: Elige entre las versiones disponibles de MongoDB o deja el campo sin especificar para usar la versión por defecto en la plataforma MongoDB Nube. La versión recomendada es una versión reciente de soporte a largo plazo. No se garantiza que la versión por defecto sea la más recientemente publicada durante todo el ciclo de lanzamiento. Para obtener información sobre las versiones disponibles en un proyecto específico, consulta la documentación vinculada o utiliza el endpoint de la API para el endpoint de versiones LTS del proyecto.

        Al actualizar: aumente la versión solo en 1 versión principal a la vez. Si el clúster está fijado a una versión de compatibilidad de características entre versiones de MongoDB exactamente una versión principal por debajo de la versión actual de MongoDB, la versión de MongoDB se puede degradar a la versión principal anterior.

        Versiones de MongoDB disponibles en...
      • Versión de MongoDB string

        Versión de MongoDB que ejecuta el clúster.

        El formato debe coincidir con el siguiente patrón: ([\d]+\.[\d]+\.[\d]+).

      • mongoURI string

        Cadena de conexión base que puedes usar para conectarte al clúster. MongoDB Cloud muestra el string sólo después de que el clúster se inicia, no mientras se construye el clúster.

        Formato URI de la cadena de conexión.
      • mongoURIUpdated string(date-time)

        Fecha y hora en que alguien actualizó por última vez la cadena de conexión. MongoDB nube representa esta marca de tiempo en formato ISO 8601 en UTC.

      • mongoURIWithOptions string

        Cadena de conexión que puede usar para conectarse al clúster, incluyendo los parámetros de consulta replicaSet, ssl y authSource con valores adecuados para el clúster. Es posible que deba agregar usuarios de base de datos MongoDB. La respuesta devuelve este parámetro una vez que el clúster pueda recibir solicitudes, no mientras se está construyendo el clúster.

        Formato URI de la cadena de conexión.
      • Nombre string

        Etiqueta legible por humanos que identifica el clúster.

        El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

      • numShards integer(int32)

        Número de particiones de hasta 50 para implementar en un clúster. El recurso devuelve 1 para indicar un set de réplicas y valores de 2 o superiores para indicar un clúster. El valor devuelto es igual al número de particiones en el clúster.

        El valor mínimo es 1, el valor máximo es 50. El valor predeterminado es 1.

        particionado
      • en pausa booleano

        Indicador que señala si el clúster está pausado.

      • pitEnabled booleano

        Bandera que indica si el clúster utiliza copias de seguridad en la nube continuas.

        Copias de seguridad continuas en la nube
      • proveedorBackupEnabled booleano

        Bandera que indica si el clúster M10 o superior puede realizar copias de seguridad en la nube. Si se establece en true, el clúster puede realizar copias de seguridad. Si esta y backupEnabled están configuradas en false, el clúster no utiliza copias de seguridad de MongoDB Cloud.

      • Configuración del proveedor Objeto

        Uno de:
        Objeto de AWS AZURE objeto Objeto GCP ARRENDATARIO objeto Objeto FLEX
      • replicaSetScalingStrategy string

        Configure este campo para configurar el modo de escalamiento del conjunto de réplicas para su clúster.

        Por defecto, Atlas escala bajo WORKLOAD_TYPE. Este modo permite que Atlas escale tus nodos de análisis en paralelo a tus nodos operacionales.

        Cuando está configurado como SEQUENTIAL, Atlas escala todos los nodos secuencialmente. Este modo está destinado a cargas de trabajo en estado estable y aplicaciones que realizan lecturas secundarias que son sensibles a la latencia.

        Cuando se configura como NODE_TYPE, Atlas escala sus nodos elegibles en paralelo con sus nodos de solo lectura y de análisis. Este modo está diseñado para cargas de trabajo voluminosas y dinámicas que requieren un escalado frecuente y oportuno del nivel de clúster. Esta es la estrategia de escalado más rápida, pero podría impactar la latencia de las cargas de trabajo al realizar extensas lecturas secundarias.

        Los valores son SEQUENTIAL, WORKLOAD_TYPE o NODE_TYPE. El valor predeterminado es WORKLOAD_TYPE.

        Modificar el escalado del set de réplicas...
      • Factor de replicación integer(int32) Obsoleto

        Número de miembros que pertenecen al conjunto de réplicas. Cada miembro conserva una copia de sus bases de datos, lo que proporciona alta disponibilidad y redundancia de datos. Utilice replicationSpecs en su lugar.

        Los valores son 3, 5 o 7. El valor predeterminado es 3.

      • replicationSpec Objeto

        Ubicación física donde MongoDB nube aprovisiona nodos de clúster.

        Ocultar el atributo replicationSpec Mostrar el atributo replicationSpec Objeto
        • * Objeto Propiedades adicionales

          Ubicación física donde MongoDB nube aprovisiona nodos de clúster.

          Ocultar * atributos Mostrar * atributos Objeto
          • Nodos de análisis integer(int32)

            Número de nodos de análisis en la región. Los nodos de análisis gestionan datos analíticos, como queries de reportes del Connector de MongoDB para Business Intelligence en MongoDB nube. Los nodos de análisis son de solo lectura y nunca pueden convertirse en el primario. Utilice replicationSpecs[n].{region}.analyticsNodes en su lugar.

          • electableNodes integer(int32)

            Número de nodos elegibles que se deben implementar en la región especificada. Los nodos elegibles pueden convertirse en el nodo primario y facilitar lecturas locales. Utiliza replicationSpecs[n].{region}.electableNodes en su lugar.

            Los valores son 0, 3, 5 o 7.

          • prioridad integer(int32)

            Número que indica la prioridad de elección de la región. Para identificar la región preferida del clúster, configure este parámetro 7 como. El nodo principal se ejecuta en la región preferida. Para identificar una región de solo lectura, configure este parámetro 0 como.

            El valor mínimo es 0, el valor máximo es 7.

          • Nodos de solo lectura integer(int32)

            Número de nodos de sólo lectura en la región. Los nodos de solo lectura nunca pueden convertirse en el miembro principal, pero pueden facilitar las lecturas locales. Utiliza replicationSpecs[n].{region}.readOnlyNodes en su lugar.

      • replicationSpecs arreglo[objeto]

        Lista de configuraciones que configuran las regiones de su clúster.

        • Para los clústeres globales, cada objeto en el arreglo representa una zona en la que MongoDB Cloud implementa los nodos de tus clústeres.
        • Para clústeres shard no globales y sets de réplicas, el único objeto representa dónde MongoDB Cloud implementa los nodos de tus clústeres.
        Ocultar los atributos de replicationSpecs Mostrar atributos de replicationSpecs Objeto
        • ID string

          Cadena de dígitos hexadecimales 24única que identifica el objeto de replicación para una zona en un clúster global.

          • Si incluyes zonas existentes en la solicitud, debes especificar este parámetro.

          • Si se agrega una nueva zona a un clúster global existente, se puede especificar este parámetro. La solicitud elimina cualquier zona existente en un clúster global que se excluya de la solicitud.

          El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

        • numShards integer(int32)

          Un número entero positivo que especifica el número de particiones que se implementarán en cada zona especificada. Si estableces este valor en 1 y clusterType es SHARDED, MongoDB nube implementa un clúster de una única partición. No cree un clúster particionado con una única partición para entornos de producción. Los clústeres de una sola partición no ofrecen los mismos beneficios que las configuraciones de múltiples particiones.

          Si estás actualizando un set de réplicas a un clúster shard, no puedes aumentar el número de shards en la misma solicitud de actualización. Debe esperar hasta que el clúster haya completado su actualización a particionado y haya reconectado todos los clientes de la aplicación al router MongoDB antes de agregar nuevas particiones. De lo contrario, tus datos podrían volverse inconsistentes una vez que MongoDB nube comience a distribuir datos entre particiones.

          El valor por defecto es 1.

        • regionsConfig Objeto

          Ubicación física donde MongoDB nube aprovisiona nodos de clúster.

          Ocultar el atributo regionsConfig Mostrar el atributo regionsConfig Objeto
          • * Objeto Propiedades adicionales

            Ubicación física donde MongoDB nube aprovisiona nodos de clúster.

            Ocultar * atributos Mostrar * atributos Objeto
            • Nodos de análisis integer(int32)

              Número de nodos de análisis en la región. Los nodos de análisis gestionan datos analíticos, como queries de reportes del Connector de MongoDB para Business Intelligence en MongoDB nube. Los nodos de análisis son de solo lectura y nunca pueden convertirse en el primario. Utilice replicationSpecs[n].{region}.analyticsNodes en su lugar.

            • electableNodes integer(int32)

              Número de nodos elegibles que se deben implementar en la región especificada. Los nodos elegibles pueden convertirse en el nodo primario y facilitar lecturas locales. Utiliza replicationSpecs[n].{region}.electableNodes en su lugar.

              Los valores son 0, 3, 5 o 7.

            • prioridad integer(int32)

              Número que indica la prioridad de elección de la región. Para identificar la región preferida del clúster, configure este parámetro 7 como. El nodo principal se ejecuta en la región preferida. Para identificar una región de solo lectura, configure este parámetro 0 como.

              El valor mínimo es 0, el valor máximo es 7.

            • Nodos de solo lectura integer(int32)

              Número de nodos de sólo lectura en la región. Los nodos de solo lectura nunca pueden convertirse en el miembro principal, pero pueden facilitar las lecturas locales. Utiliza replicationSpecs[n].{region}.readOnlyNodes en su lugar.

        • zoneName string

          Etiqueta legible que identifica la zona en un clúster global. Proporcione este valor solo si clusterType es GEOSHARDED.

      • tipo de certificado raíz string

        Autoridad de certificación raíz que utiliza el clúster MongoDB Atlas. MongoDB Cloud apoya al Grupo de Investigación de Seguridad en Internet.

        El valor es ISRGROOTX1. El valor por defecto es ISRGROOTX1.

      • srvAddress string

        Cadena de conexión que puedes utilizar para conectarte al clúster. El modificador +srv obliga a la conexión a usar Transport Layer Security (TLS). El parámetro mongoURI enumera opciones adicionales.

        Formato URI de la cadena de conexión.
      • stateName string

        Etiqueta legible por humanos que indica cualquier actividad actual que esté llevando a cabo el plano de control de Atlas en este clúster. Salvo en los estados de CREACIÓN y ELIMINACIÓN, los clústeres siempre deben estar disponibles y disponer de un nodo Primario, incluso cuando se encuentran en estados que indican actividad en curso.

        • IDLE: Atlas no está realizando ningún cambio en este clúster, y se puede asumir que todos los cambios solicitados a través de la interfaz de usuario o la API se han aplicado.
        • CREATING: Un clúster que se aprovisiona por primera vez retorna el estado CREANDO hasta que esté listo para recibir conexiones. Asegúrese de que la lista de acceso IP y los usuarios de la base de datos estén configurados antes de intentar conectarse.
        • UPDATING: Se está realizando un cambio solicitado a través de la Interfaz de Usuario, API, AutoScaling u otra actividad programada.
        • DELETING:El clúster está en proceso de eliminación y pronto se eliminará.
        • REPAIRING: Uno o más nodos del clúster están siendo devueltos al servicio por el plano de control de Atlas. Los demás nodos deben seguir prestando servicio con normalidad.

        Los valores son IDLE, CREATING, UPDATING, DELETING o REPAIRING.

      • Etiquetas arreglo[objeto]

        Lista que contiene pares clave-valor entre 1 y 255 caracteres de longitud para etiquetar y categorizar el clúster.

        Resource Tags
        Hide tags attributes Mostrar atributos de etiquetas Objeto

        Par clave-valor que etiqueta y categoriza una organización, proyecto o clúster de MongoDB Cloud. Por ejemplo, environment : production.

        • llave string Requerido

          Constante que define el conjunto de la etiqueta. Por ejemplo, environment en la etiqueta environment : production.

          La longitud mínima es de 1, la longitud máxima es de 255.

        • Valor string Requerido

          Variable que pertenece al conjunto de la etiqueta. Por ejemplo, production en la etiqueta environment : production .

          La longitud mínima es de 1, la longitud máxima es de 255.

      • terminationProtectionEnabled booleano

        Indicador que indica si la protección contra la terminación está habilitada en el clúster. Si se establece en true, MongoDB Cloud no eliminará el clúster. Si se establece en false, MongoDB Cloud eliminará el clúster.

        El valor por defecto es false.

      • versiónReleaseSystem string

        Método por el cual el clúster mantiene las versiones de MongoDB. Si el valor es CONTINUOUS, no debe especificar mongoDBMajorVersion.

        Los valores son LTS o CONTINUOUS. El valor por defecto es LTS.

    • recuento total integer(int32)

      Número total de documentos disponibles. MongoDB Cloud omite este valor si includeCount está configurado en false. El número total es una estimación y puede no ser exacto.

      El valor mínimo es 0.
  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
  • 500 aplicación/json

    Error interno del servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
GET /api/atlas/v1.0/groups/{groupId}/clusters 
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuestas (200) 
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "acceptDataRisksAndForceReplicaSetReconfig": "2026-05-04T09:42:00Z",
      "advancedConfiguration": {
        "customOpensslCipherConfigTls12": [
          "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
        ],
        "customOpensslCipherConfigTls13": [
          "TLS_AES_256_GCM_SHA384"
        ],
        "minimumEnabledTlsProtocol": "TLS1_0",
        "tlsCipherConfigMode": "CUSTOM"
      },
      "autoScaling": {
        "compute": {
          "enabled": false,
          "scaleDownEnabled": false
        },
        "diskGBEnabled": false
      },
      "backupEnabled": true,
      "biConnector": {
        "enabled": true,
        "readPreference": "PRIMARY"
      },
      "clusterType": "REPLICASET",
      "configServerManagementMode": "ATLAS_MANAGED",
      "configServerType": "DEDICATED",
      "connectionStrings": {
        "awsPrivateLink": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        },
        "awsPrivateLinkSrv": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        },
        "private": "string",
        "privateEndpoint": [
          {
            "connectionString": "string",
            "endpoints": [
              {
                "endpointId": "string",
                "providerName": "AWS",
                "region": "string"
              }
            ],
            "srvConnectionString": "string",
            "srvShardOptimizedConnectionString": "string",
            "type": "MONGOD"
          }
        ],
        "privateSrv": "string",
        "standard": "string",
        "standardSrv": "string"
      },
      "createDate": "2026-05-04T09:42:00Z",
      "deleteAfterCreationHours": 42,
      "deleteAfterDate": "2026-05-04T09:42:00Z",
      "diskSizeGB": 42.0,
      "diskWarmingMode": "FULLY_WARMED",
      "encryptionAtRestProvider": "NONE",
      "featureCompatibilityVersion": "string",
      "featureCompatibilityVersionExpirationDate": "2026-05-04T09:42:00Z",
      "globalClusterSelfManagedSharding": true,
      "groupId": "32b6e34b3d91647abb20e7b8",
      "id": "32b6e34b3d91647abb20e7b8",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "mongoDBEmployeeAccessGrant": {
        "expirationTime": "2026-05-04T09:42:00Z",
        "grantType": "CLUSTER_DATABASE_LOGS",
        "links": [
          {
            "href": "https://cloud.mongodb.com/api/atlas",
            "rel": "self"
          }
        ]
      },
      "mongoDBMajorVersion": "5.0",
      "mongoDBVersion": "5.0.25",
      "mongoURI": "string",
      "mongoURIUpdated": "2026-05-04T09:42:00Z",
      "mongoURIWithOptions": "string",
      "name": "string",
      "numShards": 1,
      "paused": true,
      "pitEnabled": true,
      "providerBackupEnabled": true,
      "providerSettings": {
        "providerName": "AWS",
        "autoScaling": {
          "compute": {
            "maxInstanceSize": "M10",
            "minInstanceSize": "M10"
          }
        },
        "diskIOPS": 42,
        "encryptEBSVolume": true,
        "instanceSizeName": "M10",
        "regionName": "US_GOV_WEST_1",
        "volumeType": "STANDARD"
      },
      "replicaSetScalingStrategy": "WORKLOAD_TYPE",
      "replicationFactor": 3,
      "replicationSpec": {
        "additionalProperty1": {
          "analyticsNodes": 42,
          "electableNodes": 0,
          "priority": 42,
          "readOnlyNodes": 42
        },
        "additionalProperty2": {
          "analyticsNodes": 42,
          "electableNodes": 0,
          "priority": 42,
          "readOnlyNodes": 42
        }
      },
      "replicationSpecs": [
        {
          "id": "32b6e34b3d91647abb20e7b8",
          "numShards": 1,
          "regionsConfig": {
            "additionalProperty1": {
              "analyticsNodes": 42,
              "electableNodes": 0,
              "priority": 42,
              "readOnlyNodes": 42
            },
            "additionalProperty2": {
              "analyticsNodes": 42,
              "electableNodes": 0,
              "priority": 42,
              "readOnlyNodes": 42
            }
          },
          "zoneName": "string"
        }
      ],
      "rootCertType": "ISRGROOTX1",
      "srvAddress": "string",
      "stateName": "IDLE",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "terminationProtectionEnabled": false,
      "versionReleaseSystem": "LTS"
    }
  ],
  "totalCount": 42
}
Ejemplos de respuestas (401) 
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403) 
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404) 
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Ejemplos de respuestas (500) 
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}