/ /

/ /

atlas api clusters updateCluster

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

El subcomando del atlas api se genera automáticamente a partir de la API de administración de MongoDB Atlas y ofrece una cobertura total de la API de administración. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puedes consultar a través del enlace a la documentación del endpoint de la API proporcionada.

Los clústeres contienen un grupo de hosts que mantienen el mismo conjunto de datos. Este recurso puede actualizar clústeres con particiones de tamaño asimétrico. Para actualizar la protección contra terminación de un clúster, la Cuenta de servicio o clave de API solicitante debe tener el rol de propietario del proyecto. Para todas las demás actualizaciones, la Cuenta de servicio solicitante o la clave API deben tener el rol de Administrador de clúster de proyecto. No se puede modificar un clúster pausado (pausado : true). Debe llamar a este endpoint para establecer paused : false. Después de que este punto final responda con paused : false, puede llamarlo nuevamente con los cambios que desea realizar en el clúster. Esta funcionalidad no está disponible para clústeres sin servidor.

Este comando se genera automáticamente y corresponde 1:1 con el endpoint 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, consulta la documentación de la API referenciada que se encuentra 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.
--envelope	envelope	false	Indicador que señala si la Aplicación envuelve la respuesta en un objeto JSON de envoltorio. Algunos clientes de API no pueden acceder a las cabeceras de respuesta HTTP o al código de estado. Para remediarlo, establece envelope=true en la query. 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éjelo vacío para utilizar la entrada estándar en su lugar; debe proporcionar uno u otro, pero no ambos.
--groupId	string	true	string hexadecimal única de 24dígitos que identifica tu proyecto. Utiliza el punto final [/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 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.
-h, --help		false	ayuda para updateCluster
-o, --output	string	false	formato API preferido, puede ser ["JSON", plantilla-go] Este valor por defecto es "JSON".
--outputFile	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)
--bastante		false	Bandera que indica si el cuerpo de la respuesta debe estar en el 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	Indicador que señala si se debe observar el comando hasta que complete su ejecución o hasta que se agote el tiempo de observación.
--watchTimeout	Int	false	Tiempo en segundos hasta que una conexión se agote. Después de que una monitorización agote su tiempo, la CLI deja de monitorear el comando.

Opciones heredadas

Nombre	Tipo	Requerido	Descripción
-P, --profile	string	false	Nombre del perfil que se utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta 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.

Cree el archivo siguiente y guárdelo 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, ejecuta el siguiente comando en el mismo directorio.

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

Volver

unpinFeatureCompatibilityVersion

updateProcessArgs