Devolver todos los clústeres en un proyecto

Obtener /api/atlas/v2/grupos/{ID de grupo}/clústeres
Cuentas de servicio Autorización de resumen

Devuelve los detalles de todos los clústeres en el proyecto específico al que tienes acceso. Los clústeres contienen un grupo de hosts que mantienen el mismo conjunto de datos. La respuesta incluye clústeres con particiones de tamaño asimétrico. Para usar este recurso, la cuenta de servicio que realiza la solicitud o la clave de API deben tener el rol de solo lectura del proyecto. Esta funcionalidad no está disponible para clústeres sin servidor.

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 2026 enero. Utilice el punto de conexión "Listar clústeres Flex" para clústeres Flex. Versiones obsoletas: v2-{202302-01} -, v2-{2023-01-01}

Lista de clústeres flexibles

Encabezados

  • Uso de campos de instancia efectivos booleano

    Controla cómo se devuelven los campos de especificación de hardware en la respuesta. Si se establece en "true", devuelve los valores originales especificados por el cliente y proporciona campos efectivos independientes que muestran los valores operativos actuales. Si se establece en "false" (valor predeterminado), los campos de especificación de hardware muestran directamente los valores operativos actuales. Se utiliza principalmente para la compatibilidad con el escalado automático.

    El valor predeterminado es false.

Parámetros de ruta

  • ID de grupo string Requerido

    Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /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 de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".

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

Parámetros de consulta

  • envolvente booleano

    Indicador que indica si la aplicación encapsula 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 solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

    El valor predeterminado es false.

  • incluirConteo booleano

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

    El valor predeterminado es true.

  • artículos por página entero

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

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

  • número de página 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.

  • bonita booleano

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

    El valor predeterminado es false.

    Impresión bonita
  • Incluir copias de seguridad eliminadas con retenidas booleano

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

    El valor predeterminado es false.

