Observe o cluster especificado em seu projeto até que ele fique disponível.
Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Este comando verifica o status do cluster periodicamente até atingir um estado IDLE. Quando o cluster atingir o estado esperado, o comando imprimirá “Cluster disponível.” Se você executar o comando no terminal, ele bloqueará a sessão do terminal até que o estado do recurso mude para IDLE. Você pode interromper a pesquisa do comando a qualquer momento com CRTL-C.
Para usar esse comando, você deve autenticar com uma conta de usuário ou uma chave de API com o role de Somente Leitura do projeto.
Sintaxe
atlas clusters watch <clusterName> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
clusterName | string | true | Nome do cluster a ser observado. |
Opções
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
-h, --help | false | ajuda para assistir | |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
Cluster available.
Exemplos
# Watch for the cluster named myCluster to become available for the project with ID 5e2211c17a3e5a48f5497de3: atlas clusters watch myCluster --projectId 5e2211c17a3e5a48f5497de3