Cree un punto final privado de almacenamiento de objetos para copias de seguridad en la nube para un proveedor de nube en un proyecto
Crea un punto final privado en la región especificada para una conectividad segura y privada entre Atlas y los servicios de almacenamiento de objetos del proveedor de la nube para operaciones de respaldo.
Parámetros de ruta
-
Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Etiqueta legible por humanos que identifica al proveedor de la nube para que se cree el punto final privado.
El valor es
AWS.
Parámetros de consulta
-
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita -
Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false.
Cuerpo
Requerido
Crea un punto final privado en la región especificada para operaciones de respaldo de almacenamiento de objetos.
-
Etiqueta legible por humanos que identifica al proveedor de la nube.
El valor es
AWS. -
Ubicación física donde MongoDB Cloud implementa los nodos de su clúster MongoDB alojados en AWS. La región que elija puede afectar la latencia de red de los clientes que acceden a sus bases de datos. Al implementar un clúster dedicado, MongoDB Cloud comprueba si existe una VPC o una conexión de VPC para ese proveedor y región. De no ser así, MongoDB Cloud las crea durante la implementación. MongoDB Cloud asigna un bloque CIDR a la VPC. Para limitar una nueva conexión de emparejamiento de VPC a un bloque CIDR y una región, cree primero la conexión. Despliegue el clúster después de que se inicie la conexión.
Los valores son
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_1oGLOBAL.
atlas api cloudBackups createBackupPrivateEndpoint --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241113001/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.2024-11-13+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.2024-11-13+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"
}