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 conta de Serviço ou a chave de API solicitante deve ter as funções de proprietário do projeto ou administrador de gráficos do projeto.
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair 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.
O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON 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 consulta. 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.
O valor padrão é false.
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é false.
Endpoint privado para instâncias do banco de dados federados e Online Archives para adicionar ao projeto especificado.
ID do link que identifica a conexão de endpoint privado do Azure.
String legível para humanos para associar a esse endpoint privado.
Etiqueta legível por humanos para identificar o nome DNS do ponto de extremidade VPC do cliente. Se definido, você também deve especificar um valor para a região.
Endereço IP usado para se conectar ao endpoint privado do Azure.
O formato deve corresponder ao seguinte padrão: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.
String única alfanumérica de 24 caracteres que identifica o endpoint privado.
O formato deve corresponder ao seguinte padrão: ^vpce-[0-9a-f]{17}$.
Mensagem de erro descrevendo uma falha aprovando a solicitação de endpoint privado.
Etiqueta legível por humanos que identifica o provedor de serviços de nuvem. O Atlas Data Lake suporta apenas Amazon Web Services.
O valor é AWS. O valor padrão é AWS.
Etiqueta legível por humanos para identificar a região do ponto de extremidade VPC do cliente. Se definido, você também deve especificar um valor para customerEndpointDNSName.
Status da solicitação de conexão do endpoint privado.
Os valores são PENDING, OK, FAILED ou DELETING.
Etiqueta legível para humanos que identifica o tipo de recurso associado a este endpoint privado.
O valor é DATA_LAKE. O valor padrão é DATA_LAKE.
atlas api dataFederation createPrivateEndpointId --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateGroupPrivateNetworkSettingEndpointIdApiParams{}
sdkResp, httpResp, err := client.DataFederationApi.
CreateGroupPrivateNetworkSettingEndpointIdWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \
-d '{ <Payload> }'{
"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}
],
"totalCount": 42
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}