Elimina un clúster flexible del 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.
El clúster flexible debe tener la protección de terminación deshabilitada para poder eliminarse. Para usar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de propietario del proyecto.
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-deletegroupflexcluster.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api flexClusters deleteFlexCluster [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--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. |
--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 deleteFlexCluster | |
--name | string | true | Etiqueta legible por humanos que identifica el clúster flexible. |
-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 API a utilizar al llamar a la llamada de API [opciones: "2024-11-13"], el valor predeterminado es la última versión o el valor de configuración api_version de los perfiles si está configurado. Este valor predeterminado es "2024-11-13". |
-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
atlas api flexClusters deleteFlexCluster --version 2024-11-13 --groupId 32b6e34b3d91647abb20e7b8 --name [name]