중요
각 Atlas 관리 API에는 고유한 리소스가 있으며 초기 설정이 필요합니다.
공용 인터넷을 통해서만 Atlas 관리 API 서버에 액세스 할 수 있습니다.네트워크 피어링 또는 비공개 엔드포인트 사용하는 연결에서는 Atlas 관리 API 사용할 수 없습니다.
자세히 보려면 Atlas Programmatic Access참조합니다.
Atlas 관리 API는 REST 아키텍처 스타일의 원칙을 따라 Atlas의 관리 기능에 프로그래밍 방식으로 액세스할 수 있도록 여러 내부 리소스를 노출합니다. Atlas 관리 API 에 대해 자세히 학습하려면 Atlas 관리 API 참조를 참조하세요.
Atlas 관리 API 클러스터에 저장된 데이터에 대한 액세스 제공하지 않습니다. 데이터베이스 의 데이터를 읽거나 쓰기 (write) 적절한 읽기 또는 쓰기 (write) 역할이 있는 데이터베이스 사용자의 자격 증명 사용하여 클러스터 를 인증해야 합니다. Atlas 관리 API 사용하여 데이터베이스 사용자를 생성하고 관리 수 있습니다.
Atlas 관리 API 사용하여 Atlas 클러스터를 관리 하려면 다음 인증 방법 중 하나를 사용하여 API 요청을 인증해야 합니다.
서비스 계정 액세스 토큰(OAuth.) 20
API 키(HTTP 다이제스트 인증)
이러한 방법에 대해 학습하려면 Atlas 관리 API 인증 방법을 참조하세요.
다음 섹션에서는 서비스 계정과 API 키를 사용하여 Atlas 조직 및 프로젝트에 대한 프로그래밍 방식의 액세스 구성하는 방법을 설명합니다.
참고
MongoDB Atlas 공동 책임 모델은 안전하고 복원력이 뛰어난 데이터 환경을 유지 관리하는 데 있어 MongoDB 와 MongoDB 고객의 보완 의무를 정의합니다. 이 프레임워크 에서 MongoDB 기본 플랫폼의 보안 및 운영 무결성을 관리하고 고객은 특정 배포의 구성, 관리 및 데이터 정책을 책임집니다. 보안 및 운영 우수성에 대한 소유권에 대한 자세한 분석은 공유 책임 모델을 참조하세요.
시작하기 전에
프로그래밍 액세스를 구성하기 전에 다음을 확인하세요.
Atlas 계정이 있습니다. 계정을 생성하려면 Atlas 계정 생성을 참조하세요.
Atlas 조직이 존재합니다. 하나를 만들려면 조직 만들기를 참조하세요.
필요한 액세스 권한
조직 에 대한 서비스 계정 또는 API 키를 생성하려면 해당 조직 에 대한 Organization Owner 액세스 있어야 합니다.
서비스 계정에 프로젝트에 대한 액세스 부여하려면 프로젝트 소유한 조직에 대해 Organization Owner 액세스 있어야 합니다.
API 키에 프로젝트 에 대한 액세스 부여하려면 해당 프로젝트 에 대한 Project Owner 액세스 있어야 합니다.
선택 사항: IP 액세스 목록 필요
Atlas UI 사용하여 조직 만들 때 Atlas Atlas 관리 API 대한 IP 액세스 목록 필요합니다. 이렇게 하면 API 요청이 IP 액세스 목록 에 지정한 위치 기반 IP 또는 CIDR 주소의 요청으로 제한됩니다. IP 액세스 목록 항목 없이 Atlas 관리 API 에 요청 하면 서버 403 상태 코드로 응답합니다.
이 기능 비활성화하면 IP 액세스 목록 비어 있는 한 인터넷의 모든 주소 에서 API 요청할 수 있습니다. IP 액세스 목록 항목을 추가하면 해당 IP 주소 에서 시작된 요청만 요청할 수 있습니다.
참고
참고
IP 액세스 목록은 프로그래매틱 API 키 및 서비스 계정에만 적용 . Atlas CLI 또는 Atlas 앱 연결을 통해 부여된 위임된 액세스 와 같은 Atlas 관리 API 에 대한 다른 유형의 액세스 에는 적용 않습니다. 위임된 액세스 에는 타사 제휴하다 애플리케이션, MongoDB Compass 와 같은 MongoDB 애플리케이션 및 MCP(Model Context Protocol) 클라이언트가 포함됩니다. 조직 모든 Atlas 관리 API 트래픽이 특정 주소에서 발생하도록 요구하는 경우 해당 조직 에 대해 위임된 앱 액세스 활성화 하지 마세요. 제휴하다 애플리케이션 및 MCP 클라이언트에 대한 위임된 액세스 설정은 기존 조직에서 기본값 으로 해제되어 있습니다.
조직을 만든 후 모든 Atlas Administration API 요청에 대해 IP 액세스 목록이 필요하도록 조직을 설정하려면 다음 단계를 따르세요.
Atlas 에서 Organization Settings 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
사이드바에서 Organization Settings를 클릭합니다.
조직 설정 페이지가 표시됩니다.
조직에 프로그래밍 방식 액세스 권한 부여
프로젝트에 프로그래밍 방식 액세스 권한 부여
이 두 가지 인증 방법에 대해 자세히 학습하려면 Atlas 관리 API 인증 방법을 참조하세요.
API 키에 프로젝트 에 대한 액세스 부여하려면 해당 프로젝트 에 대한 Project Access Manager 또는 Project Owner 액세스 있어야 합니다.
프로젝트에서 프로젝트 액세스 추가
조직 에 대한 서비스 계정 또는 API 키를 아직 만들지 않은 경우 프로젝트 에 대해 서비스 계정 또는 API 키를 만들어 해당 프로젝트 에 Atlas 관리 API 에 대한 액세스 부여할 수 있습니다. 프로젝트 에 대해 생성한 서비스 계정 또는 API 키는 Organization Member 권한이 있는 상위 조직 에 자동으로 추가됩니다.
API 요청하기
Atlas Administration API는 서비스 계정 또는 API 키라는 두 가지 인증 방법 중 하나를 사용하여 요청을 인증합니다. 다음 절차를 완료하려면 기본 인증 방법을 구성할 때 저장한 키나 시크릿이 필요합니다.
모든 Atlas Administration API의 기본 URL은 다음과 같습니다.
https://cloud.mongodb.com/api/atlas/<version>
중요
MongoDB는 HTTPS URL을 사용하여 보안을 강화합니다. HTTP URL을 사용하면 301 상태 코드가 반환됩니다.
또는 OpenAPI v3 사양을 지원하는 도구를 사용하여 코드 샘플 또는 모의 서버를 생성할 수 있습니다. 예시 를 들어,Atlas 관리자 API 사양을 Postman으로 가져와서 curl 명령을 생성할 수 있습니다.
경고
Postman에서 HTTP URL을 사용하면 예상대로 301 상태 코드가 반환됩니다. 그러나 이 시나리오의 경우 Postman은 요청을 HTTPS로 자동 재시도하는 동시에 재시도 요청에서 헤더와 본문을 제거할 수 있습니다. 그러면 301 대신 401 상태 코드가 반환되어 요청이 실패한 이유를 파악하기 어려워집니다.
Postman을 사용하여 curl 명령을 생성하려면 다음을 수행하세요.
MongoDB Atlas 관리 API 문서의 탐색 모음에서 Download source를 클릭합니다.
다음 단계
Atlas 관리 API에 대해 자세히 알아보려면 Atlas 관리 API 참고 자료를 확인하세요.
Atlas 관리 API에 대한 프로그래밍 방식의 액세스를 관리하려면 다음 절차 중 하나를 참조하세요.