Atlas Administration API 시작하기

Atlas에 프로그래밍 방식 액세스 권한 부여

API만 사용하여 조직이나 프로젝트에 프로그래밍 방식의 액세스 권한을 부여하려면 API 키를 생성합니다.

• API 키는 공개 키와 비공개 키라는 두 부분으로 구성됩니다. 이 두 부분은 Atlas에 API 요청을 할 때 사용자 이름 및 개인 API 키와 동일한 기능을 수행합니다.

• API 키를 사용하여 사용자 인터페이스를 통해 Atlas에 로그인할 수는 없습니다.

• API 키가 오류 없이 API 엔드포인트를 호출할 수 있도록 하려면 사용자에게 하는 것처럼 API 키에 역할을 부여해야 합니다.

• 모든 API 키는 조직에 속합니다. API 키에 프로젝트에 대한 액세스 권한을 부여할 수 있습니다. 프로젝트에 새 API 키를 추가하려면 프로젝트에 조직 API 키를 초대합니다.

• 각 API 키는 하나의 조직에만 속하지만, 해당 조직의 프로젝트 수에 상관없이 API 키에 액세스 권한을 부여할 수 있습니다.

선택 사항은 다음과 같습니다. Atlas Administration API에 대한 IP 액세스 목록이 필요합니다.

Atlas는 Atlas Administration API에 대한 IP 액세스 목록이 필요하지 않는 경우 Atlas Administration API 키가 인터넷의 모든 주소에서 요청할 수 있도록 허용합니다. IP 액세스 목록이 필요한 경우 API 키는 IP 액세스 목록에 지정한 위치 기반 IP 또는 CIDR 주소에서만 API를 요청할 수 있습니다.

각 API 키에는 고유한 IP 액세스 목록이 있습니다. 모든 Atlas Administration API 요청에 대해 IP 액세스 목록이 필요한 경우, API 키를 사용하기 전에 API 키에 대한 IP 액세스 목록 항목을 하나 이상 정의해야 합니다.

Atlas UI를 사용하여 새 조직을 만들면 Atlas는 기본적으로 API 액세스 목록 요구 사항을 사용하도록 설정합니다. 조직을 만들 때 IP 액세스 목록 요구 사항을 비활성화하려면 Require IP Access List for the Atlas Administration API를 OFF로 전환하세요.

조직을 만든 후 모든 Atlas Administration API 키에 대해 IP 액세스 목록이 필요하도록 조직을 설정하려면 다음 단계를 따르세요.

조직에 프로그래밍 방식 액세스 권한 부여

다음과 같은 절차를 사용하여 조직에 프로그래밍 방식의 액세스 권한을 부여합니다. 자세히 보려면 Manage Programmatic Access to an Organization참조합니다.

프로젝트에 프로그래밍 방식 액세스 권한 부여

다음과 같은 절차를 사용하여 프로젝트에 프로그래밍 방식의 액세스 권한을 부여합니다. 자세히 보려면 Manage Programmatic Access to a Project참조합니다.

API 요청하기

Atlas 관리 API는 HTTP 다이제스트 인증 을 사용하여 요청을 인증합니다. HTTP 요청을 구성할 때 사용자 이름 및 비밀번호로 프로그래밍 방식 API 공개 키와 해당 비공개 키를 제공해야 합니다. Atlas 프로젝트에 대한 API 액세스를 구성하는 방법을 알아보려면 Atlas 에 프로그래밍 방식 액세스 권한 부여를 참조하세요.

모든 Atlas Administration API의 기본 URL은 다음과 같습니다.

https://cloud.mongodb.com/api/atlas/<version>

API 요청 예시

요청은 다음 예제와 유사해야 하며, 여기서 {PUBLIC-KEY}는 API 퍼블릭 키이고 {PRIVATE-KEY}는 해당 프라이빗 키입니다.

다음 샘플 GET 요청은 조직의 모든 프로젝트를 반환합니다 .

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
      --header "Content-Type: application/json" \
      --header "Accept: application/vnd.atlas.2023-02-01+json" \
      --include \
      --request GET "https://cloud.mongodb.com/api/atlas/v2/groups"

다음 샘플 POST 요청은 요청 본문을 가져와서 조직에 MyProject 라는 프로젝트를 만듭니다 .

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
      --header "Content-Type: application/json" \
      --header "Accept: application/vnd.atlas.2023-02-01+json" \
      --include \
      --request POST "https://cloud.mongodb.com/api/atlas/v2/groups" \
      --data '
         {
            "name": "MyProject",
            "orgId": "5a0a1e7e0f2912c554080adc"
         }'

또는 OpenAPI v3 사양 을 지원하는 모든 도구를 사용할 수 있습니다. 코드 샘플 또는 모의 서버를 생성합니다.예를 들어 Atlas 관리자 API 사양 을 Postman 으로 가져올 수 curl 있습니다. 명령을 생성합니다. Postman을 사용하여 curl 명령을 생성하려면 다음을 수행합니다.

다음 단계

Atlas 관리 API에 대해 자세히 알아보려면 Atlas 관리 API 참고 자료를 확인하세요.

Atlas 관리 API에 대한 프로그래밍 방식의 액세스를 관리하려면 다음 절차 중 하나를 참조하세요.

• 조직에 대한 프로그래밍 방식의 접근을 관리합니다.

• 여러 조직에 대한 프로그래밍 방식의 액세스를 관리합니다.

• 프로젝트에 대한 프로그래밍 방식의 접근을 관리합니다.