Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/
Atlas CLI

Conecte-se a partir da Atlas CLI

Nesta página

  • Selecione um método de conexão
  • Conecte-se com as Configurações Mínimas Necessárias
  • Concluir os pré-requisitos
  • Siga estas etapas
  • Dê os próximos passos

Selecione um método de conexão

Quando você se conecta a uma conta Atlas existente a partir do Atlas CLI, você pode autenticar com um dos seguintes comandos:

Comando
Método de autenticação
Caso de uso
atlas auth login
Credenciais de login do Atlas e um token de autenticação
Ideal para uso sem necessidade de programação
atlas config init
Chaves de API
Ideal para uso programático

Importante

As chaves API são armazenadas em texto simples no arquivo de configuração Atlas CLI. Suas chaves de API são como senhas. Certifique-se de proteger o arquivo de configuração adequadamente.

Para criar uma nova conta do Atlas ou integrar uma conta existente que não tenha clusters, consulte Introdução ao Atlas.

Selecione abaixo uma ocasião de uso para saber mais sobre as opções de conexão disponíveis:

Utilize o comando atlas auth login para autenticar com suas credenciais de login do Atlas e um token de autenticação único. atlas auth login exige login manual e verificação de um token de autenticação, que é válido por 12 horas. As chaves da API são opcionais ao se conectar com atlas auth login.

Depois de executar atlas auth login, você pode:

  • Conecte-se com as configurações mínimas necessárias e especifique as flags --projectId e --orgId com cada comando. Esta é a maneira mais rápida de começar para o primeiro login.

  • Salve suas configurações de conexão em um perfil. Os perfis armazenam as IDs do projeto, as IDs da organização e, opcionalmente, as chaves de API a serem usadas nas futuras sessões do Atlas CLI. Para economizar tempo, você pode especificar um perfil em vez de usar os sinalizadores --projectId e --orgId com cada comando.

Você deve configurar chaves de API para autenticar com este comando.

Ao executar o comando atlas config init, o Atlas CLI solicita que você forneça suas chaves de API e cria automaticamente um perfil que armazena as chaves de API. atlas config init é melhor para uso por código de programação porque não exige login manual ou verificação de token.

Ao usar a conexão com atlas config init, você pode:

  • Conecte-se com as configurações mínimas necessárias e especifique as flags --projectId e --orgId com cada comando. Esta é a maneira mais rápida de começar para o primeiro login.

  • Salve as configurações de conexão adicionais em um perfil. Os perfis armazenam as IDs do projeto, as IDs da organização e, opcionalmente, as chaves de API a serem usadas nas futuras sessões do Atlas CLI. Para economizar tempo, você pode especificar um perfil em vez de usar os sinalizadores --projectId e --orgId com cada comando.

Conecte-se com as Configurações Mínimas Necessárias

Selecione um caso de uso e siga as etapas para se conectar a partir do Atlas CLI com configurações mínimas necessárias.

Concluir os pré-requisitos

Siga estas etapas

Selecione um caso de uso e siga o procedimento para se conectar rapidamente a partir do Atlas CLI.

1

Execute o comando de autenticação.

Execute o comando atlas auth login no seu terminal.

atlas auth login

O comando abre uma janela do navegador e retorna um código de ativação único. Este código expira após 10 minutos.

2

Inicie a sessão no Atlas.

Se você ainda não estiver registrado, entre na sua conta do Atlas no navegador.

3

Insira o código de autorização.

Cole seu código de ativação no navegador e clique em Confirm Authorization.

4

Retorne ao Atlas CLI e aceite as opções de perfil padrão.

Retorne ao terminal. Se você se conectar com sucesso, verá uma mensagem:

Successfully logged in as {Your Email Address}.

Aceite a configuração-padrão de perfil pressionando Enter se as seguintes opções forem exibidas:

  • Default Org ID

  • Default Project ID

  • Default Output Format

  • Default MongoDB Shell Path

Importante

Se você configurou anteriormente qualquer perfil com as chaves da API para MongoCLI, seus perfis migrarão automaticamente. Alguns perfis migrados podem fazer com que os comandos da Atlas CLI falhem durante a autenticação com atlas auth login. A seguinte mensagem é exibida quando você executa atlas auth login se houver um conflito:

There was an error fetching your organizations: Global user is
from outside whitelisted subnets.

Para corrigir o conflito, abra o arquivo de configuração, remova o perfil padrão e execute atlas auth login novamente.

5

Emita comandos usando os sinalizadores --projectId --orgId e.

Ao executar os comandos do Atlas CLI durante a sessão do Atlas CLI, especifique a ID do projeto e da organização usando os sinalizadores --projectId e --orgId.

Exemplo

atlas alerts list --projectId 60b3c81153cf986293e2608b
1

Execute o comando de autenticação.

Execute o comando atlas config init no seu terminal.

atlas config init
2

Insira suas chaves API.

Insira suas chaves pública e privada quando solicitado.

3

Aceite as opções de perfil padrão.

Aceite as opções restantes do perfil padrão pressionando Enter quando as seguintes opções forem exibidas:

  • Default Org ID

  • Default Project ID

  • Default Output Format

  • Default MongoDB Shell Path

4

Emita comandos usando os sinalizadores --projectId --orgId e.

Ao executar os comandos do Atlas CLI durante a sessão do Atlas CLI, especifique a ID do projeto e da organização usando os sinalizadores --projectId e --orgId.

Exemplo

atlas alerts list --projectId 60b3c81153cf986293e2608b

Dê os próximos passos

Comece a usar os comandos CLI do Atlas.

Para salvar as configurações de conexão modificando o perfil padrão ou criando um perfil diferente, consulte Salvar configurações de conexão.

Voltar

Verificar os pacotes

Próximo

Salve as Configurações de Conexão