Fique atento para que um arquivo esteja disponível.
Visualização pública: o subcomando atlas api, 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 arquivo periodicamente até atingir um estado diferente de PENDING ou PAUSING. Quando o arquivo atingir o status esperado, o comando imprimirá "Atlas Online Archive disponível." Se você executar o comando no terminal, ele bloqueará a sessão do terminal até que o status do recurso mude para o status esperado. 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 onlineArchives watch <archiveId> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
archiveId | string | true | Identificador único do Atlas Online Archive a ser assistido. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterName | string | false | Nome do cluster. Para saber mais, consulte https://dochub.mongodb.org/core/create-cluster-api. |
-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.
Online archive available.
Exemplos
atlas cluster onlineArchive watch archiveIdSample --clusterName clusterNameSample