Retornar todos os arquivos online do seu cluster.
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 list [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterName | string | true | Nome do cluster. Para saber mais, consulte https://dochub.mongodb.org/core/create-cluster-api. |
-h, --help | false | ajuda para lista | |
--limit | int | false | Número de itens por página de resultados, até um máximo de 500. Se você tiver mais de 500 resultados, especifique a opção --page para alterar a página de resultados. Este valor é padronizado para 100. |
--omitCount | false | Sinalizador que indica se a resposta JSON retorna o número total de itens (totalCount) na resposta JSON. | |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
--page | int | false | Número da página que especifica uma página de resultados. Este valor é padronizado como 1. |
--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.
ID DATABASE COLLECTION STATE <Id> <DbName> <CollName> <State>
Exemplos
# Return a JSON-formatted list of online archives for the cluster named myCluster: atlas clusters onlineArchives list --clusterName myCluster --output json