- 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.
Este tutorial le muestra cómo ejecutar comandos de la CLI de Atlas con la API de Administración de Atlas. Puede usar todos los recursos y puntos finales de la API de Administración de Atlas desde la CLI de Atlas para crear y administrar implementaciones de Atlas. La compatibilidad de la CLI de Atlas con la API de Administración de Atlas ofrece las siguientes ventajas:
Paridad total de funciones con la API de administración de Atlas.
Acceso más rápido a los nuevos recursos y puntos finales de la API de administración de Atlas.
Una estructura de comandos unificada y predecible para la automatización.
Capacidad de fijar una versión de API deseada, lo que garantiza que sus scripts sigan siendo confiables, incluso si actualiza la CLI.
Sintaxis
Para utilizar Atlas CLI con la API de administración de Atlas, ejecute el comando en el siguiente formato:
atlas api <tag> <operationId> [options]|--file <fileName>.json --version <api-resource-version>
Arguments
Argument | Necesidad | Descripción | ||
|---|---|---|---|---|
| Requerido | El nombre de la etiqueta utilizada en la documentación de la API de administración de Atlas URL del recurso de la API. La etiqueta está separada por guiones en la URL de la documentación de la API de Administración de Atlas. Sin embargo, debe convertirla a CamelCase en la sintaxis de comandos de la CLI de Atlas. Por ejemplo, considere la siguiente URL para un recurso de API de administración de Atlas: Para acceder al recurso en la URL anterior, reemplace Para más ejemplos, véase Ejemplos. | ||
| Requerido | El identificador de la operación en la URL de la documentación de la API de Administración de Atlas para el punto final de la API. El valor está en formato CamelCase. Por ejemplo, considere la siguiente URL para una operación de punto final de la API de administración de Atlas: Para realizar la operación admitida por el punto final en la URL anterior, reemplace Para ver más ejemplos, consulte Ejemplos. |
opciones
Puedes pasar los parámetros de la ruta, consulta y cuerpo de la solicitud de la API como opciones con el comando. Puedes especificar las opciones directamente con el comando o usando un archivo JSON. El comando también admite las siguientes opciones:
Opción | Necesidad | Descripción |
|---|---|---|
| Condicional | ArchivoJSON que contiene la ruta de la API, la consulta y los parámetros del cuerpo de la solicitud para la operación. Esto solo es necesario si existen parámetros de ruta, consulta o cuerpo de la solicitud obligatorios para la operación que no se especifican directamente con el comando. |
| Opcional | Versión del recursoAPI que se usará. Recomendamos usarla para fijar tus scripts a versiones específicas de la API. Si se omite, el comando usa la versión más reciente (o la versión configurada en tu perfil) de forma predeterminada. Sin embargo, recomendamos configurar la versión explícitamente para garantizar la estabilidad de tus scripts. Esto evita que se rompan cuando se publiquen nuevas versiones de la API con cambios potencialmente incompatibles. |
Ejemplos
El siguiente comando CLI de Atlas con la API de administración de Atlas demuestra cómo recuperar un archivo de registro comprimido (.gz) que contiene un rango de mensajes de registro para el host especificado para el proyecto especificado:
atlas api monitoringAndLogs getHostLogs --groupId 5e2211c17a3e5a48f5497de3 --hostName mycluster-shard-00-02.7hgjn.mongodb.net --logName mongodb --output gzip --version 2025-03-12
El siguiente comando CLI de Atlas con la API de administración de Atlas demuestra cómo crear un clúster mediante la opción --file.
atlas api clusters createCluster --groupId 5e2211c17a3e5a48f5497de3 --file cluster-config.json --version 2025-03-12
Para obtener más información sobre cómo crear un archivo de configuración para un clúster, consulte Archivo de configuración de clúster.
El siguiente comando Atlas CLI con la API de administración de Atlas demuestra cómo simular interrupciones del servicio regionales del proveedor de nube. Esta simulación te permite probar el comportamiento de conmutación por error de tu aplicación y los procedimientos de recuperación ante desastres en un entorno controlado, separado de la producción. El comando utiliza un archivo llamado outage_simulation.json con los siguientes ajustes:
{ "outageFilters": [ { "cloudProvider": "AWS", "regionName": "US_EAST_1", "type": "REGION" } ] }
atlas api clusterOutageSimulation startOutageSimulation --groupId 5e2211c17a3e5a48f5497de3 --clusterName myCluster --file outage_simulation.json --version 2025-03-12
{"clusterName":"myCluster","groupId":"5e2211c17a3e5a48f5497de3","id":"6808ed9bed0b0b51caee336b","outageFilters":[{"cloudProvider":"AWS","regionName":"US_EAST_1","type":"REGION"}],"startRequestDate":"2025-04-23T13:39:39Z","state":"START_REQUESTED"}