- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Elimina el clúster especificado de tu proyecto.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). 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.
El comando le solicita que confirme la operación cuando ejecuta el comando sin la opción --force.
Al eliminar un clúster también se eliminan todas las instantáneas de respaldo de ese clúster.
Para usar este comando, debes autenticarte con una cuenta de usuario o una clave de API con el rol de Propietario de Proyecto.
Sintaxis
atlas clusters delete <clusterName> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
nombre del clúster | string | true | Nombre del cluster a eliminar. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--force | false | Bandera que indica si se debe omitir la solicitud de confirmación antes de continuar con la acción solicitada. | |
-h, --ayuda | false | ayuda para eliminar | |
--projectId | string | false | Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
-w, --watch | false | Indicador que indica si se debe supervisar el comando hasta que se complete su ejecución o hasta que se agote el tiempo de vigilancia. Para establecer el tiempo de vigilancia, utilice la opción --watchTimeout. | |
--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. |
Salida
Si el comando se ejecuta correctamente, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.
Deleting cluster '<Name>'
Ejemplos
# Remove a cluster named myCluster after prompting for a confirmation: atlas clusters delete myCluster
# Remove a cluster named myCluster without requiring confirmation: atlas clusters delete myCluster --force