정부 기관 API 용 MongoDB Atlas는 다음 기본 URL을 사용한다는 점을 제외하고 Atlas API 와 동일한 방식으로 작동합니다.
https://cloud.mongodbgov.com/api/atlas/v2
MongoDB Atlas for 정부 API 사용하여 클러스터를 관리 하려면 API 요청을 인증해야 합니다. MongoDB Atlas for Government API 는 다음 인증 방법을 허용합니다.
서비스 계정 액세스 토큰(OAuth 2.0)
API 키(HTTP 다이제스트 인증)
사용 예시
이 curl 예시 프로젝트 의 데이터베이스 사용자를 검색합니다. 원하는 인증 방법에 해당하는 탭 선택합니다.
서비스 계정을 사용하여 API 요청을 하려면 서비스 계정을 사용하여 액세스 토큰을 생성한 다음 요청에 액세스 토큰을 사용하세요.
서비스 계정의 클라이언트 비밀을 조회합니다.
서비스 계정을 생성한 직후 저장한 mdb_sa_sk_ 로 시작하는 클라이언트 시크릿을 찾습니다. 클라이언트 시크릿을 저장하지 않은 경우 새 클라이언트 시크릿을 생성해야 합니다.
액세스 토큰을 요청합니다.
중요
액세스 토큰은 1시간(3600초) 동안 유효합니다. 액세스 토큰은 새로 고칠 수 없습니다. 이 액세스 토큰이 만료되면 이 단계를 반복하여 새 토큰을 생성하세요.
다음 예시의 {BASE64-AUTH}를 이전 단계의 출력으로 바꾼 후 실행합니다.
1 curl --request POST \ 2 --url https://cloud.mongodbgov.com/api/oauth/token \ 3 --header 'accept: application/json' \ 4 --header 'cache-control: no-cache' \ 5 --header 'authorization: Basic {BASE64-AUTH}' \ 6 --header 'content-type: application/x-www-form-urlencoded' \ 7 --data 'grant_type=client_credentials'
{"access_token":"eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6ImYyZjE2YmE4LTkwYjUtNDRlZS1iMWYwLTRkNWE2OTllYzVhNyJ9.eyJpc3MiOiJodHRwczovL2Nsb3VkLWRldi5tb25nb2RiLmNvbSIsImF1ZCI6ImFwaTovL2FkbWluIiwic3ViIjoibWRiX3NhX2lkXzY2MjgxYmM2MDNhNzFhNDMwYjkwNmVmNyIsImNpZCI6Im1kYl9zYV9pZF82NjI4MWJjNjAzYTcxYTQzMGI5MDZlZjciLCJhY3RvcklkIjoibWRiX3NhX2lkXzY2MjgxYmM2MDNhNzFhNDMwYjkwNmVmNyIsImlhdCI6MTcxMzkwNTM1OSwiZXhwIjoxNzEzOTA4OTU5LCJqdGkiOiI4ZTg1MTM3YS0wZGU1LTQ0N2YtYTA0OS1hMmVmNTIwZGJhNTIifQ.AZSFvhcjwVcJYmvW6E_K5UnDmeiX2sJgL27vo5ElzeBuPawRciKkn6ervZ6IpUTx2HHllGgAAMmhaP9B66NywhfjAXC697X9KcOzm81DTtvDjLrFeRSc_3vFmeGvfUKKXljEdWBnbmwCwtBlO5SJuBxb1V5swAl-Sbq9Ymo4NbyepSnF","expires_in":3600,"token_type":"Bearer"}%
API 호출을 실행합니다.
다음 예시의 {ACCESS-TOKEN}을 이전 단계의 출력으로 바꿉니다.
다음 샘플 GET 요청은 조직의 모든 프로젝트를 반환합니다.
curl --request GET \ --url https://cloudgov.mongodb.com/api/atlas/v2/groups \ --header 'Authorization: Bearer {ACCESS-TOKEN}' \ --header 'Accept: application/vnd.atlas.2023-02-01+json' \ --header 'Content-Type: application/json'
다음 샘플 POST 요청은 요청 본문을 사용하여 조직에 MyProject라는 이름의 프로젝트를 생성합니다.
curl --header 'Authorization: Bearer {ACCESS-TOKEN}' \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ --include \ --request POST "https://cloudgov.mongodb.com/api/atlas/v2/groups" \ --data ' { "name": "MyProject", "orgId": "5a0a1e7e0f2912c554080adc" }'
API 키를 사용하여 API 요청 수행하려면 {PUBLIC-KEY}:{PRIVATE-KEY} 를 API 키로 바꾸고 실행.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2025-03-12+json" \ # update date to desired API version --include \ --request GET "https://cloud.mongodbgov.com/api/atlas/v2/groups/{PROJECT-ID}/databaseUsers?pretty=true"
Project Settings 에서
PROJECT-ID을 찾을 수 있습니다.조직의 Access Manager API Keys 탭 아래에서 API 키 쌍을 생성할 수 있습니다.
Atlas 문서 참조
API 사용에 대해 자세히 알아보려면 Atlas API를 참조하세요.
서비스 계정 또는 API 키로 API 를 인증하는 방법에 대해 자세히 학습하려면 Atlas 관리 API 인증 방법을 참조하세요.
API를 구성하려면 Atlas API 액세스 구성을 참조하세요.
가능한 오류 목록은 Atlas API 오류 코드를 참조하세요.
프로젝트 만들기
프로젝트 생성 시 표준 또는 정부(gov) 리전 사용에 대한 프로젝트를 지정해야 합니다. 동일한 프로젝트에서 정부 및 표준 리전에 클러스터를 배포할 수 없습니다.
기본적으로 AtlasGov API는 표준 리전 사용에 대한 새 프로젝트를 지정합니다.
API를 사용하여 정부 리전을 위한 프로젝트를 생성하려면 POST 요청 데이터에 다음을 포함하세요.
"regionUsageRestrictions" : "GOV_REGIONS_ONLY"
Atlas for Government 고려 사항
다음 cloud 공급자, MongoDB 제품 및 기능은 모든 API 리소스에서 사용할 수 없습니다.
Azure
Atlas Online Archives
Atlas 트리거
MongoDB 차트
Atlas Device SDK
무료, Flex 및
M10클러스터
많은 상용 Atlas API 리소스가 제한되거나 사용할 수 없습니다.
데이터베이스 사용자
SCRAM 으로 인증하는 데이터베이스 사용자는 SCRAM-SHA-256 를 사용해야 합니다.
클러스터
AtlasGov 클러스터는 계층 M20 이상이어야 합니다. Atlas 무료 및 Flex 클러스터를 지원 하지 않습니다.
알림
결제 수단과 관련된 경고는 사용할 수 없습니다.
경고는 여러 개의 서로 다른 이메일 주소에서 발송될 수 있습니다. 자세한 내용은 경고 및 커뮤니케이션을 참조하세요.
타사 통합 설정
타사 모니터링 통합을 구성하려면 Project Owner 역할이 있어야 합니다.
Datadog
AtlasGov는 Datadog과 통합될 경우 Datadog for Government 사이트(US1-FED)를 사용합니다.
US1-FED에 대해 자세히 학습하려면 DataDog 문서를 참조하세요.
클라우드 백업
표준 프로젝트와 Gov 리전 전용 프로젝트 간의 복원은 허용되지 않습니다. Gov 리전 전용(Amazon Web Services GovCloud 또는 GCP Assuring Workloads) 프로젝트 의 클러스터 에서 백업 을 생성한 경우, 데이터는 Gov 리전 전용 프로젝트 의 클러스터 로만 복원할 수 있습니다. 표준 리전의 백업을 표준 프로젝트의 클러스터로만 복원할 수 있는 표준 프로젝트에도 동일한 제한 사항이 적용됩니다.
Amazon Web Services GovCloud와 GCP Assured Workloads 리전 간에 클라우드 간 복원 이 지원됩니다.
Flex 클러스터 스냅샷 및 복원 작업
AtlasGov에서는 Flex 클러스터를 사용할 수 없습니다.
온라인 아카이브
AtlasGov에서는 Online Archive를 사용할 수 없습니다.
네트워크 피어링
Amazon Web Services Services GovCloud 리전의 MongoDB 클러스터와만 Amazon Web Services GovCloud 리전을 피어링할 수 있습니다. Amazon Web Services Commercial 리전의 MongoDB cluster와 Amazon Web Services Commercial 리전만 피어링할 수 있습니다.
GCP 보장 워크로드 리전의 MongoDB 클러스터와만 GCP 보장 워크로드 리전을 피어링할 수 있습니다.
비공개 엔드포인트
Amazon Web Services GovCloud 리전은 Amazon Web Services GovCloud 리전의 MongoDB 클러스터와만 연결할 수 있습니다. Amazon Web Services Commercial 리전은 Amazon Web Services Commercial 리전의 MongoDB cluster와만 연결할 수 있습니다.
GCP Assuring Workloads 리전은 GCP Assuring Workloads 리전의 MongoDB cluster와만 연결할 수 있습니다.
모니터링 및 로그
표준 Atlas 로깅 외에도 AtlasGov는 모든 로그인 시도 실패, 임시 잠금 및 API 다이제스트 인증 실패와 관련된 사용자 이름 및 IP 주소를 기록합니다.
고객 키 관리를 사용한 미사용 암호화
Amazon Web Services Services GovCloud 및 GCP Assuring Workloads 리전 전용 프로젝트의 데이터를 암호화하려면 Amazon Web Services GovCloud 및 GCP Assuring Workloads 리전에서 KMS 키를 사용해야 합니다. Amazon Web Services Commercial 리전 전용 프로젝트의 데이터를 암호화하려면 Amazon Web Services Commercial 리전의 KMS 키를 사용해야 합니다.
Atlas 사용자
정부 기관 사용자를 위한 MongoDB Atlas는 만들 수 없습니다. MongoDB Atlas for Government는 초대를 통해서만 사용할 수 있습니다.
Atlas Stream Processing
AtlasGov에서는 Atlas Stream Processing을 사용할 수 없습니다.
트리거
AtlasGov에서는 Atlas Triggers를 사용할 수 없습니다.