Respuestas

  • 200 application/vnd.atlas.2024-08-05+json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • enlaces matriz[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 enlaces web (RFC...
      Ocultar atributos de enlaces Mostrar atributos de enlaces Objeto
      • href string

        Localizador Uniforme de Recursos (URL) que apunta a otro recurso de la API con el que esta respuesta guarda alguna relación. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.

      • relación 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 empezar por https://cloud.mongodb.com/api/atlas.

    • resultados matriz[objeto]

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

      Ocultar atributos de resultados Mostrar atributos de resultados Objeto
      • aceptarRiesgosDeDatosYForzarReplicaConjuntoReconfigurar cadena(fecha-hora)

        Si es necesaria una reconfiguración para recuperar un nodo principal debido a una interrupción regional, envíe este campo junto con la reconfiguración de su topología para solicitar una nueva topología regional resistente a interrupciones. Las reconfiguraciones forzadas durante una interrupción de la mayoría de los nodos elegibles conllevan el riesgo de pérdida de datos si las escrituras replicadas (incluso las escrituras confirmadas mayoritariamente) no se han replicado en el nuevo nodo principal. La documentación de MongoDB Atlas contiene más información. Para continuar con una operación que conlleva ese riesgo, establezca acceptDataRisksAndForceReplicaSetReconfig en la fecha actual. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

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

        Grupo de configuraciones que configura un subconjunto de los detalles de configuración avanzada.

        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.

        • protocoloTls mínimo habilitado 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 usan 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...
        • Modo de configuración de cifrado tls 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.

      • copia de seguridad habilitada booleano

        Indicador que indica si el clúster puede realizar copias de seguridad. Si se establece true en, 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 false en, el clúster no utiliza copias de seguridad.

        El valor predeterminado es false.

        copias de seguridad en la nube
      • biConnector Objeto

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

        Conector MongoDB para empresas...
        Ocultar atributos de biConnector Mostrar atributos biConector Objeto
        • habilitado booleano

          Bandera que indica si MongoDB Connector for Business Intelligence está habilitado 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.

          Preferencias de lectura para BI Connector
      • tipo de clúster string

        Configuración de los nodos que componen el cluster.

        Los valores son REPLICASET, SHARDED o GEOSHARDED.

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

        Modo de administración del servidor de configuración para crear o actualizar un clúster fragmentado. Si se configura como ATLAS_MANAGED, Atlas puede cambiar automáticamente el tipo de servidor de configuración del clúster para optimizar el rendimiento y el ahorro. Si se configura 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 predeterminado es ATLAS_MANAGED.

        Configuración de clúster fragmentado de MongoDB
      • tipo de servidor de configuración string

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

        Los valores son DEDICATED o EMBEDDED.

        Configuración de clúster fragmentado de MongoDB
      • cadenas de conexión Objeto

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

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

          Cadenas de conexión privadas que reconocen puntos de conexión y que utilizan clústeres alojados en AWS con Amazon Web Services (AWS) PrivateLink. Cada clave identifica un punto de conexión de interfaz de Amazon Web Services (AWS). Cada valor identifica la cadena de conexión mongodb:// relacionada que se utiliza para conectarse a MongoDB Cloud a través del punto de conexión de interfaz que la clave nombra.

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

            Cadenas de conexión privadas que reconocen puntos de conexión y que utilizan clústeres alojados en AWS con Amazon Web Services (AWS) PrivateLink. Cada clave identifica un punto de conexión de interfaz de Amazon Web Services (AWS). Cada valor identifica la cadena de conexión mongodb:// relacionada que se utiliza para conectarse a MongoDB Cloud a través del punto de conexión de interfaz que la clave nombra.

            Conexión peering de red
        • awsPrivateLinkSrv Objeto

          Cadenas de conexión privadas que reconocen puntos de conexión y que utilizan clústeres alojados en AWS con Amazon Web Services (AWS) PrivateLink. Cada clave identifica un punto de conexión de interfaz de Amazon Web Services (AWS). Cada valor identifica la cadena de conexión mongodb:// relacionada que se utiliza para conectarse a Atlas a través del punto de conexión de interfaz que la clave nombra. Si el clúster utiliza una cadena de conexión optimizada, awsPrivateLinkSrv contiene dicha cadena. Si el clúster tiene la cadena de conexión no optimizada (heredada), awsPrivateLinkSrv contiene dicha cadena, incluso si también existe una cadena de conexión optimizada.

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

            Cadenas de conexión privadas que reconocen puntos de conexión y que utilizan clústeres alojados en AWS con Amazon Web Services (AWS) PrivateLink. Cada clave identifica un punto de conexión de interfaz de Amazon Web Services (AWS). Cada valor identifica la cadena de conexión mongodb:// relacionada que se utiliza para conectarse a Atlas a través del punto de conexión de interfaz que la clave nombra. Si el clúster utiliza una cadena de conexión optimizada, awsPrivateLinkSrv contiene dicha cadena. Si el clúster tiene la cadena de conexión no optimizada (heredada), awsPrivateLinkSrv contiene dicha cadena, incluso si también existe una cadena de conexión optimizada.

            Conexión peering de red
        • privada string

          Cadenas de conexión de interconexión de red para cada punto de conexión de la nube privada virtual (VPC) que haya configurado para conectarse a este clúster. Esta cadena de conexión utiliza el protocolo mongodb+srv://. El recurso devuelve este parámetro cuando se crea una conexión de interconexión de red con este clúster. Este protocolo indica a la aplicación que busque la lista de semillas de host en el Sistema de nombres de dominio (DNS). Esta lista se sincroniza con los nodos del clúster. Si la cadena de conexión utiliza este formato de Identificador Uniforme de Recursos (URI), no es necesario añadir la lista de semillas ni cambiar el URI si cambian los nodos. Utilice este formato de URI si su controlador lo admite. De lo contrario, utilice connectionStrings.private. Para los clústeres de Amazon Web Services (AWS), este recurso devuelve este parámetro solo si habilita el DNS personalizado.

          Conexión peering de red
        • Nodo privado matriz[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.

          Cadena de conexión que reconoce puntos finales privados y que puede utilizar para conectarse a este clúster a través de un punto final privado.

          Ocultar atributos de privateEndpoint Mostrar atributos de privateEndpoint Objeto
          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 matriz[objeto]

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

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

            Ocultar atributos de puntos finales Mostrar atributos de puntos finales Objeto
            • ID de punto final string

              Cadena única que utiliza el proveedor de la nube para identificar el punto final privado.

            • nombreProveedor string

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

              Los valores son AWS, AZURE o GCP.

            • región string

              Región donde se implementa el punto final privado.

          • cadena de conexión srv string

            Cadena de conexión que reconoce puntos finales privados y que utiliza el protocolo mongodb+srv:// para conectarse a MongoDB Cloud a través de un punto final privado. El protocolo mongodb+srv indica al controlador que consulte la lista de hosts de origen en el Sistema de Nombres de Dominio (DNS). Esta lista se sincroniza con los nodos de un clúster. Si la cadena de conexión utiliza este formato de Identificador Uniforme de Recursos (URI), no es necesario añadir la lista de hosts de origen ni cambiarlo si cambian los nodos. Utilice este formato de Identificador Uniforme de Recursos (URI) si su aplicación lo admite. Si no lo admite, utilice connectionStrings.privateEndpoint[n].connectionString.

          • Cadena de conexión optimizada de srvShard string

            Cadena de conexión privada compatible con endpoints, optimizada para clústeres fragmentados que utiliza el protocolo mongodb+srv:// para conectarse a MongoDB Cloud a través de un endpoint privado. Si la cadena de conexión utiliza este formato de Identificador Uniforme de Recursos (URI), no es necesario cambiarlo si cambian los nodos. Utilice este formato de Identificador Uniforme de Recursos (URI) si su aplicación y su clúster Atlas lo admiten. De no ser así, utilice y consulte la documentación de connectionStrings.privateEndpoint[n].srvConnectionString.

          • tipo string

            Tipo de proceso de MongoDB al que se conecta su aplicación. Use MONGOD para conjuntos de réplicas y MONGOS para clústeres fragmentados.

            Los valores son MONGOD o MONGOS.

        • privateSrv string

          Cadenas de conexión de interconexión de red para cada punto de conexión de la interfaz de la nube privada virtual (VPC) que haya configurado para conectarse a este clúster. Esta cadena de conexión utiliza el mongodb+srv:// protocolo. El recurso devuelve este parámetro cuando alguien crea una conexión de interconexión de red con este clúster. Este protocolo indica a la aplicación que busque la lista de orígenes de host en el Sistema de nombres de dominio (DNS). Esta lista se sincroniza con los nodos del clúster. Si la cadena de conexión utiliza este formato de Identificador Uniforme de Recursos (URI), no es necesario añadir la lista de orígenes ni cambiar el URI si cambian los nodos. Utilice este formato de URI si su controlador lo admite. De connectionStrings.private lo contrario, utilice. Para los clústeres de Amazon Web Services (AWS), este parámetro solo se devuelve si se habilita el DNS personalizado.

          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 cadena(fecha-hora)

        Fecha y hora en que MongoDB Cloud creó este clúster. Este parámetro expresa su valor en formato ISO 8601 en UTC.

      • diskWarmingMode string

        Selección del modo de calentamiento del disco.

        Los valores son FULLY_WARMED o VISIBLE_EARLIER. El valor predeterminado es FULLY_WARMED.

        Reducir el calentamiento del disco secundario...
      • Especificaciones de replicación efectivas matriz[objeto]

        Lista de configuraciones que representan el estado actual del clúster. Es de solo lectura y siempre se devuelve en la respuesta. Refleja la configuración actual del clúster, que puede diferir de replicationSpecs debido a cambios administrados por el sistema.

        Detalles que explican cómo MongoDB Cloud replica datos en la base de datos MongoDB especificada.

        Ocultar atributos effectiveReplicationSpecs Mostrar atributos effectiveReplicationSpecs Objeto
        • ID. string

          Cadena única de dígitos hexadecimales 24que identifica el objeto de replicación de un fragmento en un clúster. Si incluye configuraciones de replicación de fragmentos existentes en la solicitud, debe especificar este parámetro. Si añade un nuevo fragmento a un clúster existente, puede especificar este parámetro. La solicitud elimina cualquier fragmento existente en el clúster que excluya de la solicitud. Esto corresponde al ID de fragmento que se muestra en la interfaz de usuario.

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

        • configuraciones de región matriz[objeto]

          Especificaciones de hardware para los nodos definidos para una región determinada. Cada objeto regionConfigs debe ser único por región y proveedor de nube dentro de replicationSpec. Cada objeto regionConfigs describe la prioridad de la región en las elecciones, así como la cantidad y el tipo de nodos MongoDB que MongoDB Cloud implementa en ella. Cada objeto regionConfigs debe tener un objeto analyticsSpecs, electableSpecs o readOnlySpecs. Los clústeres de inquilinos solo requieren electableSpecs. Los clústeres dedicados pueden especificar cualquiera de estas especificaciones, pero deben tener al menos un objeto electableSpecs dentro de replicationSpec.

          Ejemplo:

          Si configura replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize : M30, configure replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize : M30 si tiene nodos seleccionables y replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize : M30 si tiene nodos de solo lectura.

          Uno de:
          Objeto de AWS AZURE objeto Objeto GCP objeto INQUILINO
        • zoneId string

          Cadena única de dígitos hexadecimales 24que identifica la zona en un clúster global. Este valor se puede usar para configurar las políticas de copia de seguridad del clúster global.

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

        • zoneName string

          Etiqueta legible que describe la zona a la que pertenece este fragmento en un clúster global. Proporcione este valor solo si clusterType : GEOSHARDED pero no selfManagedSharding : true.

      • proveedor de cifrado en reposo string

        Proveedor de servicios en la nube que administra las claves de cliente para proporcionar una capa adicional de cifrado en reposo para el clúster. Para habilitar la administració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 omitirse por completo.

        Los valores son NONE, AWS, AZURE o GCP.

        Cifrado en reposo usando Custo...
      • característicaCompatibilidadVersión string

        Versión de compatibilidad de funciones del clúster. Esto siempre aparecerá, independientemente de si FCV está fijado.

      • característicaCompatibilidadVersiónFecha de vencimiento cadena(fecha-hora)

        Fecha de vencimiento de la versión de compatibilidad de funciones. Solo aparecerá si FCV está fijado. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • Fragmentación autogestionada de clúster global booleano

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

        Cuando se establece en falso, el modo de administración se establece en Fragmentación administrada por Atlas. Este modo administra completamente la fragmentación de su clúster global y está diseñado para brindar una implementación fluida.

        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 de 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

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

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

      • internalClusterRole string

        Clasificación interna de la función del clúster. Valores posibles: NONE (clúster de usuarios habituales), SYSTEM_CLUSTER (clúster de sistema para copias de seguridad), INTERNAL_SHADOW_CLUSTER (clúster de sombra de uso interno para pruebas).

        Los valores son NONE, SYSTEM_CLUSTER o INTERNAL_SHADOW_CLUSTER.

      • Etiquetas matriz[objeto] Obsoleto

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

        Las etiquetas de clúster están obsoletas y se eliminarán en una próxima versión. Recomendamos encarecidamente usar etiquetas de recursos en su lugar.

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

        Resource Tags
        Ocultar atributos de etiquetas Mostrar atributos de etiquetas Objeto
        • clave string

          Clave aplicada para etiquetar y categorizar este componente.

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

        • valor string

          Valor establecido en la clave aplicada para etiquetar y categorizar este componente.

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

      • enlaces matriz[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 enlaces web (RFC...
        Ocultar atributos de enlaces Mostrar atributos de enlaces Objeto
        • href string

          Localizador Uniforme de Recursos (URL) que apunta a otro recurso de la API con el que esta respuesta guarda alguna relación. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.

        • relación 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 empezar por https://cloud.mongodb.com/api/atlas.

      • Concesión de acceso a empleados de MongoDB Objeto

        A un empleado de MongoDB se le otorgó nivel de acceso y vencimiento para un clúster.

        Ocultar atributos de mongoDBEmployeeAccessGrant Mostrar atributos de mongoDBEmployeeAccessGrant Objeto
        • tiempo de expiración cadena(fecha-hora) 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 a otorgar a los empleados de MongoDB.

          Los valores son CLUSTER_DATABASE_LOGS, CLUSTER_INFRASTRUCTURE o CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA.

        • enlaces matriz[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 enlaces web (RFC...
          Ocultar atributos de enlaces Mostrar atributos de enlaces Objeto
          • href string

            Localizador Uniforme de Recursos (URL) que apunta a otro recurso de la API con el que esta respuesta guarda alguna relación. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.

          • relación 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 empezar por https://cloud.mongodb.com/api/atlas.

      • Versión principal de mongoDB string

        Versión principal de MongoDB del clúster. Establecida en la versión principal binaria.

        Al crear: Elija entre las versiones disponibles de MongoDB o deje sin especificar la versión predeterminada recomendada en la plataforma MongoDB Cloud. La versión recomendada es una versión reciente con soporte a largo plazo. No se garantiza que la versión predeterminada sea la más reciente publicada durante todo el ciclo de lanzamiento. Para conocer las versiones disponibles en un proyecto específico, consulte la documentación vinculada o utilice el punto de enlace de la API para versiones LTS del proyecto.

        Al actualizar: Aumente la versión solo en 1 versiones principales a la vez. Si el clúster está anclado a una versión de compatibilidad de funciones de MongoDB exactamente una versión principal inferior a la versión actual de MongoDB, esta puede degradarse 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]+).

      • 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-]*$.

      • en pausa booleano

        Bandera que indica si el cluster está en pausa.

      • pitEnabled booleano

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

        Copias de seguridad continuas en la nube
      • redactClientLogData booleano

        Habilitar o deshabilitar la redacción de registros.

        Esta configuración configura mongod o mongos para eliminar el contenido de cualquier campo de documento de un mensaje que acompaña a un evento de registro antes de registrarlo. Esto evita que el programa escriba en el registro de diagnóstico datos potencialmente confidenciales almacenados en la base de datos. Los metadatos, como códigos de error o de operación, números de línea y nombres de archivos fuente, siguen visibles en los registros.

        Utilice redactClientLogData junto con Cifrado en reposo y TLS/SSL (Cifrado de transporte) para facilitar el cumplimiento de los requisitos reglamentarios.

        Nota: cambiar esta configuración en un clúster activará un reinicio continuo tan pronto como se actualice el clúster.

        Restricción de registro
      • Estrategia de escalamiento del conjunto de réplicas string

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

        De forma predeterminada, Atlas escala por debajo de WORKLOAD_TYPE. Este modo permite a Atlas escalar sus nodos de análisis en paralelo con sus nodos operativos.

        Cuando se configura como SEQUENTIAL, Atlas escala todos los nodos secuencialmente. Este modo está diseñado para cargas de trabajo estables y aplicaciones que realizan lecturas secundarias sensibles a la latencia.

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

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

        Modificar la escala del conjunto de réplicas...
      • Especificaciones de replicación matriz[objeto]

        Lista de ajustes que configuran las regiones del clúster. Esta matriz contiene un objeto por fragmento que representa las configuraciones de los nodos en cada fragmento. Para los conjuntos de réplicas, solo hay un objeto que representa las configuraciones de los nodos.

        Detalles que explican cómo MongoDB Cloud replica datos en la base de datos MongoDB especificada.

        Ocultar atributos de replicationSpecs Mostrar atributos de replicationSpecs Objeto
        • ID. string

          Cadena única de dígitos hexadecimales 24que identifica el objeto de replicación de un fragmento en un clúster. Si incluye configuraciones de replicación de fragmentos existentes en la solicitud, debe especificar este parámetro. Si añade un nuevo fragmento a un clúster existente, puede especificar este parámetro. La solicitud elimina cualquier fragmento existente en el clúster que excluya de la solicitud. Esto corresponde al ID de fragmento que se muestra en la interfaz de usuario.

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

        • configuraciones de región matriz[objeto]

          Especificaciones de hardware para los nodos definidos para una región determinada. Cada objeto regionConfigs debe ser único por región y proveedor de nube dentro de replicationSpec. Cada objeto regionConfigs describe la prioridad de la región en las elecciones, así como la cantidad y el tipo de nodos MongoDB que MongoDB Cloud implementa en ella. Cada objeto regionConfigs debe tener un objeto analyticsSpecs, electableSpecs o readOnlySpecs. Los clústeres de inquilinos solo requieren electableSpecs. Los clústeres dedicados pueden especificar cualquiera de estas especificaciones, pero deben tener al menos un objeto electableSpecs dentro de replicationSpec.

          Ejemplo:

          Si configura replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize : M30, configure replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize : M30 si tiene nodos seleccionables y replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize : M30 si tiene nodos de solo lectura.

          Uno de:
          Objeto de AWS AZURE objeto Objeto GCP objeto INQUILINO
        • zoneId string

          Cadena única de dígitos hexadecimales 24que identifica la zona en un clúster global. Este valor se puede usar para configurar las políticas de copia de seguridad del clúster global.

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

        • zoneName string

          Etiqueta legible que describe la zona a la que pertenece este fragmento en un clúster global. Proporcione este valor solo si clusterType : GEOSHARDED pero no selfManagedSharding : true.

      • retener copias de seguridad booleano

        Bandera que indica si el clúster conserva copias de seguridad.

        El valor predeterminado es false.

      • 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 predeterminado es ISRGROOTX1.

      • nombre del estado string

        Etiqueta legible que indica cualquier actividad actual que el plano de control de Atlas esté realizando en este clúster. Con excepción de los estados CREANDO y ELIMINANDO, los clústeres siempre deben estar disponibles y tener un nodo principal, incluso en estados que indiquen actividad continua.

        • IDLEAtlas no está realizando cambios en este clúster y se puede asumir que se han aplicado todos los cambios solicitados a través de la interfaz de usuario o la API.
        • CREATINGUn clúster que se aprovisiona por primera vez devuelve el estado CREANDO hasta que esté listo para las conexiones. Asegúrese de que la lista de acceso IP y los usuarios de la base de datos estén configurados antes de intentar la conexión.
        • 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á.
        • REPAIRINGEl plano de control de Atlas está volviendo a poner en servicio uno o más nodos del clúster. Los demás nodos deberían seguir prestando servicio con normalidad.

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

      • Etiquetas matriz[objeto]

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

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

        Resource Tags
        Hide tags attributes Mostrar atributos de etiquetas Objeto
        • clave string Requerido

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

          La longitud mínima es 1, la longitud máxima es 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 1, la longitud máxima es 255.

      • TerminaciónProtecciónHabilitada 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 predeterminado es false.

      • usarAwsTimeBasedSnapshotCopyParaSincronizaciónInicialRápida booleano

        Marca que indica si se usarán copias de instantáneas basadas en tiempo de AWS en lugar de copias de instantáneas estándar más lentas durante las sincronizaciones iniciales rápidas entre regiones de Atlas. Esta marca solo es relevante para clústeres que contienen nodos de AWS.

        El valor predeterminado es false.

      • versiónReleaseSystem string

        Método mediante 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 predeterminado es LTS.

    • recuento total integer(int32)

      Número total de documentos disponibles. MongoDB Cloud omite este valor si includeCount se establece 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 incorrecto.

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

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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 matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.
  • 403 aplicación/json

    Forbidden.

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

      Detalle de solicitud incorrecto.

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

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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 matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación 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 incorrecto.

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

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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 matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación 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 incorrecto.

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

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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 matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.
OBTENER /api/atlas/v2/grupos/{groupId}/clústeres 
atlas api clusters listClusters --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250219001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListGroupClustersApiParams{}
	sdkResp, httpResp, err := client.ClustersApi.
		ListGroupClustersWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true"
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"
      },
      "backupEnabled": false,
      "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",
      "diskWarmingMode": "FULLY_WARMED",
      "effectiveReplicationSpecs": [
        {
          "id": "32b6e34b3d91647abb20e7b8",
          "regionConfigs": [
            {
              "electableSpecs": {
                "diskSizeGB": 42.0,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10",
                "nodeCount": 42
              },
              "priority": 42,
              "providerName": "AWS",
              "regionName": "US_GOV_WEST_1",
              "analyticsAutoScaling": {
                "compute": {
                  "enabled": true,
                  "maxInstanceSize": "M10",
                  "minInstanceSize": "M10",
                  "scaleDownEnabled": true
                },
                "diskGB": {
                  "enabled": true
                }
              },
              "analyticsSpecs": {
                "diskSizeGB": 42.0,
                "nodeCount": 42,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10"
              },
              "autoScaling": {
                "compute": {
                  "enabled": true,
                  "maxInstanceSize": "M10",
                  "minInstanceSize": "M10",
                  "scaleDownEnabled": true
                },
                "diskGB": {
                  "enabled": true
                }
              },
              "effectiveAnalyticsSpecs": {
                "diskSizeGB": 42.0,
                "nodeCount": 42,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10"
              },
              "effectiveElectableSpecs": {
                "diskSizeGB": 42.0,
                "nodeCount": 42,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10"
              },
              "effectiveReadOnlySpecs": {
                "diskSizeGB": 42.0,
                "nodeCount": 42,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10"
              },
              "readOnlySpecs": {
                "diskSizeGB": 42.0,
                "nodeCount": 42,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10"
              }
            }
          ],
          "zoneId": "32b6e34b3d91647abb20e7b8",
          "zoneName": "string"
        }
      ],
      "encryptionAtRestProvider": "NONE",
      "featureCompatibilityVersion": "string",
      "featureCompatibilityVersionExpirationDate": "2026-05-04T09:42:00Z",
      "globalClusterSelfManagedSharding": true,
      "groupId": "32b6e34b3d91647abb20e7b8",
      "id": "32b6e34b3d91647abb20e7b8",
      "internalClusterRole": "NONE",
      "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": "string",
      "mongoDBVersion": "string",
      "name": "string",
      "paused": true,
      "pitEnabled": true,
      "redactClientLogData": true,
      "replicaSetScalingStrategy": "WORKLOAD_TYPE",
      "replicationSpecs": [
        {
          "id": "32b6e34b3d91647abb20e7b8",
          "regionConfigs": [
            {
              "electableSpecs": {
                "diskSizeGB": 42.0,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10",
                "nodeCount": 42
              },
              "priority": 42,
              "providerName": "AWS",
              "regionName": "US_GOV_WEST_1",
              "analyticsAutoScaling": {
                "compute": {
                  "enabled": true,
                  "maxInstanceSize": "M10",
                  "minInstanceSize": "M10",
                  "scaleDownEnabled": true
                },
                "diskGB": {
                  "enabled": true
                }
              },
              "analyticsSpecs": {
                "diskSizeGB": 42.0,
                "nodeCount": 42,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10"
              },
              "autoScaling": {
                "compute": {
                  "enabled": true,
                  "maxInstanceSize": "M10",
                  "minInstanceSize": "M10",
                  "scaleDownEnabled": true
                },
                "diskGB": {
                  "enabled": true
                }
              },
              "effectiveAnalyticsSpecs": {
                "diskSizeGB": 42.0,
                "nodeCount": 42,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10"
              },
              "effectiveElectableSpecs": {
                "diskSizeGB": 42.0,
                "nodeCount": 42,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10"
              },
              "effectiveReadOnlySpecs": {
                "diskSizeGB": 42.0,
                "nodeCount": 42,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10"
              },
              "readOnlySpecs": {
                "diskSizeGB": 42.0,
                "nodeCount": 42,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10"
              }
            }
          ],
          "zoneId": "32b6e34b3d91647abb20e7b8",
          "zoneName": "string"
        }
      ],
      "retainBackups": false,
      "rootCertType": "ISRGROOTX1",
      "stateName": "IDLE",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "terminationProtectionEnabled": false,
      "useAwsTimeBasedSnapshotCopyForFastInitialSync": 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"
}