Retornar todas as organizações.
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.
Para usar esse comando, você deve autenticar com uma conta de usuário ou uma chave de API com o role de membro da organização.
Sintaxe
atlas organizations list [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-h, --help | false | ajuda para lista | |
--includeDeleted | false | Sinalizador que indica se as organizações excluídas devem ser incluídas na lista. Esta opção se aplica somente a organizações do Ops Manager. Você não pode retornar organizações Atlas ou Cloud Manager excluídas. | |
--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. |
--name | string | false | Nome da organização para realizar uma pesquisa sem diferenciação de maiúsculas e minúsculas. |
--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. |
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 NAME <Id> <Name>
Exemplos
# Return a JSON-formatted list of all organizations: atlas organizations list --output json
# Return a JSON-formatted list that includes the organizations named org1 and Org1, but doesn't return org123: atlas organizations list --name org1 --output json