atlas API dataFederation createDataFederationPrivateEndpoint

O suporte do Atlas CLI para executar comandos com a API de administração do Atlas está em visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Recursos de visualização.

Visualização pública: forneça feedback em: Adiciona um endpoint privado para instâncias de banco de dados federadas e Online Archives aos projetos especificados.

Se o ID do ponto de extremidade já existir e o comentário associado não for alterado, o Atlas Data Federation não fará nenhuma alteração na lista de IDs do ponto de extremidade. Se o ID do ponto de extremidade já existir e o comentário associado for alterado, o Atlas Data Federation atualizará o valor do comentário somente na lista de IDs do ponto de extremidade. Se o ID do ponto de extremidade não existir, o Atlas Data Federation anexará o novo ponto de extremidade à lista de pontos de extremidade na lista de IDs de pontos de extremidade. Cada região tem um nome de serviço associado para os diversos pontos de extremidade em cada região.

us-east-1 é com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4.

us-west-1 is com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb.

eu-west-1 is com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e.

eu-west-2 is com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9.

eu-central-1 is com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d.

sa-east-1 is com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044.

ap-southeast-2 é com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e.

ap-south-1 é com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d.

Para usar esse recurso, a chave de API solicitante deve ter as funções de "Proprietário do projeto" ou "Administrador de gráficos do projeto".

Este comando é gerado automaticamente e 1 corresponde:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Data- Federation/operation/createDataFederationPrivateEndpoint.

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

Sintaxe

Sintaxe do comando

atlas api dataFederation createDataFederationPrivateEndpoint [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 createDataFederationPrivateEndpoint
--output	string	false	formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".
--output-file	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 <a URL =https://en.wikipede.org/wiki/Prettyprint" formato target="_blank" rel="noopener noreferrer">pretty-print</a>.
--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.