백업 작업을 위해 Atlas 와 cloud 제공자 객체 저장 서비스 간의 안전한 비공개 연결을 위해 지정된 리전 에 비공개 엔드포인트를 생성합니다.
경로 매개변수
-
프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다. -
생성할 비공개 엔드포인트의 클라우드 공급자를 식별하는 사람이 읽을 수 있는 레이블입니다.
값은
AWS입니다.
쿼리 매개변수
-
응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
기본값은
false입니다.Prettyprint -
애플리케이션이 응답을
envelopeJSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false입니다.
body
필수 사항
객체 저장 백업 작업을 위해 지정된 리전 에 비공개 엔드포인트를 생성합니다.
-
cloud 제공자 식별하는 사람이 읽을 수 있는 레이블입니다.
값은
AWS입니다. -
MongoDB Cloud가 AWS에서 호스팅되는 MongoDB cluster 노드를 배포하는 물리적 위치 . 선택하는 리전 데이터베이스에 액세스하는 클라이언트의 네트워크 지연 시간 영향을 줄 수 있습니다. MongoDB Cloud는 전용 클러스터 배포할 때 해당 제공자 및 리전 에 대한 VPC 또는 VPC 연결이 존재하는지 확인합니다. 그렇지 않은 경우 MongoDB Cloud는 배포서버 의 일부로 생성합니다. MongoDB Cloud는 VPC 에 CIDR 차단 할당합니다. 새 VPC 피어링 연결을 하나의 CIDR 차단 및 리전 으로 제한하려면 먼저 연결을 생성합니다. 연결이 시작된 후 클러스터 배포합니다.
값은
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_1또는GLOBAL.
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"
}