Actualizar un clúster en un proyecto

PATCH /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName}
Cuentas de servicio Autorización de resumen

Actualiza los detalles de un clúster en el proyecto especificado. Los clústeres contienen un grupo de hosts que mantienen el mismo conjunto de datos. Este recurso puede actualizar clústeres multinube. Para actualizar la protección contra la terminación de un clúster, la cuenta de servicio o la clave de API solicitantes deben tener el rol de propietario del proyecto. Para todas las demás actualizaciones, la cuenta de servicio o la clave de API solicitantes deben tener el rol de administrador del clúster del proyecto. No se puede modificar un clúster en pausa (paused : true). Debe llamar a este punto de conexión para configurar paused : false. Después de que este punto de conexión responda con paused : false, puede volver a llamarlo con los cambios que desee realizar en el clúster. Esta función no está disponible para clústeres sin servidor.

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})$.

  • Nombre del clúster string Requerido

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

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.

  • 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
aplicación/json

Cuerpo Requerido

Clúster a actualizar en el proyecto especificado.

  • 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.

  • copia de seguridad habilitada booleano

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

    El valor por defecto es false.

  • 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...
  • 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.

    Personalizar el almacenamiento
  • 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...
  • 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
  • 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.

  • 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...
  • Nombre string

    Etiqueta legible por humanos que identifica el clúster avanzado.

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

  • 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
  • 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...
  • replicationSpecs arreglo[objeto]

    Lista de ajustes que configuran las regiones del clúster. Para Clústeres globales, cada objeto en el arreglo representa una zona donde se implementan los nodos de clústeres. Para conjuntos de réplicas y clústeres fragmentados que no son globales, este arreglo contiene un objeto que representa la ubicación de los nodos de tu clúster implementan.

    Ocultar los atributos de replicationSpecs Mostrar atributos de replicationSpecs Objeto

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

    • numShards integer(int32)

      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 shardizado de una sola partición. No cree un clúster particionado con una sola 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 mínimo es 1.

    • regionConfigs arreglo[objeto]

      Especificaciones de hardware para 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. Todas las especificaciones de hardware deben usar el mismo objeto instanceSize.

      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 ARRENDATARIO objeto
    • zoneName string

      Etiqueta legible por humanos que identifica la zona en un Clúster Global. Proporcione este valor solo si "clusterType" : "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.

  • 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.

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • 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.

    • copia de seguridad habilitada booleano

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

      El valor por defecto es false.

    • 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 Nube creó este clúster. Este parámetro expresa su valor en el formato ISO 8601 en UTC.

    • 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.

      Personalizar el almacenamiento
    • 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]+).

    • Nombre string

      Etiqueta legible por humanos que identifica el clúster avanzado.

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

    • 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
    • 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...
    • replicationSpecs arreglo[objeto]

      Lista de ajustes que configuran las regiones del clúster. Para Clústeres globales, cada objeto en el arreglo representa una zona donde se implementan los nodos de clústeres. Para conjuntos de réplicas y clústeres fragmentados que no son globales, este arreglo contiene un objeto que representa la ubicación de los nodos de tu clúster implementan.

      Ocultar los atributos de replicationSpecs Mostrar atributos de replicationSpecs Objeto

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

      • ID string

        Cadena única de dígitos hexadecimales 24que identifica el objeto de replicación de una zona en un clúster multinube. Si incluye zonas existentes en la solicitud, debe especificar este parámetro. Si añade una nueva zona a un clúster multinube existente, puede especificar este parámetro. La solicitud elimina cualquier zona existente en el clúster multinube que excluya de la solicitud.

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

      • numShards integer(int32)

        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 shardizado de una sola partición. No cree un clúster particionado con una sola 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 mínimo es 1.

      • regionConfigs arreglo[objeto]

        Especificaciones de hardware para 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. Todas las especificaciones de hardware deben usar el mismo objeto instanceSize.

        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 ARRENDATARIO objeto
      • zoneId string

        Unique 24-hexadecimal digit string that identifies a zona in a Clúster Global.

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

      • zoneName string

        Etiqueta legible por humanos que identifica la zona en un Clúster Global. Proporcione este valor solo si "clusterType" : "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.

    • 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.
  • 400 aplicación/json

    Solicitud incorrecta.

    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.
  • 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.
  • 409 aplicación/json

    Conflicto.

    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.
