Criar um ponto de extremidade privado de armazenamento de objetos para backups em nuvem para um provedor de nuvem em um projeto
Cria um ponto de extremidade privado na região especificada para conectividade segura e privada entre o Atlas e os serviços de armazenamento de objeto do provedor de nuvem para operações de backup.
parâmetros de caminho
-
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})$. -
Etiqueta legível por humanos que identifica o provedor de nuvem a ser criado pelo endpoint privado.
O valor é
AWS.
parâmetros de query
-
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint -
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.
corpo, corpo
Obrigatório
Cria pontos de extremidade privados na região especificada para operação de backup de armazenamento de objeto.
-
Etiqueta legível por humanos que identifica o provedor de nuvem.
O valor é
AWS. -
Local físico onde a MongoDB Cloud implementa seus nós de cluster MongoDB hospedados na AWS. A região escolhida pode afetar a latência da rede para os clientes que acessam seus bancos de dados. Quando o MongoDB Cloud implementa um cluster dedicado, ele verifica se existe uma conexão VPC ou VPC para esse provedor e região. Caso contrário, o MongoDB Cloud os cria como parte da implantação. O MongoDB Cloud atribui à VPC um bloco CIDR. Para limitar uma nova conexão de emparelhamento da VPC a um bloco e região CIDR, crie primeiro a conexão. Implemente o cluster após o início da conexão.
Os valores são
US_GOV_WEST_1,US_GOV_EAST_1,US_EAST_1,US_EAST_2,US_WEST_1,US_WEST_2,CA_CENTRAL_1,EU_NORTH_1,EU_WEST_1,EU_WEST_2,EU_WEST_3,EU_CENTRAL_1,AP_EAST_1,AP_NORTHEAST_1,AP_NORTHEAST_2,AP_NORTHEAST_3,AP_SOUTHEAST_1,AP_SOUTHEAST_2,AP_SOUTHEAST_3,AP_SOUTH_1,SA_EAST_1,CN_NORTH_1,CN_NORTHWEST_1,ME_SOUTH_1,AF_SOUTH_1,EU_SOUTH_1ouGLOBAL.
atlas api cloudBackups createBackupPrivateEndpoint --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.CreateGroupBackupPrivateEndpointApiParams{}
sdkResp, httpResp, err := client.CloudBackupsApi.
CreateGroupBackupPrivateEndpointWithParams(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}/backup/{cloudProvider}/privateEndpoints" \
-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}/backup/{cloudProvider}/privateEndpoints" \
-d '{ <Payload> }'{
"cloudProvider": "AWS",
"regionName": "US_GOV_WEST_1"
}{
"cloudProvider": "AWS",
"errorMessage": "string",
"id": "32b6e34b3d91647abb20e7b8",
"privateEndpointConnectionName": "string",
"regionName": "US_GOV_WEST_1",
"status": "INITIATING"
}{
"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": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}