Actualiza un clúster de nivel compartido a un clúster flexible o dedicado (M10+) en el proyecto especificado. Para usar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de administrador de clúster de proyecto. Cada proyecto admite hasta 25 clústeres.
Este punto de conexión también se puede usar para actualizar clústeres Flex creados con la API Crear Clúster o clústeres M 2/M anteriores5 que se hayan migrado a clústeres Flex, usando instanceSizeName a "M2 " o "M "5 hasta 2026 el de enero. Esta funcionalidad estará disponible hasta el de enero 22 2026del, fecha a partir de la cual solo estará disponible para0 clústeres M. Utilice el punto de conexión Actualizar Clúster Flex en su lugar.
Parámetros de ruta
-
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
-
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. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita
Cuerpo
Requerido
Detalles de la actualización del clúster de nivel compartido en el proyecto especificado.
-
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
acceptDataRisksAndForceReplicaSetReconfigen 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... -
Grupo de configuraciones que configura un subconjunto de los detalles de configuración avanzada.
-
Rango de tamaños de instancias a los que puede escalar su clúster.
Escalado automático de clúster -
Indicador que indica si el clúster puede realizar copias de seguridad. Si se establece en
true, el clúster puede realizar copias de seguridad. Debe establecer este valor entruepara 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 enfalse, el clúster no utiliza copias de seguridad en MongoDB Cloud. -
Configuraciones necesarias para configurar el MongoDB Connector for Business Intelligence para este clúster.
Conector MongoDB para empresas... -
Configuración de los nodos que componen el cluster.
Los valores son
REPLICASET,SHARDEDoGEOSHARDED. -
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 comoFIXED_TO_DEDICATED, el clúster siempre usará un servidor de configuración dedicado.Los valores son
ATLAS_MANAGEDoFIXED_TO_DEDICATED. El valor predeterminado esATLAS_MANAGED.Configuración de clúster fragmentado de MongoDB -
Número de horas después de la creación del clúster en que este se eliminará automáticamente.
Este campo se utiliza para derivar
deleteAfterDateen relación concreateDate.Cuando se establece en nulo o cero al crear el clúster, el clúster no se eliminará automáticamente.
Cuando se establece en un valor positivo al crear el clúster, el clúster se eliminará automáticamente después de la cantidad de horas especificada.
Al actualizar este campo en un clúster existente (no eliminado), y este se establece como nulo, se conservan los valores existentes para este y
deleteAfterDate.Al actualizar este campo en un clúster existente (no eliminado), y se establece en cero, entonces
deleteAfterDatese restablece a nulo (deshabilita la eliminación automática) independientemente de las configuraciones anteriores.Al actualizar este campo en un clúster existente (no eliminado), y este se establece en un valor positivo, entonces
createDate+deleteAfterCreationHoursdebe ser posterior a ahora; de lo contrario, se ignora la actualización del campo y se conservan los valores existentes para este ydeleteAfterDate. -
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 especifica un tamaño de disco inferior al mínimo (10 GB), este parámetro toma como valor predeterminado el tamaño de disco mínimo.
Los cálculos de cargos de almacenamiento dependen de si elige el valor predeterminado o un valor personalizado.
El valor máximo de almacenamiento en disco no puede superar 50 veces la RAM máxima del clúster seleccionado. Si necesita más espacio de almacenamiento, considere actualizar su clúster a un nivel superior.
El valor mínimo es
10, el valor máximo es4096. -
Selección del modo de calentamiento del disco.
Los valores son
FULLY_WARMEDoVISIBLE_EARLIER. El valor predeterminado esFULLY_WARMED.Reducir el calentamiento del disco secundario... -
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.instanceSizedebe serM10o superior y"backupEnabled" : falseomitirse por completo.Los valores son
NONE,AWS,AZUREoGCP.Cifrado en reposo usando Custo... -
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 -
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 -
A un empleado de MongoDB se le otorgó nivel de acceso y vencimiento para un clúster.
-
Versión principal del clúster MongoDB.
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 que ejecuta el clúster.
El formato debe coincidir con el siguiente patrón:
([\d]+\.[\d]+\.[\d]+). -
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-]*$. -
Número máximo de fragmentos para implementar en un clúster fragmentado: 50. El recurso devuelve
1para indicar un conjunto de réplicas y valores de2o superiores para indicar un clúster fragmentado. El valor devuelto equivale al número de fragmentos del clúster.El valor mínimo es
1, el valor máximo es50. El valor predeterminado es1.particionado -
Bandera que indica si el cluster está en pausa.
-
Bandera que indica si el clúster utiliza copias de seguridad en la nube continuas.
Copias de seguridad continuas en la nube -
Indicador que indica si el clúster M10 o superior puede realizar copias de seguridad en la nube. Si se establece en
true, el clúster puede realizar copias de seguridad. Si este valor ybackupEnabledse establecen enfalse, el clúster no utiliza copias de seguridad en la nube de MongoDB. -
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_TYPEoNODE_TYPE. El valor predeterminado esWORKLOAD_TYPE.Modificar la escala del conjunto de réplicas... -
Número de miembros que pertenecen al conjunto de réplicas. Cada miembro conserva una copia de sus bases de datos, lo que proporciona alta disponibilidad y redundancia de datos. Utilice
replicationSpecsen su lugar.Los valores son
3,5o7. El valor predeterminado es3. -
Ubicación física donde MongoDB Cloud aprovisiona los nodos del clúster.
-
Lista de configuraciones que configuran las regiones de su clúster.
- Para los clústeres globales, cada objeto de la matriz representa una zona donde MongoDB Cloud implementa los nodos de sus clústeres.
- Para clústeres fragmentados no globales y conjuntos de réplicas, el objeto único representa dónde MongoDB Cloud implementa los nodos de sus clústeres.
-
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 esISRGROOTX1. -
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 enfalse, MongoDB Cloud eliminará el clúster.El valor predeterminado es
false. -
Método mediante el cual el clúster mantiene las versiones de MongoDB. Si el valor es
CONTINUOUS, no debe especificarmongoDBMajorVersion.Los valores son
LTSoCONTINUOUS. El valor predeterminado esLTS.
atlas api clusters upgradeTenantUpgrade --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.UpgradeGroupClusterTenantUpgradeApiParams{}
sdkResp, httpResp, err := client.ClustersApi.
UpgradeGroupClusterTenantUpgradeWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-02-19+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \
-d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-02-19+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \
-d '{ <Payload> }'
{
"acceptDataRisksAndForceReplicaSetReconfig": "2026-05-04T09:42:00Z",
"advancedConfiguration": {
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"customOpensslCipherConfigTls13": [
"TLS_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"autoScaling": {
"compute": {
"enabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {
"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"deleteAfterCreationHours": 42,
"diskSizeGB": 42.0,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"globalClusterSelfManagedSharding": true,
"labels": [
{
"key": "string",
"value": "string"
}
],
"mongoDBEmployeeAccessGrant": {
"expirationTime": "2026-05-04T09:42:00Z",
"grantType": "CLUSTER_DATABASE_LOGS"
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {
"providerName": "AWS",
"autoScaling": {
"compute": {
"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 42,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "WORKLOAD_TYPE",
"replicationFactor": 3,
"replicationSpec": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"replicationSpecs": [
{
"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"tags": [
{
"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}
{
"acceptDataRisksAndForceReplicaSetReconfig": "2026-05-04T09:42:00Z",
"advancedConfiguration": {
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"customOpensslCipherConfigTls13": [
"TLS_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"autoScaling": {
"compute": {
"enabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {
"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {
"awsPrivateLink": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"awsPrivateLinkSrv": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"private": "string",
"privateEndpoint": [
{
"connectionString": "string",
"endpoints": [
{
"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2026-05-04T09:42:00Z",
"deleteAfterCreationHours": 42,
"deleteAfterDate": "2026-05-04T09:42:00Z",
"diskSizeGB": 42.0,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2026-05-04T09:42:00Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [
{
"key": "string",
"value": "string"
}
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {
"expirationTime": "2026-05-04T09:42:00Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"mongoURI": "string",
"mongoURIUpdated": "2026-05-04T09:42:00Z",
"mongoURIWithOptions": "string",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {
"providerName": "AWS",
"autoScaling": {
"compute": {
"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 42,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "WORKLOAD_TYPE",
"replicationFactor": 3,
"replicationSpec": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"replicationSpecs": [
{
"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"srvAddress": "string",
"stateName": "IDLE",
"tags": [
{
"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}
{
"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"
}
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
{
"error": 402,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Payment Required",
"errorCode": "NO_PAYMENT_INFORMATION_FOUND"
}
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
{
"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"
}
{
"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"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}