O Atlas CLI fornece o subcomando api com o qual você pode acessar cada endpoint da API de administração do Atlas diretamente do Atlas CLI. Essa funcionalidade é uma maneira robusta e confiável de usar todos os recursos da API de administração do Atlas . Ele fornece acesso a toda a API de administração do Atlas para que você possa criar um script ou automatizar qualquer tarefa, com os benefícios resultantes do uso de uma interface de linha de comando:
Paridade completa de recursos com a API de administração do Atlas .
Acesso mais rápido a novos recursos e endpoints da API de administração do Atlas .
Uma estrutura de comando unificada e previsível para automação.
Capacidade de fixar uma versão da API desejada, garantindo que seus scripts permaneçam confiáveis, mesmo que você atualize a CLI.
Capacidade de assistir a um comando até que a operação seja concluída.
Este tutorial demonstra como usar a API de administração do Atlas a partir dos comandos do Atlas CLI .
Observação
Os subcomandos da API são gerados automaticamente a partir da API de administração do Atlas e fornecem acesso a toda a API de administração do Atlas (incluindo recursos de visualização). Você deve ter alguma familiaridade com a API de administração do Atlas , bem como um entendimento de que a entrada e saída padrão é um mapeamento direto do tipo de mídia da API para se beneficiar desse recurso do Atlas CLI .
Sintaxe
Para usar o Atlas CLI com a API de administração do Atlas , execute o comando no seguinte formato:
atlas api <tag> <operationId> [options]|--file <fileName>.json --version <api-resource-version>
argumentos
Argument | necessidade | Descrição | ||
|---|---|---|---|---|
| Obrigatório | O nome da tag usada na URL de documentação da API de administração do Atlas para o recurso da API. A marcação é separada por hífen no URL de documentação da API de administração do Atlas. No entanto, você deve convertê-lo para camelcase na sintaxe de comando do Atlas CLI . Por exemplo, considere a seguinte URL para um recurso de API de Administração do Atlas : Para acessar o recurso na URL anterior, substitua Para mais exemplos, consulte Exemplos. | ||
| Obrigatório | O identificador da operação na URL de documentação da API de Administração do Atlas para o endpoint da API. O valor está no formato camelcase. Por exemplo, considere a seguinte URL para uma operação de endpoint da API de administração do Atlas: Para executar a operação suportada pelo endpoint na URL anterior, substitua Para mais exemplos, consulte Exemplos. |
Opções
Você pode passar os parâmetros do caminho da API, da query e do corpo da solicitação como opções com o comando. Você pode especificar as opções diretamente com o comando ou usando um arquivo JSON. O comando também suporta as seguintes opções:
Opção | necessidade | Descrição |
|---|---|---|
| Condicional | Arquivo JSON que contém o caminho da API, a query e os parâmetros do corpo da solicitação para a operação. Isso será necessário somente se houver parâmetros de caminho, query ou corpo da solicitação necessários para a operação que você não está especificando diretamente com o comando. |
| Opcional | Versão dorecurso API a ser usado. Recomendamos usá-lo para fixar seus scripts em versões específicas da API. Se omitido, o comando padrão para a versão mais recente (ou a versão configurada do seu perfil). No entanto, recomendamos definir explicitamente a versão para garantir que seus scripts permaneçam estáveis. Isso protege seus scripts contra quebras quando novas versões da API são lançadas com alterações potencialmente incompatíveis. |
| Opcional | Sinalizador que especifica se a operação deve observar a operação até que ela seja concluída. |
Exemplos
O comando da Atlas CLI a seguir com a API de administração do Atlas demonstra como recuperar um arquivo de log compactado (.gz) que contém uma faixa de mensagens de log para o host especificado para o projeto especificado:
atlas api monitoringAndLogs getHostLogs --groupId 5e2211c17a3e5a48f5497de3 --hostName mycluster-shard-00-02.7hgjn.mongodb.net --logName mongodb --output gzip --version 2025-03-12
O seguinte comando da Atlas CLI com a API de administração do Atlas demonstra como criar um cluster utilizando a opção --file.
atlas api clusters createCluster --groupId 5e2211c17a3e5a48f5497de3 --file cluster-config.json --version 2025-03-12
Para saber mais sobre como criar um arquivo de configuração para um cluster, consulte Arquivo de Configuração de Cluster.
O seguinte comando da Atlas CLI com a API de Administração do Atlas demonstra como simular interrupções do provedor de nuvem regional. Essa simulação permite testar o comportamento de failover do aplicativo e os procedimentos de recuperação de desastres em um ambiente controlado separado da produção. O comando utiliza um arquivo denominado outage_simulation.json com as seguintes configurações:
{ "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"}