1개의 프로젝트에 1개의 연합 데이터베이스 인스턴스 및 온라인 아카이브 비공개 엔드포인트 생성
지정된 프로젝트의 연합 데이터베이스 인스턴스 및 온라인 아카이브에 대한 프라이빗 엔드포인트 한 개를 추가합니다. Atlas Data Federation은 엔드포인트 ID가 이미 존재하고 관련 설명이 변경되지 않은 경우 엔드포인트 ID 목록을 변경하지 않습니다. Atlas Data Federation은 엔드포인트 ID가 이미 존재하고 관련 설명이 변경된 경우 엔드포인트 ID 목록에서만 설명 값을 업데이트합니다. Atlas Data Federation은 엔드포인트 ID가 존재하지 않는 경우 엔드포인트 ID 목록의 엔드포인트 목록에 새 엔드포인트를 추가합니다. 각 리전에는 각 리전의 다양한 엔드포인트에 대한 관련 서비스 이름이 있습니다.
us-east-1 은 com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4입니다.
us-west-1 은 com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb입니다.
eu-west-1 은 com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e입니다.
eu-west-2 은 com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9입니다.
eu-central-1 은 com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d입니다.
sa-east-1 은 com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044입니다.
ap-southeast-2 은 com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e입니다.
ap-south-1 은 com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d입니다.
이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 또는 프로젝트 차트 관리자 역할이 있어야 합니다.
경로 매개변수
-
프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다.
쿼리 매개변수
-
애플리케이션이 응답을
envelopeJSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false입니다. -
응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
기본값은
false입니다.Prettyprint
body
필수 사항
지정된 프로젝트에 추가할 연합 데이터베이스 인스턴스 및 온라인 아카이브에 대한 프라이빗 엔드포인트입니다.
-
Azure 비공개 엔드포인트 연결을 식별하는 링크 ID 입니다.
-
이 비공개 엔드포인트에 연결할 인간 판독 가능 문자열.
-
고객의 VPC 엔드포인트 DNS 이름을 식별하는 인간 가독형 레이블. 정의된 경우 리전 값도 지정해야 합니다.
-
Azure 비공개 엔드포인트에 연결하는 데 사용되는 IP 주소 입니다.
형식은
^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$패턴 과 일치해야 합니다. -
비공개 엔드포인트를 식별하는 고유한 22자 영숫자 문자열입니다.
형식은
^vpce-[0-9a-f]{17}$패턴 과 일치해야 합니다.Atlas Data Lake AWS PrivateLink 기능 사용하여 Amazon Web Services 비공개 엔드포인트 지원합니다. -
비공개 엔드포인트 요청 승인 실패를 설명하는 오류 메시지입니다.
-
클라우드 서비스 제공자를 식별하는 인간 판독 가능 레이블. Atlas Data Lake는 Amazon Web Services만 지원합니다.
값은
AWS입니다. 기본값은AWS입니다. -
고객의 VPC 엔드포인트 리전을 식별하기 위한 사람이 인간 가독형 레이블. 정의된 경우 customerEndpointDNSName 값도 지정해야 합니다.
-
비공개 엔드포인트 연결 요청 의 상태입니다.
값은
PENDING,OK,FAILED또는DELETING입니다. -
이 프라이빗 엔드포인트와 연결된 리소스 유형을 식별하는 인간 판독 가능 레이블.
값은
DATA_LAKE입니다. 기본값은DATA_LAKE입니다.
atlas api dataFederation createGroupPrivateNetworkSettingEndpointId --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.CreateGroupPrivateNetworkSettingEndpointIdApiParams{}
sdkResp, httpResp, err := client.DataFederationApi.
CreateGroupPrivateNetworkSettingEndpointIdWithParams(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}/privateNetworkSettings/endpointIds" \
-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}/privateNetworkSettings/endpointIds" \
-d '{ <Payload> }'{
"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}
],
"totalCount": 42
}{
"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"
}