리전화된 비공개 엔드포인트 상태 토글
프로젝트 한 개에서 모든 클라우드 서비스 제공자가 리전별로 비공개 엔드포인트를 여러 개 생성하는 기능을 활성화하거나 비활성화합니다. 클라우드 서비스 제공자가 프로젝트의 비공개 엔드포인트를 관리합니다. 이 설정을 활성화하면 기존 멀티 리전 및 글로벌 샤딩된 클러스터에 대한 연결 문자열이 변경됩니다. 새 연결 문자열을 사용하려면 애플리케이션을 업데이트해야 합니다. 이로 인해 다운타임이 발생할 수 있습니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할이 있어야 하며 배포 환경의 모든 클러스터가 샤딩된 클러스터여야 합니다. 활성화하면 복제본 세트를 생성할 수 없습니다.
경로 매개변수
-
프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다.
쿼리 매개변수
-
애플리케이션이 응답을
envelopeJSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false입니다. -
응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
기본값은
false입니다.Prettyprint
body
필수 사항
프로젝트 한 개에서 모든 클라우드 서비스 제공자가 리전별로 비공개 엔드포인트를 여러 개 생성하는 기능을 활성화하거나 비활성화합니다.
-
누군가가 지정된 프로젝트에 대해 리전화된 비공개 엔드포인트 설정을 활성화했는지 여부를 나타내는 플래그입니다.
리전화된 비공개 엔드포인트를 활성화하려면 이 값을
true(으)로 설정합니다. 이렇게 하면 클라우드 공급자 리전에 비공개 엔드포인트를 두 개 이상 생성할 수 있습니다. 멀티 리전 및 글로벌 MongoDB Cloud 샤딩된 클러스터에 연결하려면 이 설정을 활성화해야 합니다. 리전화된 비공개 엔드포인트를 활성화하면 다음과 같은 제한 사항이 발생합니다.- 애플리케이션은 기존 멀티 리전 및 글로벌 샤딩된 클러스터에 대해 새 연결 문자열을 사용해야 합니다. 이로 인해 다운타임이 발생할 수 있습니다.
- MongoDB Cloud 프로젝트에는 복제본 세트가 포함될 수 없으며 이 프로젝트에서 새 복제본 세트를 생성할 수도 없습니다.
- 다음의 경우 비활성화할 수 없습니다.
- 리전 두 곳 이상에 있는 비공개 엔드포인트 두 개 이상
- 한 리전에 두 개 이상의 비공개 엔드포인트와 하나 이상의 리전에 있는 하나의 비공개 엔드포인트.
리전화된 비공개 엔드포인트를 비활성화하려면 이 값을
false(으)로 설정합니다.
atlas api privateEndpointServices toggleGroupPrivateEndpointRegionalMode --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.ToggleGroupPrivateEndpointRegionalModeApiParams{}
sdkResp, httpResp, err := client.PrivateEndpointServicesApi.
ToggleGroupPrivateEndpointRegionalModeWithParams(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 PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \
-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 PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \
-d '{ <Payload> }'{
"enabled": true
}{
"enabled": true
}{
"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"
}