Visualização pública: forneça comentários: retorna uma entrada de lista de lista de acesso IP do projeto especificado.
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 comentários em https://feedback.mongodb.com/forums/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.
Cada entrada na lista de acesso IP do projeto contém um endereço IP ou um bloco de endereços IP com anotação CIDR. A MongoDB Cloud só permite conexões de cliente com o cluster a partir de entradas na lista de acesso IP do projeto. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter as funções "somente leitura" do projeto ou "Administrador de Charts do projeto". Esse recurso substitui o recurso da lista de permissões. A MongoDB Cloud removeu as listas de permissões em 2021 de julho. Atualize seus aplicativos para usar esse novo recurso. Este endpoint (/groups/{GROUP-ID}/accessList) gerencia a lista de acesso IP do projeto. Ele não gerencia a lista de acesso para organizações MongoDB Cloud. O endpoint Programmatic API Keys (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) gerencia essas listas de acesso.
Este comando é gerado automaticamente e corresponde 1:1 ao ponto de extremidade da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-getprojectiplist.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api projectIpAccessList getProjectIpList [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--entryValue | / | true | Entrada da lista de acesso que você deseja retornar da lista de acesso IP do projeto. Esse valor pode usar uma das seguintes opções: um ID do grupo de segurança da Amazon Web Services, um endereço IP ou um bloco de endereços CIDR. Para blocos CIDR que usam uma máscara de sub-rede, substitua a barra (/) pelo seu valor codificado para URL( |
--envelope | envelope | false | Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta. |
--groupId | string | true | Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint [/groups](#tag/Projects/operation/listProjects) para recuperar todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
-h, --help | false | ajuda para getProjectIpList | |
-o, --output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--outputFile | string | false | no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip) |
--pretty | false | Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. | |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2023-01a01". |
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. |
Exemplos
atlas api projectIpAccessList getProjectIpList --version 2023-01-01 --entryValue 10.0.0.0/16 --groupId [your-project-id]