atlas API dataFederation createDataFederationPrivateEndpoint

: Esta versão da documentação foi arquivada e não é mais suportada. Consulte adocumentação atual do para saber como atualizar sua versão da Atlas CLI.

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.

experimental: adiciona um endpoint privado para instâncias do banco de dados federados e Online Archives nos projetos especificados.

Se o ID do endpoint 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 endpoint. Se o ID do endpoint 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 endpoint. Se o ID do endpoint não existir, o Atlas Data Federation anexará o novo endpoint à lista de endpoints na lista de IDs de endpoints. Cada região tem um nome de serviço associado para os diversos endpoints em cada região. us-east-1 é com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4. us-west-1 é com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb . eu-west-1 é com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e. eu-west-2 é com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9. eu-central-1 é com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d. sa-east-1 é 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 Charts do projeto". Este comando está invocando o endpoint com OperationID: 'createDataFederationPrivateEndpoint'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint

Sintaxe

Sintaxe do comando

atlas api dataFederation createDataFederationPrivateEndpoint [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--envelope		false	sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope
--file	string	false	caminho para o arquivo que contém o conteúdo da solicitação de API
--groupId	string	true	string exclusiva de dígitos hexadecimais 24que identifica seu projeto
-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 formato de impressão bonita
--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.

Voltar

Data Federation

createFederatedDatabase