La CLI de Atlas proporciona la api subcomando con el que puedes acceder a cada endpoint de la API de Administración de Atlas directamente desde la Atlas CLI. Esta funcionalidad es una forma sólida y fiable de utilizar todas las capacidades de la API de Administración de Atlas. Proporciona acceso a toda la API de Administración de Atlas para que puedas crear scripts o automatizar cualquier tarea, con los beneficios que brinda el uso de una interfaz de línea de comandos:
Paridad total de funcionalidad 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 Atlas.
Una estructura de comandos unificada y predecible para la automatización.
Capacidad para fijar una versión deseada de la API, garantizando que tus scripts sigan siendo fiables, incluso si actualizas la CLI.
Capacidad de observar un comando hasta que la operación se complete.
Este tutorial demuestra cómo usar la API de administración de Atlas desde los comandos del Atlas CLI.
Nota
La Los subcomandos de API se generan automáticamente desde la API de Administración de Atlas y brindan acceso a toda la API de administración de Atlas (incluidos los recursos de vista previa). Debes tener cierta familiaridad con la API de Administración de Atlas, así como comprender que la entrada y salida por defecto es un mapeo directo del tipo de medios de la API para beneficiarte de esta funcionalidad de la Atlas CLI.
Sintaxis
Para usar Atlas CLI con la API de Administración de Atlas, ejecuta 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 utilizado en la documentación de la API de administración de Atlas URL para el recurso API. La etiqueta está separada por guiones en la documentación de la API de administración de Atlas URL. Sin embargo, debes convertirlo a camelcase en la sintaxis del comando Atlas CLI. Por ejemplo, considere la siguiente URL para un recurso de la API de Administración de Atlas: Para acceder al recurso en la siguiente URL, reemplaza Para más ejemplos, consulte ejemplo. | ||
| Requerido | El identificador de la operación en la documentación de la API de administración de Atlas URL para el API endpoint. El valor está en formato camelcase. Por ejemplo, considera el siguiente URL para una operación de punto final de la API de Administración de Atlas: Para realizar la operación soportada por el endpoint en la URL anterior, sustituya Para más ejemplos, consulte Ejemplos. |
opciones
Puedes pasar los parámetros de path, query y body de solicitud de la API como opciones con el comando. Puede especificar las opciones directamente con el comando o utilizando un archivo JSON. El comando también admite las siguientes opciones:
Opción | Necesidad | Descripción |
|---|---|---|
| Condicional | Archivo JSON que contiene la ruta de la API, la query y los parámetros del cuerpo de la solicitud para la operación. Esto solo es necesario si hay parámetros obligatorios de ruta, query o cuerpo de la solicitud para la operación que no estás especificando directamente con el comando. |
| Opcional | Versión del recurso API que se va a usar. Recomendamos usarla para fijar sus scripts a versiones específicas de la API. Si se omite, el comando selecciona la última versión por defecto (o la versión configurada en tu perfil). Sin embargo, recomendamos establecer explícitamente la versión para garantizar que los scripts permanezcan estables. Esto protege tus scripts de romperse cuando se lanzan nuevas versiones de API con posibles cambios incompatibles. |
| Opcional | Indicador que especifica si se debe observar la operación hasta que se complete. |
Ejemplos
El siguiente comando de Atlas CLI con la API de administración de Atlas demuestra cómo recuperar una entrada de registro comprimida (.gz) que contiene un rango de mensajes de registro para el host especificado y 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 de Atlas CLI con la Atlas Administration API demuestra cómo crear un clúster usando 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, consulta 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"}