1개의 글로벌 클러스터에 1개의 사용자 지정 영역 매핑 추가
더 이상 사용되지 않습니다.
지정된 글로벌 클러스터 에 대해 하나의 사용자 지정 구역 매핑을 만듭니다. 사용자 지정 구역 매핑은 하나의 ISO 3166-2 위치 코드를 글로벌 클러스터 의 구역 과 일치시킵니다. 기본값 으로 MongoDB Cloud는 각 위치 코드를 가장 가까운 지리적 구역 에 매핑합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}
경로 매개변수
-
프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다. -
이 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.
형식은
^[a-zA-Z0-9][a-zA-Z0-9-]*$패턴 과 일치해야 합니다.
쿼리 매개변수
-
애플리케이션이 응답을
envelopeJSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false입니다. -
응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
기본값은
false입니다.Prettyprint
body
필수 사항
지정된 글로벌 클러스터에 추가할 사용자 지정 영역 매핑.
-
영역을 지리적 리전에 매핑하기 위해 쉼표로 구분된 키 값 쌍이 포함된 목록입니다. 이러한 쌍은 ISO 3166-1a2 위치 코드(가능한 경우 ISO 3166-2 세분화 코드 포함)를 원하는 사용자 지정 영역의 사람이 읽을 수 있는 레이블에 매핑합니다. MongoDB 클라우드는 기본적으로 ISO 3166-1a2 코드를 가장 가까운 지리적 영역에 매핑합니다. 이 매개변수를 포함하면 기본 매핑을 재정의할 수 있습니다.
이 매개변수는 사용자 지정 영역이 없는 경우 빈 객체를 반환합니다.
글로벌 클러스터 의 하위 집합을 식별하는 사람이 읽을 수 있는 레이블입니다.
atlas api globalClusters createGroupClusterGlobalWriteCustomZoneMapping --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240530001/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.CreateGroupClusterGlobalWriteCustomZoneMappingApiParams{}
sdkResp, httpResp, err := client.GlobalClustersApi.
CreateGroupClusterGlobalWriteCustomZoneMappingWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \
-d '{ <Payload> }'{
"customZoneMappings": [
{
"location": "string",
"zone": "string"
}
]
}{
"customZoneMapping": {
"additionalProperty1": "32b6e34b3d91647abb20e7b8",
"additionalProperty2": "32b6e34b3d91647abb20e7b8"
},
"managedNamespaces": [
{
"collection": "string",
"customShardKey": "string",
"db": "string",
"isCustomShardKeyHashed": false,
"isShardKeyUnique": false,
"numInitialChunks": 42,
"presplitHashedZones": false
}
],
"selfManagedSharding": true
}{
"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"
}