/ /

Lista de acesso IP do projeto

Página inicial do Docs

/ /

atlas api

Lista de acesso IP do projeto

Página inicial do Docs

Ferramentas

Atlas CLI

atlas api

Lista de acesso IP do projeto

atlas api projectIpAccessList createAccessListEntry

Adiciona uma ou mais entradas de lista de acesso ao projeto especificado.

O subcomando atlas api é gerado automaticamente a partir da API de administração do MongoDB Atlas e oferece cobertura completa da API de administração. 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.

A MongoDB Cloud só permite conexões de cliente com o cluster a partir de entradas na lista de acesso IP do projeto. Escreva cada entrada como um endereço IP ou um bloco de endereços IP anotado em CIDR. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter as funções de "Proprietário 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. O endpoint /groups/{GROUP-ID}/accessList gerencia a lista de acesso IP do banco de dados . Esse endpoint é diferente do endpoint orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist, que gerencia a lista de acesso para organizações da MongoDB Cloud. Esse endpoint não suporta solicitações POST simultâneas. Você deve enviar várias solicitações POST de forma síncrona.

Este comando é gerado automaticamente e 1 corresponde:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/ operation-creategroupaccesslistentry.

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe

Sintaxe do comando

atlas api projectIpAccessList createAccessListEntry [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--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.
--file	string	false	caminho para seu arquivo de solicitação de API. Deixe vazio para usar a entrada padrão - você deve fornecer um ou outro, mas não ambos.
--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 createAccessListEntry
--includeCount		false	Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
--itemsPerPage	int	false	Número de itens que a resposta retorna por página.
-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)
--pageNum	int	false	Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
--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

Adiciona múltiplas entradas de lista de acesso ao projeto especificado

Crie o arquivo abaixo e salve-o como payload.json

[
  {
    "cidrBlock": "192.168.1.0/24",
    "comment": "Internal network range"
  },
  {
    "cidrBlock": "10.0.0.0/16",
    "comment": "VPC network range"
  }
]

Após criar o payload.json, execute o comando abaixo no mesmo diretório.

atlas api projectIpAccessList createAccessListEntry --version 2023-01-01 --groupId [your-project-id]

Voltar

Lista de acesso IP do projeto

createProjectIpAccessList