/ /

/ /

atlas api clusters updateCluster

Actualiza los detalles de un clúster en el proyecto especificado.

El subcomando atlas api se genera automáticamente desde la API de administración de MongoDB Atlas y ofrece cobertura completa de dicha API. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.

Los clústeres contienen un grupo de hosts que mantienen el mismo conjunto de datos. Este recurso puede actualizar clústeres con fragmentos de tamaño asimétrico. 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.

Este comando se genera automáticamente y corresponde 1:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupcluster.

Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.

Sintaxis

Sintaxis del comando

atlas api clusters updateCluster [options]

opciones

Nombre	Tipo	Requerido	Descripción
--clusterName	string	true	Etiqueta legible por humanos que identifica el clúster.
--sobre	envolvente	false	Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. 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 sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta.
--file	string	false	Ruta a tu archivo de solicitud de API. Déjalo en blanco para usar la entrada estándar; debes proporcionar una u otra, pero no ambas.
--ID de grupo	string	true	Cadena única de dígitos hexadecimales 24que identifica su proyecto. Utilice el punto de conexión [/groups](#tag/Projects/operation/listProjects) 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".
-h, --ayuda		false	ayuda para updateCluster
-o, --output	string	false	formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json".
--archivo de salida	string	false	archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip)
--bonito		false	Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
--versión	string	false	versión de la api que se debe usar al llamar a la API [opciones: "2023-01-01", "2023-02-01", "2024-08-05", "2024-10-23"], por defecto la última versión o el valor de configuración profiles api_version si está configurado Este valor se establece por defecto en "2024-10-23".
-w, --watch		false	Bandera que indica si se debe observar el comando hasta que complete su ejecución o se agote el tiempo de observación.
--watchTimeout	Int	false	Tiempo en segundos hasta que se agota el tiempo de vigilancia. Tras el tiempo de vigilancia, la CLI deja de monitorear el comando.

Opciones heredadas

Nombre	Tipo	Requerido	Descripción
-P, --profile	string	false	Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Ejemplos

Actualiza el clúster para aumentar el tamaño del disco a 20GB y aumentar el número de nodos a 5

Crea el archivo a continuación y guárdalo como payload.json

{
  "replicationSpecs": [
    {
      "regionConfigs": [
        {
          "electableSpecs": {
            "diskSizeGB": 20,
            "instanceSize": "M10",
            "nodeCount": 5
          },
          "priority": 7,
          "providerName": "AWS",
          "regionName": "US_EAST_1"
        }
      ]
    }
  ]
}

Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.

atlas api clusters updateCluster --version 2024-10-23 --clusterName [your-cluster-name] --groupId [your-project-id]

Volver

desanclarCaracterísticaCompatibilidadVersión

updateProcessArgs