PARCHE /api/atlas/v1.5/grupos/{ID de grupo}/clústeres/{nombre del clúster} 
curl \
 --request PATCH 'https://cloud.mongodb.com/api/atlas/v1.5/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"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","diskSizeGB":42.0,"diskWarmingMode":"FULLY_WARMED","encryptionAtRestProvider":"NONE","globalClusterSelfManagedSharding":true,"labels":[{"key":"string","value":"string"}],"mongoDBMajorVersion":"string","name":"string","paused":true,"pitEnabled":true,"replicaSetScalingStrategy":"WORKLOAD_TYPE","replicationSpecs":[{"numShards":42,"regionConfigs":[{"electableSpecs":{"diskIOPS":42,"ebsVolumeType":"STANDARD","instanceSize":"M10","nodeCount":42},"priority":42,"providerName":"AWS","regionName":"US_GOV_WEST_1","analyticsAutoScaling":{"compute":{"enabled":true,"scaleDownEnabled":true},"diskGB":{"enabled":true}},"analyticsSpecs":{"nodeCount":42,"diskIOPS":42,"ebsVolumeType":"STANDARD","instanceSize":"M10"},"autoScaling":{"compute":{"enabled":true,"scaleDownEnabled":true},"diskGB":{"enabled":true}},"readOnlySpecs":{"nodeCount":42,"diskIOPS":42,"ebsVolumeType":"STANDARD","instanceSize":"M10"}}],"zoneName":"string"}],"rootCertType":"ISRGROOTX1","tags":[{"key":"string","value":"string"}],"terminationProtectionEnabled":false,"versionReleaseSystem":"LTS"}'
Solicitar ejemplos 
{
  "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",
  "diskSizeGB": 42.0,
  "diskWarmingMode": "FULLY_WARMED",
  "encryptionAtRestProvider": "NONE",
  "globalClusterSelfManagedSharding": true,
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "mongoDBMajorVersion": "string",
  "name": "string",
  "paused": true,
  "pitEnabled": true,
  "replicaSetScalingStrategy": "WORKLOAD_TYPE",
  "replicationSpecs": [
    {
      "numShards": 42,
      "regionConfigs": [
        {
          "electableSpecs": {
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10",
            "nodeCount": 42
          },
          "priority": 42,
          "providerName": "AWS",
          "regionName": "US_GOV_WEST_1",
          "analyticsAutoScaling": {
            "compute": {
              "enabled": true,
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "analyticsSpecs": {
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          },
          "autoScaling": {
            "compute": {
              "enabled": true,
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "readOnlySpecs": {
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          }
        }
      ],
      "zoneName": "string"
    }
  ],
  "rootCertType": "ISRGROOTX1",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "terminationProtectionEnabled": false,
  "versionReleaseSystem": "LTS"
}
Ejemplos de respuestas (200) 
{
  "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",
  "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": "string",
  "mongoDBVersion": "string",
  "name": "string",
  "paused": true,
  "pitEnabled": true,
  "replicaSetScalingStrategy": "WORKLOAD_TYPE",
  "replicationSpecs": [
    {
      "id": "32b6e34b3d91647abb20e7b8",
      "numShards": 42,
      "regionConfigs": [
        {
          "electableSpecs": {
            "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": {
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          },
          "autoScaling": {
            "compute": {
              "enabled": true,
              "maxInstanceSize": "M10",
              "minInstanceSize": "M10",
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "readOnlySpecs": {
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          }
        }
      ],
      "zoneId": "32b6e34b3d91647abb20e7b8",
      "zoneName": "string"
    }
  ],
  "rootCertType": "ISRGROOTX1",
  "stateName": "IDLE",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "terminationProtectionEnabled": false,
  "versionReleaseSystem": "LTS"
}
Ejemplos de respuestas (400) 
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
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 (409) 
{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
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"
}