MongoDB Atlas 관리자 API 2.0
  • 2023-11-15(최신)
  • 2023-10-01
  • 2023-02-01
  • 2023-01-01
Redocly의 API 문서

MongoDB Atlas 관리자 API (2.0)

리소스 버전 2023-11-15

OpenAPI 사양 다운로드: 다운로드

라이센스: CC BY-NC-SA 3.0 US 과

MongoDB Atlas 관리자 API를 사용하면 개발자가 MongoDB Atlas의 모든 구성 요소를 관리할 수 있습니다.

Atlas 관리자 API는 HTTP 다이제스트 인증을 사용하여 요청을 인증합니다. HTTP 요청을 구성할 때 프로그래밍 방식 API 공개 키와 해당 비공개 키를 사용자 이름 및 비밀번호로 제공합니다. 예를 들어, cURL을 사용하여 데이터베이스 액세스 기록을 반환하려면 터미널에서 다음 명령을 실행합니다.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true"

자세한 내용은 Atlas 관리자 API 시작하기를 참조하세요. 지원을 받으려면 MongoDB 지원을 참조하세요.

액세스 추적

Atlas 데이터베이스 배포를 위해 인증 시도에 대한 액세스 로그를 반환합니다. 데이터베이스 액세스 기록을 보려면 프로젝트 소유자 또는 조직 소유자 역할이 있어야 합니다.

클러스터 이름을 사용하여 한 클러스터에 대한 데이터베이스 액세스 기록 반환

클러스터 이름으로 식별되는 1개 클러스터의 액세스 로그를 반환합니다. 액세스 로그에는 클러스터에 대해 이루어진 인증 요청 목록이 포함되어 있습니다. 테넌트 계층 클러스터(M0, M2, M5)에서는 이 기능을 사용할 수 없습니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 모니터링 관리자 역할이 있어야 합니다.

데이터베이스 액세스 기록
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

authResult
부울

응답이 성공적인 인증 시도만 반환하는지 여부를 나타내는 플래그입니다.

end
integer <int64>

데이터베이스 기록 검색을 중지할 날짜 및 시간입니다. 끝을 지정하는 경우 시작도 지정해야 합니다. 이 매개변수는 유닉스 시간(밀리초)을 사용합니다.

ipAddress
문자열^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

데이터베이스 인증을 시도한 1개 인터넷 프로토콜 주소입니다.

nLogs
integer <int32> [ 0 .. 20000 ]
기본값입니다: 20000

반환할 로그의 최대 줄 수입니다.

시작하기
integer <int64>

MongoDB 클라우드가 데이터베이스 기록을 조회하기 시작하는 날짜 및 시간입니다. 시작을 지정하는 경우 끝도 지정해야 합니다. 이 매개변수는 유닉스 시간(밀리초)을 사용합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "accessLogs": [
    ]
}

호스트 이름을 사용하여 한 클러스터에 대한 데이터베이스 액세스 기록 반환

클러스터의 호스트 이름으로 식별되는 한 클러스터의 액세스 로그를 반환합니다. 액세스 로그에는 클러스터에 대한 인증 요청 목록이 포함되어 있습니다. 테넌트 계층 클러스터(M0, M2, M5)에서는 이 기능을 사용할 수 없습니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 모니터링 관리자 역할이 있어야 합니다.

데이터베이스 액세스 기록
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

호스트 이름
필수
문자열

다운로드하려는 로그 파일을 저장하는 MongoDB 호스트의 정규화된 도메인 이름 또는 IP 주소입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

authResult
부울

응답이 성공적인 인증 시도만 반환하는지 여부를 나타내는 플래그입니다.

end
integer <int64>

데이터베이스 기록 검색을 중지할 날짜 및 시간입니다. 끝을 지정하는 경우 시작도 지정해야 합니다. 이 매개변수는 유닉스 시간(밀리초)을 사용합니다.

ipAddress
문자열^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

데이터베이스 인증을 시도한 1개 인터넷 프로토콜 주소입니다.

nLogs
integer <int32> [ 0 .. 20000 ]
기본값입니다: 20000

반환할 로그의 최대 줄 수입니다.

시작하기
integer <int64>

MongoDB 클라우드가 데이터베이스 기록을 조회하기 시작하는 날짜 및 시간입니다. 시작을 지정하는 경우 끝도 지정해야 합니다. 이 매개변수는 유닉스 시간(밀리초)을 사용합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "accessLogs": [
    ]
}

알림 구성

경고를 트리거하는 조건과 MongoDB 클라우드가 사용자에게 경고를 보내는 방법을 반환하고 편집합니다. 이 컬렉션은 계속 수정되며 변경될 수 있습니다.

모든 알림 구성 매처 필드 이름 가져오기

경고 구성을 만들거나 업데이트할 때 matchers.fieldName 매개변수가 허용하는 모든 필드 이름을 가져옵니다. 할당된 모든 역할로 이 엔드포인트를 성공적으로 호출할 수 있습니다.

권한 부여
DigestAuth
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • "APPLICATION_ID"
]

1개 프로젝트에 대한 모든 경고 구성 반환

1개 프로젝트에 대한 모든 경고 구성을 반환합니다. 이러한 경고 구성은 프로젝트의 모든 구성 요소에 적용됩니다. 경고 구성은 경고에 대한 트리거 및 경고 메서드를 정의합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 프로젝트에서 1개의 경고 구성 만들기

지정된 프로젝트에 대해 1개 경고 구성을 만듭니다. 경고 구성은 경고에 대한 트리거 및 경고 메서드를 정의합니다. 이 리소스를 사용하려면 요청 API 키에 조직 소유자 또는 프로젝트 소유자 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 대해 1개 경고 구성을 만듭니다.

다음 중 하나
enabled
부울
기본값입니다: 거짓

누군가가 지정된 프로젝트에 대해 이 경고 구성을 활성화했는지 여부를 나타내는 플래그입니다.

필수
청구 이벤트 유형(객체) 또는 Cps 백업 이벤트 유형(객체) 또는 FTS 인덱스 감사 유형(객체) 또는 그룹 이벤트 유형(객체) 또는 NDS 감사 유형(객체) 또는 NDS 유지 관리 기간 감사 유형(객체) 또는 온라인 아카이브 이벤트 유형 (객체) 또는 사용자 이벤트 유형(객체) 또는 리소스 이벤트 유형(객체) 또는 스트림 프로세서 이벤트 유형(객체)

이 경고를 트리거한 인시던트입니다.

필수
의 배열 Datadog 알림(객체) 또는 이메일 알림(객체) 또는 그룹 알림(객체) 또는 HipChat 알림(객체) 또는 Microsoft Teams 알림(객체) 또는 OpsGenie 알림(객체) 또는 조직 알림(객체) 또는 PagerDuty 알림(객체) 또는 Slack 알림(객체) 또는 SMS 알림(객체) 또는 팀 알림(객체) 또는 사용자 알림(객체) 또는 VictorOps 알림(객체) 또는 웹훅 알림(객체) (AlertsNotificationRootForGroup)

MongoDB 클라우드가 알림을 보내는 대상이 포함된 목록입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "notifications": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "updated": "2019-08-24T14:15:22Z"
}

1개 프로젝트에서 1개 경고 구성 제거

지정된 프로젝트에서 1개 경고 구성을 제거합니다. 이 리소스를 사용하려면 요청 API 키에 조직 소유자 또는 프로젝트 소유자 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

alertConfigId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

경고 구성을 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스할 수 있는 모든 경고 구성을 조회하려면 /alertConfigs 엔드포인트를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "reason": "Unauthorized"
}

1개 프로젝트에서 1개 경고 구성 반환

지정된 프로젝트에서 지정된 경고 구성을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

alertConfigId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

경고 구성을 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스할 수 있는 모든 경고 구성을 조회하려면 /alertConfigs 엔드포인트를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "updated": "2019-08-24T14:15:22Z"
}

1개의 프로젝트에서 1개 상태인 1개의 경고 구성 토글

지정된 프로젝트에서 지정된 경고 구성을 활성화하거나 비활성화합니다. 현재 활성화된 경우 리소스는 지정된 경고 구성을 활성화합니다. 현재 비활성화된 경우 리소스는 지정된 경고 구성을 비활성화합니다. 이 리소스를 사용하려면 요청 API 키에 조직 소유자 또는 프로젝트 소유자 역할이 있어야 합니다.

참고: 이 엔드포인트는 경고 구성에 대한 활성화/비활성화 상태만 업데이트합니다. 이 구성보다 더 많은 구성을 업데이트하려면 경고 구성 업데이트를 참조하세요.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

alertConfigId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

이 경고를 트리거한 경고 구성을 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스할 수 있는 모든 경고 구성을 조회하려면 /alertConfigs 엔드포인트를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에서 지정된 경고 구성을 활성화하거나 비활성화합니다.

enabled
부울

지정된 프로젝트에서 지정된 경고 구성을 활성화 또는 비활성화할지 여부를 나타내는 플래그입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "updated": "2019-08-24T14:15:22Z"
}

1개의 프로젝트에 대해 1개의 경고 구성 업데이트

지정된 프로젝트에서 1개 경고 구성을 업데이트합니다. 경고 구성은 경고에 대한 트리거 및 경고 메서드를 정의합니다. 이 리소스를 사용하려면 요청 API 키에 조직 소유자 또는 프로젝트 소유자 역할이 있어야 합니다.

참고: 경고 구성을 활성화 또는 비활성화하려면 1개의 프로젝트에서 1개의 상태인 경고 구성 토글을 참조하세요.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

alertConfigId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

경고 구성을 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스할 수 있는 모든 경고 구성을 조회하려면 /alertConfigs 엔드포인트를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에서 1개 경고 구성을 업데이트합니다.

다음 중 하나
enabled
부울
기본값입니다: 거짓

누군가가 지정된 프로젝트에 대해 이 경고 구성을 활성화했는지 여부를 나타내는 플래그입니다.

필수
청구 이벤트 유형(객체) 또는 Cps 백업 이벤트 유형(객체) 또는 FTS 인덱스 감사 유형(객체) 또는 그룹 이벤트 유형(객체) 또는 NDS 감사 유형(객체) 또는 NDS 유지 관리 기간 감사 유형(객체) 또는 온라인 아카이브 이벤트 유형 (객체) 또는 사용자 이벤트 유형(객체) 또는 리소스 이벤트 유형(객체) 또는 스트림 프로세서 이벤트 유형(객체)

이 경고를 트리거한 인시던트입니다.

필수
의 배열 Datadog 알림(객체) 또는 이메일 알림(객체) 또는 그룹 알림(객체) 또는 HipChat 알림(객체) 또는 Microsoft Teams 알림(객체) 또는 OpsGenie 알림(객체) 또는 조직 알림(객체) 또는 PagerDuty 알림(객체) 또는 Slack 알림(객체) 또는 SMS 알림(객체) 또는 팀 알림(객체) 또는 사용자 알림(객체) 또는 VictorOps 알림(객체) 또는 웹훅 알림(객체) (AlertsNotificationRootForGroup)

MongoDB 클라우드가 알림을 보내는 대상이 포함된 목록입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "notifications": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "matchers": [
    ],
  • "notifications": [
    ],
  • "updated": "2019-08-24T14:15:22Z"
}

1개 경고에 설정된 모든 경고 구성 반환

지정된 경고에 대해 설정된 모든 경고 구성을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

alertId
필수
문자열 = 24자 ^([a-f0-9]{24})$

경고를 식별하는 고유한 24자리 16진수 문자열입니다. /alert 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 경고를 조회할 수 있습니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

알림

사용자가 정의한 경고 조건을 기반으로 MongoDB 클라우드가 트리거하는 경고를 반환하고 확인합니다. 이 컬렉션은 계속 수정되며 변경될 수 있습니다.

경고 구성을 위해 열려 있는 모든 경고 반환

지정된 경고 구성이 트리거하는 열려 있는 모든 경고를 반환합니다. 이러한 경고 구성은 지정된 프로젝트에만 적용됩니다. 경고 구성은 경고에 대한 트리거 및 경고 메서드를 정의합니다. 열려 있는 경고가 트리거되었지만 승인되지 않은 상태로 유지됩니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

alertConfigId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

경고 구성을 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스할 수 있는 모든 경고 구성을 조회하려면 /alertConfigs 엔드포인트를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 프로젝트에서 모든 경고 반환

모든 경고를 반환합니다. 이러한 경고는 1개 프로젝트의 모든 구성 요소에 적용됩니다. 모니터링되는 구성 요소가 설정한 값을 충족하거나 초과하면 경고를 받습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

상태
문자열
열거형: "OPEN" "TRACKING" "CLOSED"

반환할 경고의 상태입니다. 모든 상태의 모든 경고를 반환하려면 생략합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 프로젝트에서 1개의 경고 반환

1개 경고를 반환합니다. 이 경고는 1개 프로젝트의 모든 구성 요소에 적용됩니다. 모니터링되는 구성 요소가 설정한 값을 충족하거나 초과하면 경고를 받습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

alertId
필수
문자열 = 24자 ^([a-f0-9]{24})$

경고를 식별하는 고유한 24자리 16진수 문자열입니다. /alert 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 경고를 조회할 수 있습니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
  • "acknowledgingUsername": "user@example.com",
  • "alertConfigId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "DEPLOYMENT_FAILURE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastNotified": "2019-08-24T14:15:22Z",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "resolved": "2019-08-24T14:15:22Z",
  • "status": "OPEN",
  • "updated": "2019-08-24T14:15:22Z"
}

1개의 프로젝트에서 1개의 경고 승인

1개 기존 경고 수신을 확인합니다. 이 경고는 1개 프로젝트의 모든 구성 요소에 적용됩니다. 경고를 수락하면 연속적인 경고를 방지할 수 있습니다. 모니터링되는 구성 요소가 사용자가 설정한 값을 충족하거나 초과하면 경고를 확인할 때까지 경고를 받게 됩니다. 이 리소스를 사용하려면 요청 API 키에 조직 소유자 또는 프로젝트 소유자 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

alertId
필수
문자열 = 24자 ^([a-f0-9]{24})$

경고를 식별하는 고유한 24자리 16진수 문자열입니다. /alert 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 경고를 조회할 수 있습니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

1개 경고를 확인합니다.

다음 중 하나
acknowledgedUntil
필수
문자열 <date-time>

이 경고가 승인될 때까지의 날짜 및 시간입니다. 이 매개변수는 ISO 8601 타임스탬프 형식(UTC)으로 값을 표현합니다. MongoDB 사용자가 이전에 이 경고를 확인한 경우 리소스는 이 매개변수를 반환합니다.

  • 이 경고를 영구적으로 승인하려면 매개변수 값을 100년 후로 설정합니다.

  • 이전에 확인된 경고를 승인 취소하려면 매개변수 값을 과거 날짜로 설정합니다.

acknowledgementComment
문자열 <= 200 characters

MongoDB 클라우드 사용자가 경고를 승인할 때 제출한 코멘트입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "Expiration on 3/19. Silencing for 7days."
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "Expiration on 3/19. Silencing for 7days.",
  • "acknowledgingUsername": "user@example.com",
  • "alertConfigId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "DEPLOYMENT_FAILURE",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastNotified": "2019-08-24T14:15:22Z",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "resolved": "2019-08-24T14:15:22Z",
  • "status": "OPEN",
  • "updated": "2019-08-24T14:15:22Z"
}

1개의 Atlas Search 인덱스 만들기

지정된 컬렉션에 1개의 Atlas Search 인덱스를 만듭니다. Atlas Search 인덱스는 인덱스를 생성할 필드와 인덱스를 생성할 때 사용할 분석기를 정의합니다. MongoDB v4.2 이상을 실행하는 클러스터만 Atlas Search를 사용할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 데이터 액세스 관리자 역할이 있어야 합니다.

Atlas search 인덱스
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

Atlas Search 인덱스를 생성할 컬렉션이 포함된 클러스터의 이름입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 컬렉션에 1개의 Atlas Search 인덱스를 만듭니다.

collectionName
필수
문자열

1개 이상의 Atlas Search 인덱스가 포함된 컬렉션을 식별하는 사람이 읽을 수 있는 라벨입니다.

데이터베이스
필수
문자열

1개 이상의 Atlas Search 인덱스가 포함된 데이터베이스를 식별하는 사람이 읽을 수 있는 라벨입니다.

이름
필수
문자열

이 인덱스를 식별하는 사람이 읽을 수 있는 라벨입니다. 각 네임스페이스 내에서 네임스페이스에 있는 모든 인덱스의 이름은 고유해야 합니다.

유형
문자열

인덱스의 유형입니다. 기본 유형은 검색입니다.

분석기
문자열
기본값입니다: "lucene.standard"
열거형: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

데이터베이스 필드 텍스트를 검색 가능한 단어로 변환하기 위해 선택한 사전 정의된 특정 방법입니다. 이 변환은 필드의 텍스트를 가장 작은 텍스트 단위로 줄입니다. 이러한 단위를 텀(term) 또는 토큰이라고 합니다. 토큰화라고 하는 이 프로세스에는 필드의 텍스트에 대한 다양한 변경이 포함됩니다.

  • 단어 추출
  • 문장 부호 제거
  • 악센트 제거
  • 소문자로 변경
  • 일반적인 단어 제거
  • 단어를 어근 형태로 줄이기(어간)
  • 단어를 기본 형식으로 변경 (표집화) MongoDB Cloud는 선택한 프로세스를 사용하여 Atlas Search 인덱스를 작성합니다.
Atlas Search 분석기
의 배열 개체 (분석기)

데이터베이스 필드 텍스트를 검색 가능한 단어로 변환하는 사용자 정의 메서드 목록입니다.

사용자 지정 Atlas Search 분석기
객체 (매핑)

컬렉션의 필드에 대한 인덱스 사양입니다.

검색 분석기
문자열
기본값입니다: "lucene.standard"
열거형: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

이 인덱스를 검색할 때 단어를 식별하는 데 적용되는 메서드입니다.

storedSource
객체

Atlas Search에 모든 필드를 저장할지(참) 여부를 나타내는 플래그입니다. 기본적으로 Atlas는 Atlas Search에 필드를 저장하지 않습니다(거짓). 또는 Atlas Search에 저장(포함)하거나 저장하지 않을(제외) 필드 목록만 포함하는 객체를 지정할 수 있습니다. 자세한 내용은 설명서를 참조하세요.

저장된 소스 필드
의 배열 개체 (동의어 매핑 정의)

이 인덱스에서 단어를 동의어에 매핑하는 규칙 집합입니다.

동의어 매핑

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "status": "IN_PROGRESS",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

1개의 컬렉션에 대해 모든 Atlas Search 인덱스 반환

지정된 컬렉션의 모든 Atlas Search 인덱스를 반환합니다. Atlas Search 인덱스에는 인덱싱된 필드와 인덱스를 만드는 데 사용된 분석기가 포함되어 있습니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 데이터 액세스 읽기 쓰기 역할이 있어야 합니다.

Atlas search 인덱스
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

하나 이상의 Atlas Search 인덱스가 있는 컬렉션을 포함하는 클러스터의 이름입니다.

collectionName
필수
문자열

하나 이상의 Atlas Search 인덱스가 포함된 컬렉션의 이름입니다.

databaseName
필수
문자열

1개 이상의 Atlas Search 인덱스가 포함된 데이터베이스를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1개의 Atlas Search 인덱스 제거

고유 ID로 식별한 하나의 Atlas Search 인덱스를 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 데이터 액세스 관리자 역할이 있어야 합니다.

Atlas search 인덱스
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

하나 이상의 애플리케이션 검색 인덱스가 있는 데이터베이스 및 컬렉션을 포함하는 클러스터의 이름입니다.

indexId
필수
문자열 = 24자 ^([a-f0-9]{24})$

Atlas cluster를 식별하는 고유한 24자리 16진수 문자열입니다. 컬렉션에 대한 모든 Atlas Search 인덱스 가져오기 API 엔드포인트를 사용하여 모든 Atlas Search 인덱스의 ID를 찾을 수 있습니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 Atlas Search 인덱스 반환

지정된 프로젝트에서 하나의 Atlas Search 인덱스를 반환합니다. 고유 ID를 사용하여 이 인덱스를 식별합니다. Atlas Search 인덱스에는 인덱싱된 필드와 인덱스를 만드는 데 사용된 분석기가 포함되어 있습니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 데이터 액세스 읽기 쓰기 역할이 있어야 합니다.

Atlas search 인덱스
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

하나 이상의 Atlas Search 인덱스가 있는 컬렉션을 포함하는 클러스터의 이름입니다.

indexId
필수
문자열 = 24자 ^([a-f0-9]{24})$

Application Search 인덱스를 식별하는 고유한 24진수 문자열입니다. 컬렉션에 대한 모든 애플리케이션 검색 인덱스 가져오기 API 엔드포인트를 사용하여 모든 애플리케이션 검색 인덱스의 ID를 찾을 수 있습니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "status": "IN_PROGRESS",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

1개의 Atlas Search 인덱스 업데이트

고유 ID로 식별한 하나의 Atlas Search 인덱스를 업데이트합니다. Atlas Search 인덱스는 인덱스를 생성할 필드와 인덱스 생성 시 사용할 분석기를 정의합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 데이터 액세스 관리자 역할이 있어야 합니다.

Atlas search 인덱스
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

Atlas Search 인덱스를 업데이트할 컬렉션이 포함된 클러스터의 이름입니다.

indexId
필수
문자열 = 24자 ^([a-f0-9]{24})$

아틀라스 검색 인덱스를 식별하는 고유한 24자리 16진수 문자열입니다. 컬렉션에 대한 모든 Atlas Search 인덱스 가져오기 API 엔드포인트를 사용하여 모든 Atlas Search 인덱스의 ID를 찾을 수 있습니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

Atlas Search 인덱스에 대한 업데이트 세부정보입니다.

collectionName
필수
문자열

1개 이상의 Atlas Search 인덱스가 포함된 컬렉션을 식별하는 사람이 읽을 수 있는 라벨입니다.

데이터베이스
필수
문자열

1개 이상의 Atlas Search 인덱스가 포함된 데이터베이스를 식별하는 사람이 읽을 수 있는 라벨입니다.

이름
필수
문자열

이 인덱스를 식별하는 사람이 읽을 수 있는 라벨입니다. 각 네임스페이스 내에서 네임스페이스에 있는 모든 인덱스의 이름은 고유해야 합니다.

유형
문자열

인덱스의 유형입니다. 기본 유형은 검색입니다.

분석기
문자열
기본값입니다: "lucene.standard"
열거형: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

데이터베이스 필드 텍스트를 검색 가능한 단어로 변환하기 위해 선택한 사전 정의된 특정 방법입니다. 이 변환은 필드의 텍스트를 가장 작은 텍스트 단위로 줄입니다. 이러한 단위를 텀(term) 또는 토큰이라고 합니다. 토큰화라고 하는 이 프로세스에는 필드의 텍스트에 대한 다양한 변경이 포함됩니다.

  • 단어 추출
  • 문장 부호 제거
  • 악센트 제거
  • 소문자로 변경
  • 일반적인 단어 제거
  • 단어를 어근 형태로 줄이기(어간)
  • 단어를 기본 형식으로 변경 (표집화) MongoDB Cloud는 선택한 프로세스를 사용하여 Atlas Search 인덱스를 작성합니다.
Atlas Search 분석기
의 배열 개체 (분석기)

데이터베이스 필드 텍스트를 검색 가능한 단어로 변환하는 사용자 정의 메서드 목록입니다.

사용자 지정 Atlas Search 분석기
객체 (매핑)

컬렉션의 필드에 대한 인덱스 사양입니다.

검색 분석기
문자열
기본값입니다: "lucene.standard"
열거형: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

이 인덱스를 검색할 때 단어를 식별하는 데 적용되는 메서드입니다.

storedSource
객체

Atlas Search에 모든 필드를 저장할지(참) 여부를 나타내는 플래그입니다. 기본적으로 Atlas는 Atlas Search에 필드를 저장하지 않습니다(거짓). 또는 Atlas Search에 저장(포함)하거나 저장하지 않을(제외) 필드 목록만 포함하는 객체를 지정할 수 있습니다. 자세한 내용은 설명서를 참조하세요.

저장된 소스 필드
의 배열 개체 (동의어 매핑 정의)

이 인덱스에서 단어를 동의어에 매핑하는 규칙 집합입니다.

동의어 매핑

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "collectionName": "string",
  • "database": "string",
  • "name": "string",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "status": "IN_PROGRESS",
  • "type": "search",
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "mappings": {
    },
  • "searchAnalyzer": "lucene.standard",
  • "storedSource": {
    },
  • "synonyms": [
    ]
}

검색 노드 삭제

지정된 클러스터에 대한 검색 노드를 삭제합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

삭제할 클러스터를 식별하는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

검색 노드 반환

지정된 클러스터에 대한 검색 노드를 반환합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

검색 노드를 반환할 클러스터를 식별하는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "specs": [
    ],
  • "stateName": "IDLE"
}

검색 노드 업데이트

지정된 클러스터에 대한 검색 노드를 업데이트합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

검색 노드를 업데이트할 클러스터를 식별하는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 클러스터에 대한 검색 노드를 업데이트합니다.

필수
의 배열 개체 (ApiSearchDeploymentSpecView) = 1개 항목

클러스터에 대한 검색 노드를 구성하는 설정 목록입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "specs": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "specs": [
    ],
  • "stateName": "IDLE"
}

검색 노드 만들기

지정된 클러스터에 대한 검색 노드를 생성합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

검색 노드를 만들 클러스터를 식별하는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 클러스터에 대한 검색 노드를 생성합니다.

필수
의 배열 개체 (ApiSearchDeploymentSpecView) = 1개 항목

클러스터에 대한 검색 노드를 구성하는 설정 목록입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "specs": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "specs": [
    ],
  • "stateName": "IDLE"
}

Auditing

MongoDB 클라우드 프로젝트에 대한 데이터베이스 감사 설정을 반환하고 편집합니다.

1개의 프로젝트에 대해 감사 구성 반환

지정된 프로젝트에 대한 감사 구성을 반환합니다. 감사 구성은 MongoDB Cloud가 감사 로그에 기록하는 이벤트를 정의합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 이 기능은 M0, M2, M5 또는 서버리스 클러스터에서는 사용할 수 없습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "configurationType": "NONE",
  • "enabled": false
}

1개의 프로젝트에 대해 감사 구성 업데이트

지정된 프로젝트에 대한 감사 구성을 업데이트합니다. 감사 구성은 MongoDB Cloud가 감사 로그에 기록하는 이벤트를 정의합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 이 기능은 M0, M2, M5 또는 서버리스 클러스터에서는 사용할 수 없습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 대한 감사 구성이 업데이트되었습니다.

auditAuthorizationSuccess
부울
기본값입니다: 거짓

성공적인 인증을 추적하기 위해 누군가 감사를 설정했는지 여부를 나타내는 플래그입니다. 이는 "atype" : "authCheck" 감사 필터에만 적용됩니다. 이 매개 변수를 true 로 설정하면 클러스터 성능이 저하됩니다.

시스템 감사 메시지
auditFilter
문자열

기록할 이벤트를 지정하는 JSON 문서입니다. 작은 따옴표나 큰 따옴표와 같이 구문 분석을 방해할 수 있는 모든 문자는 백슬래시 (\) 를 사용하여 이스케이프 처리합니다.

사용자 지정 감사 필터
enabled
부울
기본값입니다: 거짓

누군가가 지정된 프로젝트에 대해 데이터베이스 감사를 활성화했는지 여부를 나타내는 플래그입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "enabled": false
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "configurationType": "NONE",
  • "enabled": false
}

AWS 클러스터 DNS

AWS의 MongoDB Cloud 데이터베이스 배포에 적용되는 사용자 지정 DNS 구성을 반환하고 편집합니다. 이 리소스에는 프로젝트 ID가 필요합니다. AWS에서 VPC 피어링을 사용하면서 Amazon Route 53 대신 자체 DNS 서버를 사용하는 경우 사용자 지정 DNS를 사용 설정하세요. 2020년 3월 31일 이전에는 사용자 지정 DNS 서비스를 사용하여 AWS 내에 배포된 애플리케이션과 MongoDB Cloud와 VPC 피어링된 애플리케이션은 비공개 IP 주소를 통해 연결할 수 없었습니다. 공개 IP 주소로 확인된 사용자 지정 DNS. 비공개 IP 주소로 확인된 AWS 내부 DNS. AWS에서 사용자 지정 DNS 서비스와 함께 배포된 애플리케이션은 피어링 연결 문자열에 비공개 IP를 사용해야 합니다.

AWS의 Atlas 클러스터에 대해 1개의 사용자 지정 DNS 구성 반환

지정된 프로젝트의 AWS 클러스터 사용자 정의 DNS 구성을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

AWS의 Atlas 클러스터에 대해 1개의 사용자 지정 DNS 구성 상태 토글

지정된 프로젝트의 AWS 클러스터 사용자 정의 DNS 구성을 사용 설정하거나 사용 중지합니다. AWS VPC 피어링을 사용하고 자체 DNS 서버를 사용하는 경우 사용자 지정 DNS를 활성화합니다. 이 리소스를 사용하려면 요청하는 API Key에 Project Atlas 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트의 AWS 클러스터 사용자 정의 DNS 구성을 사용 설정하거나 사용 중지합니다.

enabled
필수
부울

AWS(Amazon Web Services)에 배포된 프로젝트의 클러스터의 사용자 지정 DNS(도메인 이름 시스템) 사용 여부를 나타내는 플래그. "enabled": true일 경우 피어링 연결 문자열에 개인 IP를 사용하여 클러스터에 연결합니다.

자세히 알아보려면 MongoDB Atlas 설명서의 FAQ: 연결 문자열 옵션을 참조하세요.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

클라우드 백업

클라우드 백업 스냅샷, 스냅샷 내보내기 버킷, 복원 작업, 일정을 관리합니다. 이 리소스는 클라우드 백업을 사용하는 클러스터에만 적용됩니다.

클라우드 백업 스냅샷 내보내기에 사용되는 모든 AWS S3 버킷 반환

지정된 프로젝트와 연결된 모든 AWS S3 버킷을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

클라우드 백업 스냅샷 내보내기를 위한 AWS S3 버킷에 대한 액세스 권한 부여

지정된 AWS S3 버킷에 대한 MongoDB 클라우드 액세스 권한을 부여합니다. 이렇게 하면 이 버킷이 Atlas Cloud 백업 스냅샷을 받을 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 AWS S3 버킷에 대한 MongoDB 클라우드 액세스 권한을 부여합니다.

bucketName
문자열

역할에 액세스 권한이 부여된 AWS 버킷을 식별하는 사람이 읽을 수 있는 레이블입니다.

cloudProviders
문자열
열거형: "A" "AZURE" "GCP"

이 스냅샷을 저장하는 클라우드 제공업체를 식별하는 사람이 읽을 수 있는 레이블입니다.

iamRoleId
문자열 = 24자 ^([a-f0-9]{24})$

MongoDB Cloud가 AWS S3 버킷에 액세스하는 데 사용하는 통합 AWS 액세스 역할 ID를 식별하는 고유한 24자리 16진수 문자열입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "bucketName": "string",
  • "cloudProvider": "AWS",
  • "iamRoleId": "32b6e34b3d91647abb20e7b8"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "bucketName": "string",
  • "cloudProvider": "AWS",
  • "iamRoleId": "32b6e34b3d91647abb20e7b8",
  • "links": []
}

클라우드 백업 스냅샷 내보내기를 위한 AWS S3 버킷에 대한 액세스 취소

지정된 AWS S3 버킷에 대한 MongoDB 클라우드 액세스를 취소합니다. 이렇게 하면 이 버킷이 Atlas Cloud 백업 스냅샷을 수신하지 못합니다. 액세스를 취소하기 전에 이 버킷으로 내보내는 이 프로젝트의 모든 클러스터에서 자동 내보내기를 비활성화해야 합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

exportBucketId
필수
문자열 [3 ... 63 ] 문자 ^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1,6...

스냅샷을 내보낼 AWS S3 버킷을 식별하는 고유 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

클라우드 백업 스냅샷 내보내기에 사용되는 1개의 AWS S3 버킷 반환

지정된 프로젝트와 연결된 하나의 AWS S3 버킷을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

exportBucketId
필수
문자열 [3 ... 63 ] 문자 ^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1,6...

스냅샷을 내보낼 AWS S3 버킷을 식별하는 고유 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "bucketName": "string",
  • "cloudProvider": "AWS",
  • "iamRoleId": "32b6e34b3d91647abb20e7b8",
  • "links": []
}

백업 컴플라이언스 정책 설정 반환

지정된 프로젝트의 백업 규정 준수 정책 설정을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 사용 중단된 버전: v2-{2023-01-01}

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-10-01+json
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ],
  • "state": "ACTIVE",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUser": "user@example.com"
}

백업 컴플라이언스 설정 업데이트 또는 활성화

지정된 프로젝트에 대한 백업 규정 준수 정책 설정을 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 사용 중단된 버전: v2-{2023-01-01}

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

overwriteBackupPolicies
부울
기본값입니다: true

비준수 백업 정책을 새 데이터 보호 설정으로 덮어쓸지 여부를 나타내는 플래그입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-10-01+json

새로운 백업 컴플라이언스 정책 설정.

authorizedEmail
필수
문자열 <email>

백업 컴플라이언스 정책 설정 업데이트 권한을 부여한 사용자의 이메일 주소.

authorizedUserFirstName
필수
문자열

백업 컴플라이언스 정책 설정 업데이트 권한을 부여한 사용자의 이름.

authorizedUserLastName
필수
문자열

백업 컴플라이언스 정책 설정 업데이트 권한을 부여한 사용자의 성.

copyProtectionEnabled
부울
기본값입니다: 거짓

추가 스냅샷 리전이 제거되더라도 클러스터 사용자가 다른 리전으로 복사된 백업을 삭제할 수 없도록 할지 여부를 나타내는 플래그. 지정하지 않으면 이 값에는 기본값 false가 사용됩니다.

encryptionAtRestEnabled
부울
기본값입니다: 거짓

백업 컴플라이언스 정책이 있는 모든 클러스터에 고객 키 관리를 사용한 저장 시 암호화가 필요한지 여부를 나타내는 플래그. 지정하지 않으면 이 값에는 기본값 false가 사용됩니다.

고객 키 관리를 사용한 미사용 암호화
객체 (BackupComplianceOnDemandPolicyItem)

온디맨드 정책에 대한 사양.

pitEnabled
부울
기본값입니다: 거짓

클러스터가 백업 컴플라이언스 정책과 함께 지속적 클라우드 백업을 사용하는지 여부를 나타내는 플래그. 지정하지 않으면 이 값에는 기본값 false가 사용됩니다.

지속적인 클라우드 백업
projectId
문자열 = 24자 ^([a-f0-9]{24})$

백업 컴플라이언스 정책에 대한 프로젝트를 식별하는 고유한 24자리 16진수 문자열.

restoreWindowDays
integer <int32>

백업 컴플라이언스 정책이 적용된 지속적 클라우드 백업으로 복원할 수 있는 이전 날짜 수. 0이 아닌 양의 정수를 지정해야 하며 최대 보존 기간은 시간당 보존 시간을 초과할 수 없습니다. 이 매개 변수는 백업 컴플라이언스 정책이 적용되는 지속적 클라우드 백업에만 적용됩니다.

의 배열 개체 (BackupComplianceScheduledPolicyItem)

예약된 하나의 정책에 대한 사양이 포함된 목록.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-10-01+json
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-10-01+json
{
  • "authorizedEmail": "user@example.com",
  • "authorizedUserFirstName": "string",
  • "authorizedUserLastName": "string",
  • "copyProtectionEnabled": false,
  • "encryptionAtRestEnabled": false,
  • "onDemandPolicyItem": {
    },
  • "pitEnabled": false,
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreWindowDays": 0,
  • "scheduledPolicyItems": [
    ],
  • "state": "ACTIVE",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "updatedUser": "user@example.com"
}

모든 클라우드 백업 스냅샷 내보내기 작업 반환

지정된 Atlas 클러스터와 연결된 모든 Cloud Backup 스냅샷 내보내기 작업을 반환합니다. 이 리소스를 사용하려면 요청하는 API Key에 Project Atlas 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 클라우드 백업 스냅샷 내보내기 작업 만들기

Cloud Backup을 사용하여 전용 Atlas 클러스터의 백업 스냅샷 하나를 AWS 버킷으로 내보냅니다. 이 리소스를 사용하려면 요청하는 API Key에 Project Atlas 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

생성할 Cloud Backup 스냅샷 내보내기 작업의 정보.

의 배열 개체 (BackupLabel)

내보내기 작업이 완료되면 MongoDB Cloud가 버킷에 업로드하는 메타데이터 파일에 추가할 사용자 지정 데이터를 나타내는 키-값 쌍 컬렉션.

exportBucketId
필수
문자열 = 24자 ^([a-f0-9]{24})$

MongoDB Cloud가 클라우드 백업 스냅샷을 내보내는 AWS 버킷을 식별을 위한 고유한 24자리 16진수 문자열.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

내보낼 Cloud Backup 스냅샷을 식별하는 고유한 24자리 16진수 문자열.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "customData": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "components": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customData": [
    ],
  • "deliveryUrl": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "exportStatus": {
    },
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "prefix": "string",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "Cancelled"
}

1개의 클라우드 백업 스냅샷 내보내기 작업 반환

지정된 Atlas 클러스터와 연결된 Cloud Backup 스냅샷 내보내기 작업 한 개를 반환합니다. 이 리소스를 사용하려면 요청하는 API Key에 Project Atlas 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

exportId
필수
문자열

스냅샷을 내보낼 AWS S3 버킷을 식별하는 고유 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "components": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customData": [
    ],
  • "deliveryUrl": [
    ],
  • "exportBucketId": "32b6e34b3d91647abb20e7b8",
  • "exportStatus": {
    },
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "prefix": "string",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "Cancelled"
}

1개의 클러스터에 대해 모든 복원 작업 반환

지정된 프로젝트에서 하나의 클러스터에 대한 모든 클라우드 백업 복원 작업을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

반환하려는 복원 작업이 포함된 클러스터를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 클러스터에서 1개의 스냅샷 복원

지정된 프로젝트에서 한 클러스터의 스냅샷 하나를 복원합니다. Atlas는 온디맨드 스냅샷을 즉시 생성하고 정기적으로 예약된 스냅샷을 생성합니다. 대기 중 또는 진행 중 상태의 온디맨드 스냅샷이 있는 경우 다른 스냅샷을 생성하기 전에 이전에 찍은 온디맨드 스냅샷의 처리가 완료될 때까지 기다리세요.

이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에서 한 클러스터의 스냅샷 하나를 복원합니다.

deliveryType
필수
문자열
열거형: "automated" "download" "pointInTime"

생성할 복원 작업을 분류하는 인간 판독 가능 레이블.

oplogInc
integer <int32> >= 1

이 스냅샷을 복원할 Oplog 작업 번호. 이 숫자는 Oplog 타임스탬프의 두 번째 부분을 나타냅니다. 리소스는 "deliveryType" : "pointInTime" 및 oplogTs가 0을 초과할 때 이 매개 변수를 반환합니다.

oplogTs
integer <int32> >= 1199145600

이 스냅샷을 복원할 날짜 및 시간입니다. 이 매개변수는 유닉스 시간 이후 경과된 시간(초)으로 이 타임스탬프를 표현합니다. 이 숫자는 Oplog 타임스탬프의 첫 번째 부분을 나타냅니다. 리소스는 "deliveryType" : "pointInTime" 및 oplogTs가 0을 초과할 때 이 매개 변수를 반환합니다.

pointInTimeUTCSeconds
integer <int32> >= 1199145600

MongoDB Cloud가 이 스냅샷을 복원한 날짜 및 시간입니다. 이 매개변수는 유닉스 시간 이후 경과된 시간(초)으로 이 타임스탬프를 표현합니다. 리소스는 "deliveryType" : "pointInTime" 및 pointInTimeUTCSeconds가 0을 초과할 때 이 매개 변수를 반환합니다.

snapshotId
문자열 = 24자 ^([a-f0-9]{24})$

스냅샷을 식별하는 고유한 24자리 16진수 문자열.

targetClusterName
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

복원 작업이 스냅샷을 복원하는 대상 클러스터를 식별하는 인간 판독 가능 레이블. 리소스는 "deliveryType": "automated"일 때 이 매개 변수를 반환합니다. automated 및 pointInTime 복원 유형에 필요합니다.

targetGroupId
문자열 = 24자 ^([a-f0-9]{24})$

지정된 targetClusterName에 대한 대상 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. automated 및 pointInTime 복원 유형에 필요합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "components": [
    ],
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8",
  • "timestamp": "2019-08-24T14:15:22Z"
}

1개의 클러스터에서 1개의 복원 작업 취소

지정된 프로젝트에서 하나의 클러스터의 클라우드 백업 복원 작업 하나를 취소합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

restoreJobId
필수
문자열 = 24자 ^([a-f0-9]{24})$

제거할 복원 작업을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 클러스터에서 1개의 복원 작업 반환

지정된 프로젝트에서 하나의 클러스터에 대한 클라우드 백업 복원 작업 하나를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

반환하려는 복원 작업이 포함된 클러스터를 식별하는 인간 판독 가능 레이블.

restoreJobId
필수
문자열 = 24자 ^([a-f0-9]{24})$

반환할 복원 작업을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "components": [
    ],
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8",
  • "timestamp": "2019-08-24T14:15:22Z"
}

모든 클라우드 백업 일정 제거

지정된 클러스터에 대한 모든 클라우드 백업 일정을 제거합니다. 이 일정은 MongoDB Cloud가 예약된 스냅샷을 생성하는 시기와 해당 스냅샷을 저장하는 기간을 정의합니다. 이 리소스를 사용하려면 요청하는 API Key에 Project Atlas 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "autoExportEnabled": true,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "copySettings": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "links": [],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "useOrgAndGroupNamesInExportPrefix": true
}

1개의 클라우드 백업 일정 반환

지정된 프로젝트 내의 지정된 클러스터에 대한 클라우드 백업 일정을 반환합니다. 이 일정은 MongoDB Cloud가 예약된 스냅샷을 생성하는 시기와 해당 스냅샷을 저장하는 기간을 정의합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "autoExportEnabled": true,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "copySettings": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "links": [],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "useOrgAndGroupNamesInExportPrefix": true
}

1개의 클러스터에 대해 클라우드 백업 일정 업데이트

지정된 프로젝트 내 하나의 클러스터에 대한 클라우드 백업 일정을 업데이트합니다. 이 일정은 MongoDB Cloud가 예약된 스냅샷을 생성하는 시기와 해당 스냅샷을 저장하는 기간을 정의합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트 내 하나의 클러스터에 대한 클라우드 백업 일정을 업데이트합니다.

참고: 요청 본문에는 업데이트하려는 필드만 제공하세요.

autoExportEnabled
부울

MongoDB Cloud가 클라우드 백업 스냅샷을 AWS 버킷으로 자동으로 내보낼지 여부를 나타내는 플래그.

의 배열 개체 (DiskBackupCopySetting)

원하는 백업 정책의 복사 설정 항목별 문서가 포함된 목록.

의 배열 개체 (DeleteCopiedBackups)

삭제하려는 백업 복사본의 삭제된 각 복사본 설정에 대한 문서가 포함된 목록.

객체 (export)

클라우드 백업 스냅샷을 자동으로 내보내기 위한 정책입니다.

의 배열 개체 (ExtraRetentionSetting)

원하는 백업 정책의 추가 보존 설정 항목별 문서가 포함된 목록.

의 배열 개체 (AdvancedDiskBackupSnapshotSchedulePolicy) 1개 이하의 항목

이 백업 일정에 설정된 규칙.

referenceHourOfDay
integer <int32>

MongoDB Cloud가 스냅샷을 생성하는 시점을 나타내는 협정 세계시(UTC)로 표시된 시간.

referenceMinuteOfHour
integer <int32>

MongoDB Cloud가 스냅샷을 생성하는 시간을 나타내는 referenceHourOfDay의 분.

restoreWindowDays
integer <int32>

지속적인 클라우드 백업의 정확성으로 다시 복원할 수 있는 이전 일수. '0'이 아닌 양의 정수를 지정해야 합니다. 이 매개 변수는 지속적인 클라우드 백업에만 적용됩니다.

updateSnapshots
부울

MongoDB Cloud가 이전에 생성한 스냅샷에 업데이트된 백업 정책의 보존 변경 사항을 적용할지 여부를 나타내는 플래그.

useOrgAndGroupNamesInExportPrefix
부울

MongoDB Cloud가 AWS 버킷에 업로드하는 메타데이터 파일 경로에 조직 및 프로젝트 UUID 대신 조직 및 프로젝트 이름을 사용할지 여부를 나타내는 플래그.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "autoExportEnabled": true,
  • "copySettings": [
    ],
  • "deleteCopiedBackups": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "updateSnapshots": true,
  • "useOrgAndGroupNamesInExportPrefix": true
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "autoExportEnabled": true,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "copySettings": [
    ],
  • "export": {
    },
  • "extraRetentionSettings": [
    ],
  • "links": [],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "useOrgAndGroupNamesInExportPrefix": true
}

모든 복제본 세트 클라우드 백업 반환

지정된 프로젝트에서 한 클러스터의 모든 스냅샷을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 온디맨드 스냅샷 생성

지정된 클러스터의 온디맨드 스냅샷을 하나 만듭니다. Atlas는 온디맨드 스냅샷을 즉시 생성하고 정기적으로 예약된 스냅샷을 생성합니다. 대기 중 또는 진행 중 상태의 온디맨드 스냅샷이 있는 경우 다른 스냅샷을 생성하기 전에 이전에 찍은 온디맨드 스냅샷의 처리가 완료될 때까지 기다리세요.

이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

온디맨드 스냅샷 한 개를 생성합니다.

description
문자열

스냅샷의 목적을 설명하는 인간 판독 가능 문구 또는 문장입니다. 리소스는 "status" : "onDemand"일 때 이 매개 변수를 반환합니다.

retentionInDays
integer <int32> >= 1

MongoDB Cloud가 주문형 스냅샷을 보관할 일수입니다. 1 이상이어야 합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "description": "string",
  • "retentionInDays": 1
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "cloudProvider": "AWS",
  • "copyRegions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "replicaSetName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "replicaSet"
}

1개의 샤드 클러스터 클라우드 백업 제거

지정된 프로젝트에서 한 샤드 클러스터의 스냅샷 하나를 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 샤드 클러스터 클라우드 백업 반환

지정된 프로젝트에서 한 샤드 클러스터의 스냅샷 하나를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "configServerType": "EMBEDDED",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "members": [
    ],
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "snapshotIds": [
    ],
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "replicaSet"
}

모든 샤드 클러스터 클라우드 백업 반환

지정된 프로젝트에서 하나의 샤드 클러스터의 모든 스냅샷을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 복제본 세트 클라우드 백업 제거

지정된 스냅샷을 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 복제본 세트 클라우드 백업 반환

지정된 클러스터에서 스냅샷 하나를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "cloudProvider": "AWS",
  • "copyRegions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "replicaSetName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "replicaSet"
}

1개의 클라우드 백업에 대해 만료일 변경

지정된 프로젝트의 한 클러스터에 대한 클라우드 백업 스냅샷 하나의 만료 날짜를 변경합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트의 한 클러스터에 대한 클라우드 백업 스냅샷 하나의 만료 날짜를 변경합니다.

retentionUnit
필수
문자열
열거형: "DAYS" "WEEKS" "MONTHS" "YEARS"

MongoDB Cloud가 스냅샷 보존을 측정하는 시간입니다.

retentionValue
필수
integer <int32>

MongoDB Cloud가 스냅샷을 보존하는 일, 주 월, 또는 년의 수를 나타내는 숫자. 사용 빈도가 낮은 정책 항목의 경우, MongoDB Cloud에서는 사용 빈도가 높은 정책 항목에 지정된 값 이상의 값을 지정해야 합니다. 시간별 정책 항목에서 2일간 보존하도록 지정한 경우 주간 정책 항목의 보존에 2일 이상을 지정하세요.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "retentionUnit": "DAYS",
  • "retentionValue": 5
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "cloudProvider": "AWS",
  • "copyRegions": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "replicaSetName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "replicaSet"
}

1개의 서버리스 인스턴스에 대해 모든 복원 작업 반환

지정된 프로젝트에서 하나의 서버리스 인스턴스에 대한 모든 복원 작업을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 서버리스 인스턴스에서 1개의 스냅샷 복원

지정된 프로젝트에서 하나의 서버리스 인스턴스의 스냅샷 하나를 복원합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

복원하려는 스냅샷이 있는 서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에서 하나의 서버리스 인스턴스의 스냅샷 하나를 복원합니다.

deliveryType
필수
문자열
열거형: "automated" "download" "pointInTime"

생성할 복원 작업을 분류하는 인간 판독 가능 레이블.

oplogInc
integer <int32> >= 1

이 스냅샷을 복원할 Oplog 작업 번호. 이 숫자는 Oplog 타임스탬프의 두 번째 부분을 나타냅니다. 리소스는 "deliveryType" : "pointInTime" 및 oplogTs가 0을 초과할 때 이 매개 변수를 반환합니다.

oplogTs
integer <int32> >= 1199145600

이 스냅샷을 복원할 날짜 및 시간입니다. 이 매개변수는 유닉스 시간 이후 경과된 시간(초)으로 이 타임스탬프를 표현합니다. 이 숫자는 Oplog 타임스탬프의 첫 번째 부분을 나타냅니다. 리소스는 "deliveryType" : "pointInTime" 및 oplogTs가 0을 초과할 때 이 매개 변수를 반환합니다.

pointInTimeUTCSeconds
integer <int32> >= 1199145600

MongoDB Cloud가 이 스냅샷을 복원한 날짜 및 시간입니다. 이 매개변수는 유닉스 시간 이후 경과된 시간(초)으로 이 타임스탬프를 표현합니다. 리소스는 "deliveryType" : "pointInTime" 및 pointInTimeUTCSeconds가 0을 초과할 때 이 매개 변수를 반환합니다.

snapshotId
문자열 = 24자 ^([a-f0-9]{24})$

스냅샷을 식별하는 고유한 24자리 16진수 문자열.

targetClusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

복원 작업이 스냅샷을 복원하는 대상 클러스터를 식별하는 인간 판독 가능 레이블. 리소스는 "deliveryType": "automated"일 때 이 매개 변수를 반환합니다.

targetGroupId
필수
문자열 = 24자 ^([a-f0-9]{24})$

지정된 targetClusterName에 대한 대상 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8",
  • "timestamp": "2019-08-24T14:15:22Z"
}

1개의 서버리스 인스턴스에 대해 1개의 복원 작업 반환

지정된 프로젝트에서 하나의 서버리스 인스턴스에 대한 복원 작업 하나를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

restoreJobId
필수
문자열 = 24자 ^([a-f0-9]{24})$

반환할 복원 작업을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "cancelled": true,
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": {
    },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetClusterName": "string",
  • "targetGroupId": "32b6e34b3d91647abb20e7b8",
  • "timestamp": "2019-08-24T14:15:22Z"
}

1개의 서버리스 인스턴스의 모든 스냅샷 반환

지정된 프로젝트에서 하나의 서버리스 인스턴스의 모든 스냅샷을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 서버리스 인스턴스에서 1개의 스냅샷 반환

지정된 프로젝트에서 하나의 서버리스 인스턴스의 스냅샷 하나를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongodVersion": "string",
  • "serverlessInstanceName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0
}

클라우드 마이그레이션 서비스

클라우드 마이그레이션 서비스를 관리합니다. 소스 조직, 프로젝트, MongoDB 클러스터는 Cloud Manager 또는 Ops Manager에 있습니다. 대상 조직, 프로젝트 및 MongoDB 클러스터는 MongoDB Cloud에 있습니다. 소스 데이터베이스는 SCRAM-SHA 외의 다른 인증은 사용할 수 없습니다.

1개의 로컬 관리형 클러스터를 MongoDB Atlas로 마이그레이션

Cloud 또는 Ops Manager가 관리하는 클러스터 하나를 MongoDB Atlas로 마이그레이션합니다.

마이그레이션을 시작하기 전에 반드시 마이그레이션을 검증하세요.

이 API 엔드포인트는 푸시 실시간 마이그레이션에만 사용할 수 있습니다. 이 리소스를 성공적으로 호출하려면 API 키에 조직 소유자 역할이 있어야 합니다.

참고: Time Series 컬렉션 마이그레이션은 현재 MongoDB 6.0 이상에서는 지원되지 않습니다. MongoDB 6.0 이상에서 마이그레이션을 수행하면 소스 클러스터의 모든 Time Series 컬렉션을 건너뜁니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

생성되는 마이그레이션 하나.

필수
객체 (Destination)

마이그레이션 대상을 설명하는 문서.

dropEnabled
필수
부울

마이그레이션이 시작되기 전에 마이그레이션 프로세스가 대상 클러스터에서 모든 컬렉션을 삭제하는지 여부를 나타내는 플래그.

migrationHosts
의 배열 strings = 1개 항목

이 마이그레이션에 사용된 마이그레이션 호스트 목록.

객체 (ShardingRequest)

MongoDB 6.0 이상에서 복제본 세트 소스에서 샤딩된 클러스터 대상으로 마이그레이션할 때 대상 클러스터에서 수행하는 샤딩을 구성하는 문서. 대상 클러스터의 컬렉션을 샤딩하지 않으려면 이 항목을 비워 두세요.

필수
객체 (Source)

마이그레이션의 출처를 설명하는 문서.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "destination": {
    },
  • "dropEnabled": true,
  • "migrationHosts": [
    ],
  • "sharding": {
    },
  • "source": {
    }
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": [
    ],
  • "readyForCutover": true,
  • "status": "NEW"
}

1개의 마이그레이션 요청 확인

제공된 자격 증명, 사용 가능한 디스크 공간, MongoDB 버전 등이 마이그레이션 요청의 요구 사항을 충족하는지 확인합니다. 검사를 통과하면 마이그레이션을 수행할 수 있습니다. 이 리소스를 성공적으로 호출하려면 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

검증되는 마이그레이션 하나.

필수
객체 (Destination)

마이그레이션 대상을 설명하는 문서.

dropEnabled
필수
부울

마이그레이션이 시작되기 전에 마이그레이션 프로세스가 대상 클러스터에서 모든 컬렉션을 삭제하는지 여부를 나타내는 플래그.

migrationHosts
의 배열 strings = 1개 항목

이 마이그레이션에 사용된 마이그레이션 호스트 목록.

객체 (ShardingRequest)

MongoDB 6.0 이상에서 복제본 세트 소스에서 샤딩된 클러스터 대상으로 마이그레이션할 때 대상 클러스터에서 수행하는 샤딩을 구성하는 문서. 대상 클러스터의 컬렉션을 샤딩하지 않으려면 이 항목을 비워 두세요.

필수
객체 (Source)

마이그레이션의 출처를 설명하는 문서.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "destination": {
    },
  • "dropEnabled": true,
  • "migrationHosts": [
    ],
  • "sharding": {
    },
  • "source": {
    }
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "errorMessage": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

1개의 마이그레이션 유효성 검사 작업 반환

마이그레이션 유효성 검사 작업 하나의 상태를 반환합니다. 이 리소스를 성공적으로 호출하려면 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

validationId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 507f1f77bcf86cd799439011

유효성 검사 작업을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "errorMessage": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

1개의 마이그레이션 작업 반환

하나의 클러스터 마이그레이션 작업에 대한 세부 정보를 반환합니다. 각 푸시 실시간 마이그레이션 작업은 하나의 마이그레이션 호스트를 사용합니다. 이 리소스를 성공적으로 호출하려면 API 키에 조직 구성원 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

liveMigrationId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 6296fb4c7c7aa997cf94e9a8

마이그레이션을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": [
    ],
  • "readyForCutover": true,
  • "status": "NEW"
}

마이그레이션된 클러스터 전환

마이그레이션된 클러스터를 MongoDB Atlas로 전환합니다. 전환이 완료되면 확인합니다. 전환이 완료되면 MongoDB Atlas가 실시간 마이그레이션 프로세스를 완료하고 소스 클러스터와의 동기화를 중지합니다. 이 리소스를 성공적으로 호출하려면 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

liveMigrationId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 6296fb4c7c7aa997cf94e9a8

마이그레이션을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

마이그레이션에 사용할 수 있는 모든 프로젝트 반환

지정된 조직으로 마이그레이션할 수 있는 모든 프로젝트를 반환합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1개의 링크 토큰 제거

하나의 조직 링크와 조직과 관련된 공개 API 키를 제거합니다. MongoDB Atlas는 푸시 실시간 마이그레이션에만 링크 토큰을 사용합니다. 실시간 마이그레이션(푸시)으로 Cloud Manager 또는 Ops Manager에서 MongoDB Atlas로 데이터를 안전하게 푸시할 수 있습니다. 이 리소스를 성공적으로 호출하려면 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 링크 토큰 만들기

링크를 완료하는 데 필요한 모든 정보가 포함된 하나의 링크 토큰을 만듭니다. MongoDB Atlas는 푸시 실시간 마이그레이션에만 링크 토큰을 사용합니다. 실시간 마이그레이션(푸시)으로 Cloud Manager 또는 Ops Manager에서 MongoDB Atlas로 데이터를 안전하게 푸시할 수 있습니다. 이 리소스를 성공적으로 호출하려면 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

마이그레이션과 관련된 IP 주소 액세스 목록 항목.

accessListIps
의 배열 strings

API 키와 연결된 IP 주소 액세스 목록 항목.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "accessListIps": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "linkToken": "string"
}

클라우드 공급자 액세스

Atlas에서 AWS IAM 역할을 반환, 추가, 권한 부여 및 제거합니다.

모든 클라우드 제공자 액세스 역할 반환

지정된 프로젝트에 대한 액세스 권한이 있는 모든 클라우드 공급자 액세스 역할을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "awsIamRoles": [
    ]
}

1개의 클라우드 제공자 액세스 역할 만들기

지정된 클라우드 공급자에 대해 하나의 액세스 역할을 생성합니다. 일부 MongoDB Cloud 기능에서는 인증 시 이러한 클라우드 제공자 액세스 역할을 사용합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

클라우드 제공자에 대한 액세스 설정
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 클라우드 공급자에 대해 하나의 역할을 생성합니다.

providerName
필수
문자열

역할의 클라우드 제공자를 식별하는 인간 판독 가능 레이블.

iamAssumedRoleArn
문자열 [20 ... 2048 ]자

MongoDB Cloud가 AWS 계정의 리소스에 액세스할 때 가정하는 AWS(Amazon Web Services) IAM(ID 및 액세스 관리) 역할을 식별하는 ARN(Amazon 리소스 이름).

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "providerName": "AWS",
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "providerName": "AWS",
  • "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
  • "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
  • "authorizedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "featureUsages": [
    ],
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
  • "roleId": "32b6e34b3d91647abb20e7b8"
}

1개의 클라우드 제공자 액세스 역할 인증 해제

지정된 액세스 역할에 지정된 프로젝트에 대한 액세스 권한을 취소합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

cloudProviders
필수
문자열
값: "A"

인증 해제할 역할의 클라우드 공급자를 식별하는 인간 판독 가능 레이블.

roleId
필수
문자열 = 24자 ^([a-f0-9]{24})$

역할을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

지정된 클라우드 제공자 액세스 역할 반환

지정된 ID와 지정된 프로젝트에 액세스 권한이 있는 액세스 역할을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

roleId
필수
문자열 = 24자 ^([a-f0-9]{24})$

역할을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "providerName": "AWS",
  • "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
  • "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
  • "authorizedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "featureUsages": [
    ],
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
  • "roleId": "32b6e34b3d91647abb20e7b8"
}

1개의 클라우드 제공자 액세스 역할에 권한 부여

지정된 액세스 역할에 지정된 프로젝트에 대한 액세스 권한을 부여합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 이 API 엔드포인트는 MongoDB Cloud 서비스에 대한 통합 액세스를 생성하는 절차의 한 단계입니다.

클라우드 제공자에 대한 액세스 설정
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

roleId
필수
문자열 = 24자 ^([a-f0-9]{24})$

역할을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 액세스 역할에 지정된 프로젝트에 대한 액세스 권한을 부여합니다.

providerName
필수
문자열

역할의 클라우드 제공자를 식별하는 인간 판독 가능 레이블.

iamAssumedRoleArn
문자열 [20 ... 2048 ]자

MongoDB Cloud가 AWS 계정의 리소스에 액세스할 때 가정하는 AWS(Amazon Web Services) IAM(ID 및 액세스 관리) 역할을 식별하는 ARN(Amazon 리소스 이름).

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "providerName": "AWS",
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "providerName": "AWS",
  • "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
  • "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
  • "authorizedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "featureUsages": [
    ],
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
  • "roleId": "32b6e34b3d91647abb20e7b8"
}

클러스터 중단 시뮬레이션

클러스터 중단 시뮬레이션을 반환, 시작 또는 종료합니다.

중단 시뮬레이션 종료

클러스터 중단 시뮬레이션을 종료합니다.

클러스터 중단 시뮬레이션
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

중단 시뮬레이션이 진행 중인 클러스터를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2022-01-01T00:00:00Z",
  • "state": "START_REQUESTED"
}

1개의 중단 시뮬레이션 반환

하나의 클러스터에 대한 중단 시뮬레이션을 하나 반환합니다.

클러스터 중단 시뮬레이션
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

중단 시뮬레이션이 진행 중인 클러스터를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2022-01-01T00:00:00Z",
  • "state": "START_REQUESTED"
}

중단 시뮬레이션 시작

클러스터 중단 시뮬레이션을 시작합니다.

클러스터 중단 시뮬레이션
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

중단 시뮬레이션을 진행할 클러스터를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

중단 시뮬레이션을 설명합니다.

의 배열 개체 (AtlasClusterOutageSimulationOutageFilter) 비어 있지 않음

클러스터 중단 시뮬레이션의 유형을 지정하는 설정 목록.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "outageFilters": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "outageFilters": [
    ],
  • "startRequestDate": "2022-01-01T00:00:00Z",
  • "state": "START_REQUESTED"
}

클러스터

데이터베이스 배포를 반환, 추가, 편집 및 제거합니다. 클러스터 구성을 변경하면 비용에 영향을 미칠 수 있습니다. 이 리소스를 사용하려면 프로젝트 ID가 필요합니다.

모든 프로젝트에서 모든 승인된 클러스터 반환

액세스 권한이 있는 모든 프로젝트 내 모든 클러스터의 세부 정보를 반환합니다. 클러스터에는 동일한 데이터 집합을 유지하는 호스트 그룹이 포함되어 있습니다. 응답에는 멀티클라우드 클러스터가 포함되지 않습니다. 이 리소스를 사용하려면 요청하는 API 키가 클러스터 수준의 역할을 가질 수 있습니다.

권한 부여
DigestAuth
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 프로젝트에서 모든 클러스터 반환 더 이상 사용되지 않음

액세스 권한이 있는 지정된 프로젝트 내 모든 클러스터의 세부 정보를 반환합니다. 클러스터에는 동일한 데이터 집합을 유지하는 호스트 그룹이 포함되어 있습니다. 응답에는 멀티클라우드 클러스터가 포함됩니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다. 이 기능은 서버리스 클러스터에서는 사용할 수 없습니다. 사용되지 않는 버전: v2-{2023-01-01}

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

includeDeletedWithRetainedBackups
부울
기본값입니다: 거짓

백업을 유지하면서 클러스터를 반환할지 여부를 나타내는 플래그.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 프로젝트에서 1개의 클러스터 생성 더 이상 사용되지 않음

지정된 프로젝트에 클러스터를 한 개 생성합니다. 클러스터에는 동일한 데이터 집합을 유지하는 호스트 그룹이 포함되어 있습니다. 이 리소스는 멀티 클라우드 클러스터를 생성할 수 있습니다. 각 프로젝트는 최대 25개의 데이터베이스 배포를 지원합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 이 기능은 서버리스 클러스터에서는 사용할 수 없습니다. 사용되지 않는 버전: v2-{2023-01-01}

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-02-01+json

지정된 프로젝트에서 생성할 클러스터.

acceptDataRisksAndForceReplicaSetReconfig
문자열 <date-time>

리전 중단으로 인해 프라이머리 토폴로지를 복구하기 위해 재구성이 필요한 경우 토폴로지 재구성과 함께 이 필드를 제출하여 새로운 리전 중단 방지 토폴로지를 요청하십시오. 투표 선택 가능 노드 대다수의 운영이 중단된 상태에서 강제 재구성을 수행하면 복제된 쓰기(대부분의 커밋된 쓰기 포함)가 새 프라이머리 노드에 복제되지 않은 경우 데이터가 손실될 위험이 있습니다. MongoDB Atlas 문서에서 더 많은 정보를 참조할 수 있습니다. 이러한 위험을 수반하는 작업을 계속 진행하려면 acceptDataRisksAndForceReplicaSetReconfig를 현재 날짜로 설정하세요.

리전 중단 시 복제본 세트 재구성하기
backupEnabled
부울
기본값입니다: 거짓

클러스터가 백업을 수행할 수 있는지 여부를 나타내는 플래그. true로 설정하면 클러스터가 백업을 수행할 수 있습니다. NVMe 클러스터의 경우 이 값을 true로 설정해야 합니다. 백업은 전용 클러스터에는 클라우드 백업을, 테넌트 클러스터에는 공유 클러스터 백업을 사용합니다. false로 설정하면 클러스터에서 백업을 사용하지 않습니다.

객체 (Business Intelligence 설정을 위한 MongoDB Connector)

이 클러스터에 대한 Business Intelligence용 MongoDB Connector를 구성하는 데 필요한 설정입니다.

MongoDB Connector for Business Intelligence
clusterType
문자열
열거형: "REPLICASET" "SHARDED" "GEOSHARDED"

클러스터를 구성하는 노드의 구성.

diskSizeGB
숫자 <double> [ 10 .. 4096 ]

기가바이트 단위로 표시한 호스트의 루트 볼륨의 스토리지 용량. 용량을 추가하려면 높은 수를 지정합니다. MongoDB Cloud는 replicationSpecs를 설정하는 경우 이 매개변수가 필요합니다. 디스크 크기를 최소값(10GB) 미만으로 지정하면 이 매개 변수는 기본값인 최소 디스크 크기 값으로 설정됩니다. 스토리지 요금은 기본값을 선택하는지, 아니면 사용자 지정 값을 선택하는지에 따라 다르게 계산됩니다. 디스크 스토리지의 최대값은 선택한 클러스터의 최대 RAM의 50배를 초과할 수 없습니다. 더 많은 저장 공간이 필요한 경우 클러스터를 더 높은 티어로 업그레이드하는 것이 좋습니다.

diskWarmingMode
문자열
기본값입니다: "FULLY_WARMED"
열거형: "FULLY_WARMED" "VISIBLE_EARLIER"

디스크 보온 모드 선택.

세컨더리 디스크 워밍(Warming) 영향 감소
encryptionAtRestProvider
문자열
열거형: "NONE" "A" "AZURE" "GCP"

클러스터에 추가 저장 시 암호화 계층을 제공하기 위해 고객 키를 관리하는 클라우드 서비스 공급자. 미사용 암호화를 위한 고객 키 관리를 사용하려면 클러스터 replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 설정을 M10 이상으로 지정하고 "backupEnabled" : false 또는 완전히 생략해야 합니다.

고객 키 관리를 사용한 미사용 암호화
globalClusterSelfManagedSharding
부울

새 글로벌 클러스터를 생성할 때 샤딩 관리 모드를 구성하려면 이 필드를 로 설정합니다.

false로 설정하면 관리 모드가 Atlas-Managed Sharding으로 설정됩니다. 이 모드는 글로벌 클러스터의 샤딩을 완전히 관리하며 원활한 배포 환경을 제공하도록 구축되었습니다.

true로 설정하면 관리 모드가 자체 관리형 샤딩으로 설정됩니다. 이 모드는 샤드 관리를 직접 수행하며 유연한 고급 배포 환경을 제공하도록 구축되었습니다.

클러스터가 배포된 후에는 이 설정을 변경할 수 없습니다.

글로벌 클러스터 생성
의 배열 개체 (컴포넌트 레이블)
더 이상 사용되지 않습니다.

클러스터에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍 컬렉션. MongoDB Cloud 콘솔에는 레이블이 표시되지 않습니다.

클러스터 레이블은 더 이상 사용되지 않으며 향후 릴리스에서 제거될 예정입니다. 대신 리소스 태그를 사용할 것을 적극 권장합니다.

mongoDBMajorVersion
문자열
기본값입니다: "7.0"
열거형: "4.2" "4.4" "5.0" "6.0" "7.0"

클러스터의 주요 MongoDB 버전입니다. MongoDB Cloud는 항상 지정된 버전의 안정적인 최신 릴리스가 설치된 클러스터를 배포합니다.

이름
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

고급 클러스터를 식별하는 인간 판독 가능 레이블.

paused
부울

클러스터의 일시 중지 여부를 나타내는 플래그.

pitEnabled
부울

클러스터의 지속적인 클라우드 백업 사용 여부를 나타내는 플래그.

지속적인 클라우드 백업
의 배열 개체 (복제 사양)

클러스터 리전을 구성하는 설정 목록. 글로벌 클러스터의 경우 배열의 각 개체는 클러스터 노드 배포 영역을 나타냅니다. 글로벌이 아닌 샤드 클러스터 및 복제본 세트의 경우 이 배열에는 클러스터 노드 배포 위치를 나타내는 객체가 하나 포함됩니다.

rootCertType
문자열
기본값입니다: "ISRGROOTX1"
값: "ISRGROOTX1"

MongoDB Cloud 클러스터가 사용하는 루트 인증 기관. MongoDB Cloud는 Internet Security Research 그룹을 지원합니다.

의 배열 개체 (Resource Tag)

클러스터에 태그를 지정하고 분류하기 위한 1~255자 길이의 키-값 쌍이 포함된 목록입니다.

리소스 태그
terminationProtectionEnabled
부울
기본값입니다: 거짓

클러스터의 종료 보호 활성화 여부를 나타내는 플래그. true로 설정하면 MongoDB Cloud가 클러스터를 삭제하지 않습니다. false로 설정하면 MongoDB Cloud가 클러스터를 삭제합니다.

versionReleaseSystem
문자열
기본값입니다: "LTS"
열거형: "LTS" "CONTINUOUS"

클러스터가 MongoDB 버전을 유지 관리하는 방법입니다. 값이 CONTINUOUS인 경우 mongoDBMajorVersion을 지정하지 않아야 합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-02-01+json

멀티클라우드 클러스터

{
  • "clusterType": "REPLICASET",
  • "links": [ ],
  • "name": "multiCloud",
  • "replicationSpecs": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBMajorVersion": "4.2",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

모든 클라우드 제공자 리전 반환

지정된 계층의 지정된 클라우드 제공자에 사용할 수 있는 리전 목록을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

providers
의 배열 strings

검색할 리전이 있는 클라우드 제공자. 여러 공급자를 지정하면 응답은 멀티 클라우드 클러스터를 지원하는 계층 및 리전만 반환할 수 있습니다.

tier
문자열

리전을 검색할 클러스터 계층.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 공유 계층 클러스터 업그레이드

지정된 프로젝트의 공유 계층 클러스터를 업그레이드합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 클러스터 관리자 역할이 있어야 합니다. 각 프로젝트는 최대 25개의 클러스터를 지원합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트의 공유 계층 클러스터 업그레이드에 대한 세부 정보.

acceptDataRisksAndForceReplicaSetReconfig
문자열 <date-time>

리전 중단으로 인해 프라이머리 토폴로지를 복구하기 위해 재구성이 필요한 경우 토폴로지 재구성과 함께 이 필드를 제출하여 새로운 리전 중단 방지 토폴로지를 요청하십시오. 투표 선택 가능 노드 대다수의 운영이 중단된 상태에서 강제 재구성을 수행하면 복제된 쓰기(대부분의 커밋된 쓰기 포함)가 새 프라이머리 노드에 복제되지 않은 경우 데이터가 손실될 위험이 있습니다. MongoDB Atlas 문서에서 더 많은 정보를 참조할 수 있습니다. 이러한 위험을 수반하는 작업을 계속 진행하려면 acceptDataRisksAndForceReplicaSetReconfig를 현재 날짜로 설정하세요.

리전 중단 시 복제본 세트 재구성하기
객체 (자동 클러스터 확장 설정)

클러스터를 확장할 수 있는 인스턴스 크기의 범위.

클러스터 자동 확장
backupEnabled
부울

클러스터가 백업을 수행할 수 있는지 여부를 나타내는 플래그. true로 설정하면 클러스터가 백업을 수행할 수 있습니다. NVMe 클러스터의 경우 이 값을 true로 설정해야 합니다. 백업은 전용 클러스터에는 클라우드 백업을, 테넌트 클러스터에는 공유 클러스터 백업을 사용합니다. false로 설정하면 클러스터에서 MongoDB Cloud 백업을 사용하지 않습니다.

객체 (Business Intelligence 설정을 위한 MongoDB Connector)

이 클러스터에 대한 Business Intelligence용 MongoDB Connector를 구성하는 데 필요한 설정입니다.

MongoDB Connector for Business Intelligence
clusterType
문자열
열거형: "REPLICASET" "SHARDED" "GEOSHARDED"

클러스터를 구성하는 노드의 구성.

diskSizeGB
숫자 <double> [ 10 .. 4096 ]

기가바이트 단위로 표시한 호스트의 루트 볼륨의 스토리지 용량. 용량을 추가하려면 높은 수를 지정합니다. MongoDB Cloud는 replicationSpecs를 설정하는 경우 이 매개변수가 필요합니다. 디스크 크기를 최소값(10GB) 미만으로 지정하면 이 매개 변수는 기본값인 최소 디스크 크기 값으로 설정됩니다. 스토리지 요금은 기본값을 선택하는지, 아니면 사용자 지정 값을 선택하는지에 따라 다르게 계산됩니다. 디스크 스토리지의 최대값은 선택한 클러스터의 최대 RAM의 50배를 초과할 수 없습니다. 더 많은 저장 공간이 필요한 경우 클러스터를 더 높은 티어로 업그레이드하는 것이 좋습니다.

diskWarmingMode
문자열
기본값입니다: "FULLY_WARMED"
열거형: "FULLY_WARMED" "VISIBLE_EARLIER"

디스크 보온 모드 선택.

세컨더리 디스크 워밍(Warming) 영향 감소
encryptionAtRestProvider
문자열
열거형: "NONE" "A" "AZURE" "GCP"

클러스터에 추가 저장 시 암호화 계층을 제공하기 위해 고객 키를 관리하는 클라우드 서비스 공급자.

고객 키 관리를 사용한 미사용 암호화
globalClusterSelfManagedSharding
부울

새 글로벌 클러스터를 생성할 때 샤딩 관리 모드를 구성하려면 이 필드를 로 설정합니다.

false로 설정하면 관리 모드가 Atlas-Managed Sharding으로 설정됩니다. 이 모드는 글로벌 클러스터의 샤딩을 완전히 관리하며 원활한 배포 환경을 제공하도록 구축되었습니다.

true로 설정하면 관리 모드가 자체 관리형 샤딩으로 설정됩니다. 이 모드는 샤드 관리를 직접 수행하며 유연한 고급 배포 환경을 제공하도록 구축되었습니다.

클러스터가 배포된 후에는 이 설정을 변경할 수 없습니다.

글로벌 클러스터 생성
의 배열 개체 (컴포넌트 레이블)
더 이상 사용되지 않습니다.

클러스터에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍 컬렉션. MongoDB Cloud 콘솔에는 레이블이 표시되지 않습니다.

클러스터 레이블은 더 이상 사용되지 않으며 향후 릴리스에서 제거될 예정입니다. 대신 리소스 태그를 사용할 것을 적극 권장합니다.

mongoDBMajorVersion
문자열
기본값입니다: "7.0"
열거형: "4.2" "4.4" "5.0" "6.0" "7.0"

클러스터의 주요 MongoDB 버전입니다. MongoDB Cloud는 항상 지정된 버전의 안정적인 최신 릴리스가 설치된 클러스터를 배포합니다.

mongoDBVersion
문자열([\d]+\.[\d]+\.[\d]+)

클러스터가 실행하는 MongoDB 버전.

이름
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

numShards
integer <int32> [ 1 .. 50 ]
기본값입니다: 1

샤드 클러스터에 배포할 샤드(최대 50개). 리소스는 복제본 세트의 경우 1를, 분할된 클러스터의 경우 2 이상의 값을 반환합니다. 반환된 값은 클러스터의 샤드 수와 같습니다.

샤딩
paused
부울

클러스터의 일시 중지 여부를 나타내는 플래그.

pitEnabled
부울

클러스터의 지속적인 클라우드 백업 사용 여부를 나타내는 플래그.

지속적인 클라우드 백업
providerBackupEnabled
부울

M10 이상 클러스터에서 클라우드 백업을 수행할 수 있는지 여부를 나타내는 플래그입니다. true로 설정하면 클러스터가 백업을 수행할 수 있습니다. 이 리소스와 BackupEnabled를 false로 설정하면 클러스터에서 MongoDB 클라우드 백업을 사용하지 않습니다.

객체 (클러스터의 클라우드 서비스 공급자 설정)

프로비저닝된 MongoDB 호스트를 구성하는 클라우드 공급자 설정 그룹.

replicationFactor
integer <int32>
더 이상 사용되지 않습니다.
기본값입니다: 3
열거형: 3 5 7

복제본 세트에 속한 멤버 수. 각 구성원은 데이터베이스 사본을 유지하여 고가용성과 데이터 중복성을 제공합니다. 대신 replicationSpecs을 사용하세요.

객체 (리전 구성)

MongoDB Cloud가 클러스터 노드를 프로비저닝하는 물리적 위치.

의 배열 개체 (LegacyReplicationSpec)

클러스터 리전을 구성하는 설정 목록.

  • 글로벌 클러스터의 경우 배열의 각 객체는 MongoDB Cloud가 클러스터 노드를 배포하는 하나의 영역을 나타냅니다.
  • 글로벌이 아닌 샤딩 클러스터 및 복제본 세트의 경우 MongoDB Cloud의 클러스터 노드 배포 위치를 나타내는 객체가 하나 포함됩니다.
rootCertType
문자열
기본값입니다: "ISRGROOTX1"
값: "ISRGROOTX1"

MongoDB Atlas 클러스터가 사용하는 루트 인증 기관. MongoDB Cloud는 Internet Security Research 그룹을 지원합니다.

의 배열 개체 (Resource Tag)

클러스터에 태그를 지정하고 분류하기 위한 1~255자 길이의 키-값 쌍이 포함된 목록입니다.

리소스 태그
terminationProtectionEnabled
부울
기본값입니다: 거짓

클러스터의 종료 보호 활성화 여부를 나타내는 플래그. true로 설정하면 MongoDB Cloud가 클러스터를 삭제하지 않습니다. false로 설정하면 MongoDB Cloud가 클러스터를 삭제합니다.

versionReleaseSystem
문자열
기본값입니다: "LTS"
열거형: "LTS" "CONTINUOUS"

클러스터가 MongoDB 버전을 유지 관리하는 방법입니다. 값이 CONTINUOUS인 경우 mongoDBMajorVersion을 지정하지 않아야 합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "mongoDBMajorVersion": "4.2",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBMajorVersion": "4.2",
  • "mongoDBVersion": "string",
  • "mongoURI": "string",
  • "mongoURIUpdated": "2019-08-24T14:15:22Z",
  • "mongoURIWithOptions": "string",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "srvAddress": "string",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

1개의 공유 계층 클러스터를 서버리스 인스턴스로 업그레이드

지정된 프로젝트의 공유 계층 클러스터를 서버리스 인스턴스로 업그레이드합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 클러스터 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트의 공유 계층 클러스터 업그레이드에 대한 세부 정보.

이름
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

필수
객체 (서버리스 인스턴스에 대한 클라우드 서비스 공급자 설정)

프로비저닝된 MongoDB 서버리스 인스턴스를 구성하는 클라우드 공급자 설정 그룹.

객체 (서버리스 백업 옵션)

서버리스 백업을 구성하는 설정 그룹.

의 배열 개체 (Resource Tag)

서버리스 인스턴스에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍이 포함된 목록.

terminationProtectionEnabled
부울
기본값입니다: 거짓

서버리스 인스턴스에서 종료 방지 기능 활성화 여부를 나타내는 플래그. true로 설정하면 MongoDB Cloud가는 서버리스 인스턴스를 삭제하지 않습니다. false로 설정하면 MongoDB Cloud가 서버리스 인스턴스를 삭제합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

1개의 프로젝트에서 1개의 클러스터 제거

지정된 프로젝트에서 클러스터 한 개를 제거합니다. 클러스터를 삭제하려면 종료 방지 기능이 비활성화되어 있어야 합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 이 기능은 서버리스 클러스터에서는 사용할 수 없습니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

retainBackups
부울

삭제된 전용 클러스터의 백업 스냅샷 유지 여부를 나타내는 플래그.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1개의 프로젝트에서 1개의 클러스터 반환 더 이상 사용되지 않음

지정된 프로젝트의 한 클러스터에 대한 세부 정보를 반환합니다. 클러스터에는 동일한 데이터 집합을 유지하는 호스트 그룹이 포함되어 있습니다. 응답에는 멀티클라우드 클러스터가 포함됩니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다. 이 기능은 서버리스 클러스터에서는 사용할 수 없습니다. 사용되지 않는 버전: v2-{2023-01-01}

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

이 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBMajorVersion": "4.2",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

1개의 프로젝트에서 1개의 클러스터 수정 더 이상 사용되지 않음

지정된 프로젝트의 한 클러스터에 대한 세부 정보를 업데이트합니다. 클러스터에는 동일한 데이터 집합을 유지하는 호스트 그룹이 포함되어 있습니다. 이 리소스는 멀티 클라우드 클러스터를 업데이트할 수 있습니다. 클러스터의 종료 보호를 업데이트하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 다른 모든 업데이트의 경우 요청하는 API 키에 프로젝트 클러스터 관리자 역할이 있어야 합니다. 일시 중지된 클러스터(paused : true)는 수정할 수 없습니다. paused : false로 설정하려면 이 엔드포인트를 호출해야 합니다. 이 엔드포인트가 paused : false으로 응답하면 클러스터에 적용하려는 변경 사항을 적용하여 다시 호출할 수 있습니다. 이 기능은 서버리스 클러스터에서는 사용할 수 없습니다. 사용되지 않는 버전: v2-{2023-01-01}

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-02-01+json

지정된 프로젝트에서 업데이트할 클러스터.

acceptDataRisksAndForceReplicaSetReconfig
문자열 <date-time>

리전 중단으로 인해 프라이머리 토폴로지를 복구하기 위해 재구성이 필요한 경우 토폴로지 재구성과 함께 이 필드를 제출하여 새로운 리전 중단 방지 토폴로지를 요청하십시오. 투표 선택 가능 노드 대다수의 운영이 중단된 상태에서 강제 재구성을 수행하면 복제된 쓰기(대부분의 커밋된 쓰기 포함)가 새 프라이머리 노드에 복제되지 않은 경우 데이터가 손실될 위험이 있습니다. MongoDB Atlas 문서에서 더 많은 정보를 참조할 수 있습니다. 이러한 위험을 수반하는 작업을 계속 진행하려면 acceptDataRisksAndForceReplicaSetReconfig를 현재 날짜로 설정하세요.

리전 중단 시 복제본 세트 재구성하기
backupEnabled
부울
기본값입니다: 거짓

클러스터가 백업을 수행할 수 있는지 여부를 나타내는 플래그. true로 설정하면 클러스터가 백업을 수행할 수 있습니다. NVMe 클러스터의 경우 이 값을 true로 설정해야 합니다. 백업은 전용 클러스터에는 클라우드 백업을, 테넌트 클러스터에는 공유 클러스터 백업을 사용합니다. false로 설정하면 클러스터에서 백업을 사용하지 않습니다.

객체 (Business Intelligence 설정을 위한 MongoDB Connector)

이 클러스터에 대한 Business Intelligence용 MongoDB Connector를 구성하는 데 필요한 설정입니다.

MongoDB Connector for Business Intelligence
clusterType
문자열
열거형: "REPLICASET" "SHARDED" "GEOSHARDED"

클러스터를 구성하는 노드의 구성.

diskSizeGB
숫자 <double> [ 10 .. 4096 ]

기가바이트 단위로 표시한 호스트의 루트 볼륨의 스토리지 용량. 용량을 추가하려면 높은 수를 지정합니다. MongoDB Cloud는 replicationSpecs를 설정하는 경우 이 매개변수가 필요합니다. 디스크 크기를 최소값(10GB) 미만으로 지정하면 이 매개 변수는 기본값인 최소 디스크 크기 값으로 설정됩니다. 스토리지 요금은 기본값을 선택하는지, 아니면 사용자 지정 값을 선택하는지에 따라 다르게 계산됩니다. 디스크 스토리지의 최대값은 선택한 클러스터의 최대 RAM의 50배를 초과할 수 없습니다. 더 많은 저장 공간이 필요한 경우 클러스터를 더 높은 티어로 업그레이드하는 것이 좋습니다.

diskWarmingMode
문자열
기본값입니다: "FULLY_WARMED"
열거형: "FULLY_WARMED" "VISIBLE_EARLIER"

디스크 보온 모드 선택.

세컨더리 디스크 워밍(Warming) 영향 감소
encryptionAtRestProvider
문자열
열거형: "NONE" "A" "AZURE" "GCP"

클러스터에 추가 저장 시 암호화 계층을 제공하기 위해 고객 키를 관리하는 클라우드 서비스 공급자. 미사용 암호화를 위한 고객 키 관리를 사용하려면 클러스터 replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 설정을 M10 이상으로 지정하고 "backupEnabled" : false 또는 완전히 생략해야 합니다.

고객 키 관리를 사용한 미사용 암호화
globalClusterSelfManagedSharding
부울

새 글로벌 클러스터를 생성할 때 샤딩 관리 모드를 구성하려면 이 필드를 로 설정합니다.

false로 설정하면 관리 모드가 Atlas-Managed Sharding으로 설정됩니다. 이 모드는 글로벌 클러스터의 샤딩을 완전히 관리하며 원활한 배포 환경을 제공하도록 구축되었습니다.

true로 설정하면 관리 모드가 자체 관리형 샤딩으로 설정됩니다. 이 모드는 샤드 관리를 직접 수행하며 유연한 고급 배포 환경을 제공하도록 구축되었습니다.

클러스터가 배포된 후에는 이 설정을 변경할 수 없습니다.

글로벌 클러스터 생성
의 배열 개체 (컴포넌트 레이블)
더 이상 사용되지 않습니다.

클러스터에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍 컬렉션. MongoDB Cloud 콘솔에는 레이블이 표시되지 않습니다.

클러스터 레이블은 더 이상 사용되지 않으며 향후 릴리스에서 제거될 예정입니다. 대신 리소스 태그를 사용할 것을 적극 권장합니다.

mongoDBMajorVersion
문자열
기본값입니다: "7.0"
열거형: "4.2" "4.4" "5.0" "6.0" "7.0"

클러스터의 주요 MongoDB 버전입니다. MongoDB Cloud는 항상 지정된 버전의 안정적인 최신 릴리스가 설치된 클러스터를 배포합니다.

이름
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

고급 클러스터를 식별하는 인간 판독 가능 레이블.

paused
부울

클러스터의 일시 중지 여부를 나타내는 플래그.

pitEnabled
부울

클러스터의 지속적인 클라우드 백업 사용 여부를 나타내는 플래그.

지속적인 클라우드 백업
의 배열 개체 (복제 사양)

클러스터 리전을 구성하는 설정 목록. 글로벌 클러스터의 경우 배열의 각 개체는 클러스터 노드 배포 영역을 나타냅니다. 글로벌이 아닌 샤드 클러스터 및 복제본 세트의 경우 이 배열에는 클러스터 노드 배포 위치를 나타내는 객체가 하나 포함됩니다.

rootCertType
문자열
기본값입니다: "ISRGROOTX1"
값: "ISRGROOTX1"

MongoDB Cloud 클러스터가 사용하는 루트 인증 기관. MongoDB Cloud는 Internet Security Research 그룹을 지원합니다.

의 배열 개체 (Resource Tag)

클러스터에 태그를 지정하고 분류하기 위한 1~255자 길이의 키-값 쌍이 포함된 목록입니다.

리소스 태그
terminationProtectionEnabled
부울
기본값입니다: 거짓

클러스터의 종료 보호 활성화 여부를 나타내는 플래그. true로 설정하면 MongoDB Cloud가 클러스터를 삭제하지 않습니다. false로 설정하면 MongoDB Cloud가 클러스터를 삭제합니다.

versionReleaseSystem
문자열
기본값입니다: "LTS"
열거형: "LTS" "CONTINUOUS"

클러스터가 MongoDB 버전을 유지 관리하는 방법입니다. 값이 CONTINUOUS인 경우 mongoDBMajorVersion을 지정하지 않아야 합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "labels": [
    ],
  • "mongoDBMajorVersion": "4.2",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "diskWarmingMode": "FULLY_WARMED",
  • "encryptionAtRestProvider": "NONE",
  • "globalClusterSelfManagedSharding": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "links": [],
  • "mongoDBMajorVersion": "4.2",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false,
  • "versionReleaseSystem": "LTS"
}

1개의 클러스터에 대해 1개의 고급 구성 옵션 반환 더 이상 사용되지 않음

지정된 프로젝트의 클러스터 하나에 대한 고급 구성 세부 정보를 반환합니다. 클러스터에는 동일한 데이터 집합을 유지하는 호스트 그룹이 포함되어 있습니다. 고급 구성 세부 정보에는 읽기/쓰기 고려, 인덱스 및 Oplog 제한 및 기타 데이터베이스 설정이 포함됩니다. 이 기능은 M0 무료 클러스터, M2 및 M5 공유 계층 클러스터 또는 서버리스 클러스터에는 사용할 수 없습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

글로벌 클러스터
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "chunkMigrationConcurrency": 0,
  • "defaultReadConcern": "local",
  • "defaultWriteConcern": "string",
  • "failIndexKeyTooLong": true,
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "transactionLifetimeLimitSeconds": 1
}

사용되지 않는 클러스터 1개의 고급 구성 옵션 업데이트

지정된 프로젝트의 클러스터 하나에 대한 고급 구성 세부 정보를 업데이트합니다. 클러스터에는 동일한 데이터 집합을 유지하는 호스트 그룹이 포함되어 있습니다. 고급 구성 세부 정보에는 읽기/쓰기 고려, 인덱스 및 Oplog 제한 및 기타 데이터베이스 설정이 포함됩니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 클러스터 관리자 역할이 있어야 합니다. 이 기능은 M0 무료 클러스터, M2 및 M5 공유 계층 클러스터 또는 서버리스 클러스터에는 사용할 수 없습니다.

글로벌 클러스터
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트의 클러스터 하나에 추가할 고급 구성 세부정보.

chunkMigrationConcurrency
integer <int32>

청크 마이그레이션을 위한 소스 샤드 및 수신 샤드의 스레드 수. 스레드 수는 샤드 클러스터에 있는 총 CPU 코어 수의 절반을 초과할 수 없습니다.

이 옵션은 `chunkMigrationConcurrency` `mongod` 구성 파일 옵션에 해당합니다.
defaultReadConcern
문자열
기본값입니다: "available"
열거형: '로컬' "available"

이 클러스터에 대해 설정된 읽기 작업에 대해 MongoDB에서 요청하는 기본값 승인 수준입니다.

MongoDB 4.4 클러스터의 기본값은 available입니다. MongoDB 5.0 이상 클러스터의 기본값은 local 입니다.

이 옵션은 글로벌 기본 읽기 고려에 해당합니다.
defaultWriteConcern
문자열

드라이버에서 아무 것도 지정하지 않은 경우 쓰기 작업에 대해 MongoDB에서 요청하는 기본 승인 수준입니다.

이 옵션은 암시적 기본 쓰기 고려에 해당합니다.
failIndexKeyTooLong
부울
더 이상 사용되지 않습니다.
기본값입니다: true

인덱싱된 모든 항목이 1,024바이트를 초과하는 문서를 삽입하거나 업데이트할 수 있는지 여부를 나타내는 플래그. 이 값을 'false'로 설정하면 mongod는 제한을 초과하는 문서를 작성하면서도 인덱싱하지는 않습니다. 이 매개 변수는 MongoDB 4.4에서 제거되었습니다.

이 옵션은 `failIndexKeyTooLong` `mongod` 구성 파일 옵션에 해당합니다.
javascriptEnabled
부울

클러스터가 서버 측 JavaScript 실행을 수행하는 작업의 실행을 허용하는지 여부를 나타내는 플래그입니다.

이 옵션은 클러스터의 각 `mongod` 및 `mongos`에 대한 `security.javascriptEnabled` 구성 파일 옵션을 수정하는 것에 해당합니다.
minimumEnabledTlsProtocol
문자열
열거형: "TLS1_0" "TLS1_1" "TLS1_2"

클러스터가 수신 연결 시 허용하는 최소 TLS(전송 계층 보안) 버전. TLS 1.0 또는 1.1을 사용하는 클러스터에서는 TLS 1.2를 최소 TLS 프로토콜 버전으로 설정하는 것이 좋습니다.

이 옵션은 구성 파일 옵션 `net.ssl.disabledProtocols` `mongod`에 해당합니다.
noTableScan
부울

클러스터가 결과 반환 시 컬렉션 스캔을 요하는 쿼리의 실행을 비활성화할지 여부를 나타내는 플래그입니다.

이 옵션은 구성 파일 옵션 `notablescan` `mongod`에 해당합니다.
oplogMinRetentionHours
숫자 or null <double>

시간 단위로 표현된 클러스터 oplog의 최소 보존 기간. null 값은 클러스터가 MongoDB Cloud가 계산하는 기본 최소 Oplog 기간을 사용함을 나타냅니다.

이 옵션은 구성 파일 옵션 `storage.oplogMinRetentionHours` `mongod`에 해당합니다.
oplogSizeMB
정수 또는 null <int32>

메가바이트 단위로 표시한 클러스터의 Oplog 저장 용량 한도. null 값은 클러스터가 MongoDB Cloud가 계산하는 기본 Oplog 크기를 사용함을 나타냅니다.

이 옵션은 구성 파일 옵션 `replication.oplogSizeMB` `mongod`에 해당합니다.
queryStatsLogVerbosity
integer <int32>

1(비활성화) 또는 3(활성화)으로 설정할 수 있습니다. 3으로 설정하면 Atlas는 편집되고 익명화된 $queryStats 출력을 MongoDB 로그에 포함합니다. $queryStats 출력에 리터럴 또는 필드 값이 포함되어 있지 않습니다. 이 설정을 활성화하면 클러스터 성능에 영향을 미칠 수 있습니다.

이 옵션은 logComponentVerbosity 서버 매개 변수의 queryStats 컴포넌트에 해당합니다.
sampleRefreshIntervalBIConnector
integer <int32> 0 이상
기본값입니다: 0

mongosqld 프로세스가 데이터를 다시 샘플링하여 관계형 스키마를 생성하는 간격(초).

이 옵션은 `sampleRefreshIntervalSecs` `mongosqld` 옵션에 해당합니다.
sampleSizeBIConnector
integer <int32> 0 이상

스키마 정보를 수집할 때 샘플링할 데이터베이스당 문서 수.

이 옵션은 `sampleSize` `mongosqld` 옵션에 해당합니다.
transactionLifetimeLimitSeconds
integer <int64> >= 1

다중 문서 트랜잭션의 수명, 초 단위. Atlas는 이 한도를 초과하는 트랜잭션을 만료된 것으로 간주하여 주기적인 정리 프로세스를 통해 트랜잭션을 중단합니다.

이 옵션은 구성 파일 옵션 `TransactionLifeTimeLimitsSeconds` `mongod`에 해당합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "chunkMigrationConcurrency": 0,
  • "defaultReadConcern": "local",
  • "defaultWriteConcern": "string",
  • "failIndexKeyTooLong": true,
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "transactionLifetimeLimitSeconds": 1
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "chunkMigrationConcurrency": 0,
  • "defaultReadConcern": "local",
  • "defaultWriteConcern": "string",
  • "failIndexKeyTooLong": true,
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": true,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "queryStatsLogVerbosity": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 0,
  • "transactionLifetimeLimitSeconds": 1
}

1개의 클러스터에 대해 페일오버 테스트

지정된 프로젝트에서 지정된 클러스터에 대한 페일오버 테스트를 시작합니다. 클러스터에는 동일한 데이터 집합을 유지하는 호스트 그룹이 포함되어 있습니다. 페일오버 테스트에서는 MongoDB Cloud가 클러스터 기본 노드의 장애를 원활하게 처리하는지 확인합니다. MongoDB Cloud는 테스트 중 프라이머리 노드를 종료하고 새 프라이머리 노드를 선택합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 클러스터 관리자 역할이 있어야 합니다. 사용 중단된 버전: v2-{2023-01-01}

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "reason": "Unauthorized"
}

모든 클러스터 작업의 상태 반환

지정된 프로젝트 내 지정된 클러스터의 모든 변경 사항의 상태를 반환합니다. 이 리소스를 사용하여 MongoDB Cloud의 변경 사항 처리 진행 상황을 확인할 수 있습니다. 이 응답에는 새로운 전용 클러스터 배포가 포함되지 않습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

클러스터에 샘플 데이터 세트 요청 로드

지정된 클러스터에 MongoDB 샘플 데이터 세트를 로드하도록 요청합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

이름
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

샘플 데이터 세트를 로드하는 클러스터를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "state": "WORKING"
}

클러스터 샘플 데이터 세트 요청 상태 확인

샘플 데이터 세트를 하나의 클러스터에 로드하는 진행 상황을 확인합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

sampleDatasetId
필수
문자열 = 24자 ^([a-f0-9]{24})$

로드된 샘플 데이터 세트를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "completeDate": "2019-08-24T14:15:22Z",
  • "createDate": "2019-08-24T14:15:22Z",
  • "errorMessage": "string",
  • "state": "WORKING"
}

컬렉션 수준 지표

지정된 클러스터 또는 프로세스에 대해 고정된 네임스페이스를 반환, 추가 및 편집합니다. 컬렉션 수준 지연 시간 메트릭 데이터도 반환합니다.

고정된 네임스페이스 반환

쿼리 지연 시간 지표를 수집하기 위해 사용자가 수동으로 선택한 네임스페이스 세트인 지정된 클러스터의 고정된 네임스페이스 목록을 반환합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

고정된 네임스페이스를 검색할 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "string",
  • "groupId": "string",
  • "pinnedNamespaces": [
    ]
}

고정된 네임스페이스 추가

지정된 그룹 및 클러스터에 대한 컬렉션 수준 지연 시간 메트릭 수집을 위해 제공된 네임스페이스 목록을 기존의 고정된 네임스페이스 목록에 추가합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

네임스페이스를 고정할 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-11-15+json

쿼리 지연 시간 메트릭 컬렉션을 위해 고정할 네임스페이스 문자열(데이터베이스와 컬렉션 이름의 조합)의 목록입니다.

namespaces
의 배열 strings unique

지정된 호스트 또는 클러스터의 네임스페이스 문자열(데이터베이스와 컬렉션의 조합) 목록입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{
  • "namespaces": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "string",
  • "groupId": "string",
  • "pinnedNamespaces": [
    ]
}

네임스페이스 고정

지정된 그룹 및 클러스터에 대한 컬렉션 수준 지연 시간 메트릭 수집을 위해 제공된 네임스페이스 목록을 고정합니다. 이렇게 하면 고정된 네임스페이스 목록이 초기화되거나 그룹 및 클러스터에 대한 기존의 고정된 네임스페이스 목록이 대체됩니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

네임스페이스를 고정할 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-11-15+json

쿼리 지연 시간 메트릭 컬렉션을 위해 고정할 네임스페이스 문자열(데이터베이스와 컬렉션 이름의 조합)의 목록입니다.

namespaces
의 배열 strings unique

지정된 호스트 또는 클러스터의 네임스페이스 문자열(데이터베이스와 컬렉션의 조합) 목록입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{
  • "namespaces": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "string",
  • "groupId": "string",
  • "pinnedNamespaces": [
    ]
}

네임스페이스 고정 해제

지정된 그룹 및 클러스터에 대한 컬렉션 수준 지연 시간 메트릭 컬렉션을 위해 제공된 네임스페이스 목록을 고정 해제합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

네임스페이스 고정을 해제할 클러스터를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-11-15+json

쿼리 지연 시간 메트릭 컬렉션을 위해 고정할 네임스페이스 문자열(데이터베이스와 컬렉션 이름의 조합)의 목록입니다.

namespaces
의 배열 strings unique

지정된 호스트 또는 클러스터의 네임스페이스 문자열(데이터베이스와 컬렉션의 조합) 목록입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{
  • "namespaces": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "string",
  • "groupId": "string",
  • "pinnedNamespaces": [
    ]
}

클러스터에서 순위가 지정된 네임스페이스 반환

지정된 시간 창 내에서 가장 높은 총 실행 시간(내림차순)으로 정렬된 지정된 클러스터의 네임스페이스 하위 집합을 반환합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

네임스페이스를 고정할 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

clusterView
필수
문자열
열거형: "primary" "secondary" "INDIVIDUAL_PROCESS"

지표를 검색할 클러스터 토폴로지를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

시작하기
문자열 <date-time>

MongoDB Cloud가 측정항목 보고를 시작한 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

end
문자열 <date-time>

MongoDB 클라우드가 메트릭 보고를 중단하는 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

period
문자열
예시: period=PT10H

Atlas가 메트릭을 보고하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다. 시작과 끝을 설정하지 않을 경우 이 매개변수를 포함하세요.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{
  • "groupId": "string",
  • "identifierId": "string",
  • "rankedNamespaces": [
    ]
}

클러스터 수준 쿼리 지연 시간 반환

지정된 네임스페이스에 대한 콜 통계 지연 시간 클러스터 수준 측정값의 목록을 가져옵니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

지표를 검색할 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

clusterView
필수
문자열
열거형: "primary" "secondary" "INDIVIDUAL_PROCESS"

지표를 검색할 클러스터 토폴로지를 식별하는 사람이 읽을 수 있는 레이블입니다.

databaseName
필수
문자열
예시: mydb

데이터베이스를 식별하는 사람이 읽을 수 있는 레이블입니다.

collectionName
필수
문자열
예시: mycoll

컬렉션을 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

지표
의 배열 strings unique
항목 열거형: "READS_OPS" "READS_LATENCY" "AVERAGE_READS_LATENCY" "READS_P50_밸" "READS_P95_밸" "READS_P99_밸" "WRITES_OPS" "WRITES_LATENCY" "AVERAGE_WRITES_LATENCY" "WRITES_P50_밸류" "WRITES_P95_밸류" "WRITES_P99_밸류" "COMMANDS_OPS" "COMMANDS_LATENCY" "AVERAGE_COMMANDS_LATENCY" "COMMANDS_P50_밸류" "COMMANDS_P95_밸류" "COMMANDS_P99_밸류" "TOTAL_OPS" "TOTAL_LATENCY" "AVERAGE_TOTAL_OPS_LATENCY" "TOTAL_OPS_P50_밸류" "TOTAL_OPS_P95_밸류" "TOTAL_OPS_P99_밸류"

연결된 데이터 시리즈에 대해 검색하려는 지표가 포함된 목록입니다. 이 매개 변수를 설정하지 않으면 이 리소스는 모든 Coll Stats 지연 시간 지표에 대한 데이터 시리즈를 반환합니다.

시작하기
문자열 <date-time>

MongoDB Cloud가 측정항목 보고를 시작한 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

end
문자열 <date-time>

MongoDB 클라우드가 메트릭 보고를 중단하는 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

period
문자열
예시: period=PT10H

Atlas가 메트릭을 보고하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다. 시작과 끝을 설정하지 않을 경우 이 매개변수를 포함하세요.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{
  • "clusterId": "string",
  • "clusterView": "string",
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "measurements": [
    ],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

모든 지표 이름 반환

요청 시 지정된 프로젝트에 대해 사용 가능한 모든 Coll Stats 지연 시간 메트릭 이름과 해당 단위를 반환합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{ }

호스트에서 순위가 지정된 네임스페이스 반환

지정된 기간 내에서 가장 높은 총 실행 시간(내림차순)으로 순위가 지정된 프로세스의 네임스페이스 하위 집합을 반환합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: my.host.name.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 IANA 포트의 조합입니다. 호스트는 MongoDB 프로세스 (mongod 또는 mongos) 를 실행하는 호스트의 호스트 이름, FQDN (정규화된 도메인 이름) 또는 인터넷 프로토콜 주소 (IPv4 또는 IPv6) 여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신 대기하는 IANA 포트여야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

시작하기
문자열 <date-time>

MongoDB Cloud가 측정항목 보고를 시작한 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

end
문자열 <date-time>

MongoDB 클라우드가 메트릭 보고를 중단하는 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

period
문자열
예시: period=PT10H

Atlas가 메트릭을 보고하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다. 시작과 끝을 설정하지 않을 경우 이 매개변수를 포함하세요.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{
  • "groupId": "string",
  • "identifierId": "string",
  • "rankedNamespaces": [
    ]
}

호스트 수준 쿼리 지연 시간 반환

지정된 네임스페이스에 대한 Coll Stats 지연 시간 프로세스 수준 측정값 목록을 가져옵니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: my.host.name.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 IANA 포트의 조합입니다. 호스트는 MongoDB 프로세스 (mongod 또는 mongos) 를 실행하는 호스트의 호스트 이름, FQDN (정규화된 도메인 이름) 또는 인터넷 프로토콜 주소 (IPv4 또는 IPv6) 여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신 대기하는 IANA 포트여야 합니다.

databaseName
필수
문자열
예시: mydb

데이터베이스를 식별하는 사람이 읽을 수 있는 레이블입니다.

collectionName
필수
문자열
예시: mycoll

컬렉션을 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

지표
의 배열 strings unique
항목 열거형: "READS_OPS" "READS_LATENCY" "AVERAGE_READS_LATENCY" "READS_P50_밸" "READS_P95_밸" "READS_P99_밸" "WRITES_OPS" "WRITES_LATENCY" "AVERAGE_WRITES_LATENCY" "WRITES_P50_밸류" "WRITES_P95_밸류" "WRITES_P99_밸류" "COMMANDS_OPS" "COMMANDS_LATENCY" "AVERAGE_COMMANDS_LATENCY" "COMMANDS_P50_밸류" "COMMANDS_P95_밸류" "COMMANDS_P99_밸류" "TOTAL_OPS" "TOTAL_LATENCY" "AVERAGE_TOTAL_OPS_LATENCY" "TOTAL_OPS_P50_밸류" "TOTAL_OPS_P95_밸류" "TOTAL_OPS_P99_밸류"

연결된 데이터 시리즈에 대해 검색하려는 지표가 포함된 목록입니다. 이 매개 변수를 설정하지 않으면 이 리소스는 모든 Coll Stats 지연 시간 지표에 대한 데이터 시리즈를 반환합니다.

시작하기
문자열 <date-time>

MongoDB Cloud가 측정항목 보고를 시작한 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

end
문자열 <date-time>

MongoDB 클라우드가 메트릭 보고를 중단하는 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

period
문자열
예시: period=PT10H

Atlas가 메트릭을 보고하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다. 시작과 끝을 설정하지 않을 경우 이 매개변수를 포함하세요.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "measurements": [
    ],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

사용자 지정 데이터베이스 역할

사용자 지정 데이터베이스 사용자 권한 역할을 반환, 추가, 편집 및 제거합니다. 사용자 지정 역할을 사용하여 MongoDB Cloud 내장 역할에서 설명할 수 없는 사용자 지정 작업 집합을 지정할 수 있습니다. 프로젝트의 모든 클러스터에 대해 프로젝트 수준에서 사용자 지정 역할을 정의합니다. 이 리소스는 MongoDB 권한 작업의 하위 집합을 지원합니다. 사용자 정의 역할 작업의 하위 집합을 생성할 수 있습니다. 더 넓은 사용자 지정 역할 작업 목록을 만들려면 MongoDB Cloud 사용자 인터페이스를 사용하세요. 사용자 지정 역할에는 모든 프로젝트의 클러스터가 지원하고 프로젝트의 클러스터가 사용하는 각 MongoDB 버전과 호환되는 작업이 포함되어야 합니다. 예를 들어 프로젝트에 MongoDB 4.2 클러스터가 있는 경우 MongoDB 4.4에 추가된 작업을 사용하는 사용자 지정 역할을 만들 수 없습니다.

1개의 프로젝트에서 모든 사용자 지정 역할 반환

지정된 프로젝트의 모든 사용자 정의 역할을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1개의 사용자 지정 역할 만들기

지정된 프로젝트에 하나의 사용자 지정 역할을 만듭니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 하나의 사용자 지정 역할을 만듭니다.

의 배열 개체 (데이터베이스 권한 작업)

역할이 부여하는 개별 권한 작업의 목록.

의 배열 개체 (상속된 역할) unique

이 사용자 지정 역할이 상속하는 기본 제공 역할의 목록.

roleName
필수
문자열^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

요청에 대한 역할을 식별하는 인간 판독 가능 레이블. 이 프로젝트에 포함된 이 사용자 지정 역할에 대해 고유한 이름이어야 합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

1개의 프로젝트에서 1개의 사용자 지정 역할 제거

지정된 프로젝트에서 사용자 지정 역할 하나를 제거합니다. 부모 역할이나 작업이 없는 하나 이상의 자식 역할을 남겨두는 사용자 지정 역할은 제거할 수 없습니다. 또한 한 명 이상의 데이터베이스 사용자의 마지막 역할인 사용자 지정 역할은 제거할 수 없습니다. 이 리소스를 사용하려면 요청하는 API Key에 Project Atlas 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

roleName
필수
문자열^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

요청에 대한 역할을 식별하는 인간 판독 가능 레이블. 이 프로젝트에 포함된 이 사용자 지정 역할에 대해 고유한 이름이어야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1개의 프로젝트에서 1개의 사용자 지정 역할 반환

지정된 프로젝트의 사용자 지정 역할 하나를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

roleName
필수
문자열^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

요청에 대한 역할을 식별하는 인간 판독 가능 레이블. 이 프로젝트에 포함된 이 사용자 지정 역할에 대해 고유한 이름이어야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

1개의 프로젝트에서 1개의 사용자 지정 역할 업데이트

지정된 프로젝트의 사용자 지정 역할 하나를 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

roleName
필수
문자열^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

요청에 대한 역할을 식별하는 인간 판독 가능 레이블. 이 이름은 이 프로젝트에서 이 사용자 지정 역할에 대해 고유해야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트의 사용자 지정 역할 하나를 업데이트합니다.

의 배열 개체 (데이터베이스 권한 작업)

역할이 부여하는 개별 권한 작업의 목록.

의 배열 개체 (상속된 역할) unique

이 사용자 지정 역할이 상속하는 기본 제공 역할의 목록.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

데이터 페더레이션

연합 데이터베이스 인스턴스를 반환, 추가, 편집 및 제거합니다. 이 리소스에는 프로젝트 ID가 필요합니다. 연합 데이터베이스 인스턴스 구성을 변경하면 비용에 영향을 미칠 수 있습니다.

1개의 프로젝트에서 모든 연합 데이터베이스 인스턴스 반환

지정된 프로젝트에 있는 모든 연합 데이터베이스 인스턴스의 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 이상의 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

유형
문자열
기본값입니다: "USER"
열거형: "USER" "ONLINE_ARCHIVE"

반환할 연합 데이터베이스 인스턴스 유형.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1개의 프로젝트에 1개의 연합 데이터베이스 인스턴스 만들기

지정된 프로젝트에 연합 데이터베이스 인스턴스를 한 개를 생성합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 소유자 또는 프로젝트 차트 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

skipRoleValidation
부울
기본값입니다: 거짓

요청한 IAM 역할이 S3 버킷에서 읽을 수 있는지를 이 요청에서 확인해야 하는지 여부를 나타내는 플래그. AWS는 버킷에 쓰기 전에 역할이 버킷에 있는 개체를 나열할 수 있는지 확인합니다. 일부 IAM 역할에는 쓰기 권한만 필요합니다. 이 플래그를 사용하면 해당 확인 과정을 건너뛸 수 있습니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 하나의 연합 데이터베이스 인스턴스를 만들기 위한 세부 정보.

객체 (Data Lake 클라우드 제공자)

이 Data Lake에 연결된 클라우드 제공자.

객체 (DataLakeDataProcessRegion)

Data Lake가 클라이언트 연결을 라우팅하는 클라우드 공급자 리전에 대한 정보.

이름
문자열

Data Lake를 식별하는 인간 판독 가능 레이블.

객체 (DataLakeStorage)

각 데이터 저장소 구성 정보 및 MongoDB Cloud 데이터베이스에 대한 매핑.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

1개의 프로젝트에서 1개의 연합 데이터베이스 인스턴스 제거

지정된 프로젝트에서 연합 데이터베이스 인스턴스 하나를 제거합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 소유자 또는 프로젝트 차트 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

제거할 연합 데이터베이스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 프로젝트에서 1개의 연합 데이터베이스 인스턴스 반환

지정된 프로젝트 내 연합 데이터베이스 인스턴스 한 개의 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 읽기 전용 또는 프로젝트 차트 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

반환할 연합 데이터베이스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

1개의 프로젝트에서 1개의 연합 데이터베이스 인스턴스 업데이트

지정된 프로젝트에서 연합 데이터베이스 인스턴스 한 개의 세부 정보를 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 이상의 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

업데이트할 연합 데이터베이스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

skipRoleValidation
필수
부울

요청한 IAM 역할이 S3 버킷에서 읽을 수 있는지를 이 요청에서 확인해야 하는지 여부를 나타내는 플래그. AWS는 버킷에 쓰기 전에 역할이 버킷에 있는 개체를 나열할 수 있는지 확인합니다. 일부 IAM 역할에는 쓰기 권한만 필요합니다. 이 플래그를 사용하면 해당 확인 과정을 건너뛸 수 있습니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에서 업데이트할 연합 데이터베이스 한 개에 대한 세부 정보.

객체 (Data Lake 클라우드 제공자)

이 Data Lake에 연결된 클라우드 제공자.

객체 (DataLakeDataProcessRegion)

Data Lake가 클라이언트 연결을 라우팅하는 클라우드 공급자 리전에 대한 정보.

이름
문자열

Data Lake를 식별하는 인간 판독 가능 레이블.

객체 (DataLakeStorage)

각 데이터 저장소 구성 정보 및 MongoDB Cloud 데이터베이스에 대한 매핑.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnames": [
    ],
  • "name": "string",
  • "privateEndpointHostnames": [
    ],
  • "state": "UNVERIFIED",
  • "storage": {
    }
}

1개의 연합 데이터베이스 인스턴스에 대해 모든 쿼리 제한 반환

지정된 프로젝트의 연합 데이터베이스 인스턴스에 대한 쿼리 제한을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

쿼리 제한을 검색하려는 연합 데이터베이스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1개의 연합 데이터베이스 인스턴스에 대해 1개의 쿼리 제한 삭제

하나의 연합 데이터베이스 인스턴스에 적용되는 쿼리 제한 한 개를 삭제합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

쿼리 제한이 적용되는 연합 데이터베이스 인스턴스를 식별하는 인간 판독 가능 레이블.

limitName
필수
문자열
열거형: "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly"

이 데이터 페더레이션 인스턴스 제한을 식별하는 인간 판독 가능 레이블.

제한 이름 설명 기본값
bytesProcessed.query 단일 데이터 페더레이션 쿼리 중 처리되는 바이트 수 제한 N/A
bytesProcessed.daily 현재 날짜에 데이터 페더레이션 인스턴스에 대해 처리되는 바이트 수 제한 N/A
bytesProcessed.weekly 현재 주에 데이터 페더레이션 인스턴스에 대해 처리되는 바이트 수 제한 N/A
bytesProcessed.monthly 현재 월에 데이터 페더레이션 인스턴스에 대해 처리되는 바이트 수 제한 N/A
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 프로젝트에 대해 1개의 연합 데이터베이스 인스턴스 쿼리 제한 반환

지정된 프로젝트의 지정된 연합 데이터베이스 인스턴스에 적용되는 쿼리 제한 하나에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

쿼리 제한이 적용되는 연합 데이터베이스 인스턴스를 식별하는 인간 판독 가능 레이블.

limitName
필수
문자열
열거형: "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly"

이 데이터 페더레이션 인스턴스 제한을 식별하는 인간 판독 가능 레이블.

제한 이름 설명 기본값
bytesProcessed.query 단일 데이터 페더레이션 쿼리 중 처리되는 바이트 수 제한 N/A
bytesProcessed.daily 현재 날짜에 데이터 페더레이션 인스턴스에 대해 처리되는 바이트 수 제한 N/A
bytesProcessed.weekly 현재 주에 데이터 페더레이션 인스턴스에 대해 처리되는 바이트 수 제한 N/A
bytesProcessed.monthly 현재 월에 데이터 페더레이션 인스턴스에 대해 처리되는 바이트 수 제한 N/A
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "maximumLimit": 0,
  • "name": "string",
  • "overrunPolicy": "BLOCK",
  • "tenantName": "string",
  • "value": 0
}

1개의 연합 데이터베이스 인스턴스에 대해 1개의 쿼리 제한 구성

하나의 연합 데이터베이스 인스턴스에 대해 쿼리 제한을 한 개 만들거나 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

쿼리 제한이 적용되는 연합 데이터베이스 인스턴스를 식별하는 인간 판독 가능 레이블.

limitName
필수
문자열
열거형: "bytesProcessed.query" "bytesProcessed.daily" "bytesProcessed.weekly" "bytesProcessed.monthly"

이 데이터 페더레이션 인스턴스 제한을 식별하는 인간 판독 가능 레이블.

제한 이름 설명 기본값
bytesProcessed.query 단일 데이터 페더레이션 쿼리 중 처리되는 바이트 수 제한 N/A
bytesProcessed.daily 현재 날짜에 데이터 페더레이션 인스턴스에 대해 처리되는 바이트 수 제한 N/A
bytesProcessed.weekly 현재 주에 데이터 페더레이션 인스턴스에 대해 처리되는 바이트 수 제한 N/A
bytesProcessed.monthly 현재 월에 데이터 페더레이션 인스턴스에 대해 처리되는 바이트 수 제한 N/A
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

하나의 연합 데이터베이스 인스턴스에 대해 쿼리 제한을 한 개 만들거나 업데이트합니다.

overrunPolicy
문자열
열거형: "BLOCK" "BLOCK_AND_KILL"

데이터 페더레이션 한도에만 사용됩니다. 사용량 한도 초과 시 취해야 할 조치입니다. 한도 범위를 'QUERY'로 설정한 경우 MongoDB Cloud는 사용량 한도를 초과하면 쿼리를 중지하므로 이러한 한도를 무시됩니다.

value
필수
integer <int64>

한도의 크기.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "overrunPolicy": "BLOCK",
  • "value": 0
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "maximumLimit": 0,
  • "name": "string",
  • "overrunPolicy": "BLOCK",
  • "tenantName": "string",
  • "value": 0
}

1개의 연합 데이터베이스 인스턴스에 대해 쿼리 로그 다운로드

지정된 연합 데이터베이스 인스턴스에 대한 쿼리 로그를 다운로드합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 또는 프로젝트 데이터 액세스 읽기/쓰기 역할이 있어야 합니다. API는 json 응답 스키마를 사용한 직접 호출을 지원하지 않습니다. 'Accept: application/vnd.atlas.YYYY-MM-DD+gzip' 형식의 수락 헤더를 사용하여 gzip 응답 스키마를 요청해야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

쿼리 로그를 다운로드하려는 연합 데이터베이스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
endDate
integer <int64> 1199145600
예시: endDate=1636481348

다운로드할 로그 메시지 범위의 종료 지점을 지정하는 타임스탬프. MongoDB Cloud는 유닉스 시간 이후 경과된 시간(초)으로 이 타임스탬프를 표현합니다.

startDate
integer <int64> 1199145600
예시: startDate=1636466948

다운로드할 로그 메시지 범위의 시작 지점을 지정하는 타임스탬프. MongoDB Cloud는 유닉스 시간 이후 경과된 시간(초)으로 이 타임스탬프를 표현합니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1개의 프로젝트에서 모든 연합 데이터베이스 인스턴스 및 온라인 아카이브 비공개 엔드포인트 반환

지정된 프로젝트의 연합 데이터베이스 인스턴스 및 온라인 아카이브에 대한 모든 프라이빗 엔드포인트를 반환합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 읽기 전용 또는 프로젝트 차트 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

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 키에 프로젝트 소유자 또는 프로젝트 차트 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 추가할 연합 데이터베이스 인스턴스 및 온라인 아카이브에 대한 프라이빗 엔드포인트입니다.

comment
문자열

이 비공개 엔드포인트에 연결할 인간 판독 가능 문자열.

customerEndpointDNSName
문자열

고객의 VPC 엔드포인트 DNS 이름을 식별하는 인간 판독 가능 레이블.

endpointId
필수
문자열 = 22자 ^vpce-[0-9a-f]{17}$

비공개 엔드포인트를 식별하는 고유한 22자 영숫자 문자열입니다.

Atlas Data Lake는 AWS PrivateLink 기능을 사용하여 Amazon Web Services 프라이빗 엔드포인트를 지원합니다.
provider
문자열
기본값입니다: "A"
값: "A"

클라우드 서비스 제공자를 식별하는 인간 판독 가능 레이블. Atlas Data Lake는 Amazon Web Services만 지원합니다.

region
문자열

고객의 VPC 엔드포인트 리전을 식별하기 위한 사람이 인간 판독 가능 레이블.

유형
문자열
기본값입니다: "DATA_LAKE"
값: "DATA_LAKE"

이 프라이빗 엔드포인트와 연결된 리소스 유형을 식별하는 인간 판독 가능 레이블.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "comment": "string",
  • "customerEndpointDNSName": "string",
  • "endpointId": "vpce-3bf78b0ddee411ba1",
  • "provider": "AWS",
  • "region": "string",
  • "type": "DATA_LAKE"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 프로젝트에서 1개의 연합 데이터베이스 인스턴스 및 온라인 아카이브 비공개 엔드포인트 제거

지정된 프로젝트의 연합 데이터베이스 인스턴스 및 온라인 아카이브에 대한 프라이빗 엔드포인트 한 개를 삭제합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

endpointId
필수
문자열 = 22자 ^vpce-[0-9a-f]{17}$

제거할 프라이빗 엔드포인트를 식별하는 고유한 22자 영숫자 문자열. Atlas Data Federation은 AWS PrivateLink 기능을 사용하여 AWS 프라이빗 엔드포인트를 지원합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 프로젝트에서 1개의 연합 데이터베이스 인스턴스 및 온라인 아카이브 비공개 엔드포인트 반환

지정된 프로젝트의 연합 데이터베이스 인스턴스 또는 온라인 아카이브에 대한 지정된 비공개 엔드포인트 한 개를 반환합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 읽기 전용 또는 프로젝트 차트 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

endpointId
필수
문자열 = 22자 ^vpce-[0-9a-f]{17}$

반환할 비공개 엔드포인트를 식별하는 고유한 22자 영숫자 문자열입니다. Atlas Data Federation은 AWS PrivateLink 기능을 사용하여 AWS 프라이빗 엔드포인트를 지원합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "comment": "string",
  • "customerEndpointDNSName": "string",
  • "endpointId": "vpce-3bf78b0ddee411ba1",
  • "provider": "AWS",
  • "region": "string",
  • "type": "DATA_LAKE"
}

Data Lake 파이프라인

Atlas Data Lake 파이프라인 및 관련 실행을 반환, 추가, 편집 및 제거합니다.

1개의 프로젝트에서 모든 Data Lake 파이프라인 반환

Data Lake 파이프라인의 목록을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1개의 Data Lake 파이프라인 만들기

Data Lake 파이프라인을 한 개 생성합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

Data Lake 파이프라인을 한 개 생성합니다.

객체 (데이터 세트 보존 정책)

예약된 데이터 레이크 파이프라인에 적용되는 데이터 세트 보존 정책.

이름
문자열

이 Data Lake 파이프라인의 이름.

객체 (수집 대상)

Data Lake 파이프라인의 수집 대상.

객체 (수집 소스)

Data Lake 파이프라인의 수집 소스.

의 배열 개체 (필드 변환)

이 Data Lake 파이프라인에서 제외할 필드.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "datasetRetentionPolicy": {
    },
  • "name": "string",
  • "sink": { },
  • "source": {
    },
  • "transformations": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

1개의 Data Lake 파이프라인 제거

Data Lake 파이프라인을 한 개 제거합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

pipelineName
필수
문자열 [ 1 ... 64 ] 문자 ^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 Data Lake 파이프라인 반환

지정된 프로젝트 내 Data Lake 파이프라인 한 개에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

pipelineName
필수
문자열 [ 1 ... 64 ] 문자 ^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

1개의 Data Lake 파이프라인 업데이트

Data Lake 파이프라인을 한 개 업데이트합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

pipelineName
필수
문자열 [ 1 ... 64 ] 문자 ^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

Data Lake 파이프라인을 한 개 업데이트합니다.

객체 (데이터 세트 보존 정책)

예약된 데이터 레이크 파이프라인에 적용되는 데이터 세트 보존 정책.

이름
문자열

이 Data Lake 파이프라인의 이름.

객체 (수집 대상)

Data Lake 파이프라인의 수집 대상.

객체 (수집 소스)

Data Lake 파이프라인의 수집 소스.

의 배열 개체 (필드 변환)

이 Data Lake 파이프라인에서 제외할 필드.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "datasetRetentionPolicy": {
    },
  • "name": "string",
  • "sink": { },
  • "source": {
    },
  • "transformations": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

1개의 Data Lake 파이프라인에 사용 가능한 수집 일정 반환

Data Lake 파이프라인 소스로 사용할 수 있는 백업 일정 정책 항목의 목록을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

pipelineName
필수
문자열 [ 1 ... 64 ] 문자 ^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1개의 Data Lake 파이프라인에 사용 가능한 백업 스냅샷 반환

온디맨드 파이프라인 실행을 트리거하는 데 사용할 수 있는 백업 스냅샷 목록을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

pipelineName
필수
문자열 [ 1 ... 64 ] 문자 ^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

completedAfter
문자열 <date-time>
예시: completedAfter=2022-01-01T00:00:00Z

MongoDB Cloud가 이 스냅샷을 생성한 날짜 및 시간입니다. 이 값이 지정된 경우 MongoDB Cloud는 이 시간 및 날짜 이후에 생성된 사용 가능한 백업 스냅샷만 반환합니다. 이 매개 변수는 값을 UTC의 ISO 8601 타임스탬프 형식으로 표현합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 Data Lake 파이프라인 일시 중지

지정된 프로젝트 내에서 Data Lake 파이프라인 수집을 일시 중지합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

pipelineName
필수
문자열 [ 1 ... 64 ] 문자 ^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

1개의 Data Lake 파이프라인 재개

지정된 프로젝트 내에서 Data Lake 파이프라인 수집을 재개합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

pipelineName
필수
문자열 [ 1 ... 64 ] 문자 ^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

1개의 프로젝트에서 실행되는 모든 Data Lake 파이프라인 반환

과거 Data Lake 파이프라인 실행 목록을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

pipelineName
필수
문자열 [ 1 ... 64 ] 문자 ^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

createdBefore
문자열 <date-time>
예시: createdBefore=2022-01-01T00:00:00Z

이 값이 지정된 경우 Atlas는 이 시간 및 날짜 이전에 시작된 Data Lake 파이프라인 실행만 반환합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

파이프라인 실행 데이터세트 삭제

지정된 파이프라인 실행 중에 Atlas가 생성한 데이터 세트를 삭제합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

pipelineName
필수
문자열 [ 1 ... 64 ] 문자 ^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

pipelineRunId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

Data Lake 파이프라인 실행을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 Data Lake 파이프라인 실행 반환

지정된 프로젝트 내에서 실행되는 하나의 Data Lake 파이프라인에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

pipelineName
필수
문자열 [ 1 ... 64 ] 문자 ^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

pipelineRunId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

Data Lake 파이프라인 실행을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "backupFrequencyType": "HOURLY",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "phase": "SNAPSHOT",
  • "pipelineId": "32b6e34b3d91647abb20e7b8",
  • "scheduledDeletionDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "PENDING",
  • "stats": {
    }
}

온디맨드 스냅샷 수집 트리거

지정된 스냅샷의 Data Lake 파이프라인 수집을 트리거합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

pipelineName
필수
문자열 [ 1 ... 64 ] 문자 ^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

스냅샷의 단일 수집 실행을 트리거합니다.

객체 (데이터 세트 보존 정책)

예약된 데이터 레이크 파이프라인에 적용되는 데이터 세트 보존 정책.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

스냅샷을 식별하는 고유한 24자리 16진수 문자열.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "datasetRetentionPolicy": {
    },
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "backupFrequencyType": "HOURLY",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
  • "datasetRetentionPolicy": {
    },
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "phase": "SNAPSHOT",
  • "pipelineId": "32b6e34b3d91647abb20e7b8",
  • "scheduledDeletionDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "state": "PENDING",
  • "stats": {
    }
}

데이터베이스 사용자

데이터베이스 사용자를 반환, 추가, 편집 및 제거합니다.

1개의 프로젝트에서 모든 데이터베이스 사용자 반환

지정된 프로젝트에 속한 모든 데이터베이스 사용자를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 프로젝트에 1명의 데이터베이스 사용자 만들기

지정된 프로젝트에 하나의 데이터베이스 사용자를 생성합니다. 이 MongoDB 클라우드는 프로젝트당 최대 100명의 데이터베이스 사용자를 지원합니다. 프로젝트에 100명 이상의 데이터베이스 사용자가 필요한 경우 지원팀에 문의하세요. 이 리소스를 사용하려면 요청 API 키에 프로젝트 소유자 또는 프로젝트 차트 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 하나의 데이터베이스 사용자를 생성합니다.

awsIAMType
문자열
기본값입니다: "NONE"
열거형: "NONE" "USER" "ROLE"

새 데이터베이스 사용자가 사용자 또는 사용자의 역할과 연결된 AWS(Amazon Web Services) IAM(ID 및 액세스 관리) 자격 증명으로 인증하는지 여부를 나타내는 인간 판독 가능 레이블.

databaseName
필수
문자열
기본값입니다: "admin"
열거형: "admin" "$external"

데이터베이스 사용자가 인증하는 데이터베이스입니다. 데이터베이스 사용자는 사용자 이름과 인증 데이터베이스를 모두 제공해야 MongoDB에 로그인할 수 있습니다. 사용자가 AWS IAM으로 인증하는 경우 x.509, LDAP 또는 OIDC 워크로드 이 값은 $external 이어야 합니다. 사용자가 SCRAM-SHA 또는 OIDC Workforce로 인증하는 경우 이 값은 admin 이어야 합니다.

deleteAfterDate
문자열 <date-time>

MongoDB Cloud가 사용자를 삭제한 날짜 및 시간. 이 매개 변수는 값을 UTC의 ISO 8601 타임스탬프 형식으로 표현하며 표준 시간대 지정을 포함할 수 있습니다. API(애플리케이션 프로그래밍 인터페이스) 요청 후 1주일 이내의 미래 날짜를 지정해야 합니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$

프로젝트를 식별하는 고유한 24자리 16진수 문자열.

의 배열 개체 (컴포넌트 레이블)

MongoDB 데이터베이스 사용자를 태그 지정하고 분류하는 키-값 쌍이 포함된 목록. 사용자가 정의한 레이블은 콘솔에 표시되지 않습니다.

ldapAuthType
문자열
기본값입니다: "NONE"
열거형: "NONE" "GROUP" "USER"

데이터베이스가 LDAP(경량 디렉토리 액세스 프로토콜) 호스트에서 이 데이터베이스 사용자를 인증하는 데 사용하는 LDAP 기록의 일부.

oidcAuthType
문자열
기본값입니다: "NONE"
열거형: "NONE" "IDP_GROUP" "USER"

새 데이터베이스 사용자 또는 그룹이 OIDC 페더레이션 인증으로 인증하는지 여부를 나타내는 사람이 읽을 수 있는 레이블입니다. 페더레이션 인증 사용자를 생성하려면 이 필드에 USER 값을 지정합니다. 페더레이션 인증 그룹을 생성하려면 이 필드에 IDP_GROUP 값을 지정합니다.

비밀번호
문자열 8자 이상

databaseName에 지정된 데이터베이스에 대해 이 데이터베이스 사용자를 인증하는 영숫자 문자열. SCRAM-SHA로 인증하려면 이 매개 변수를 지정해야 합니다. 이 매개 변수는 이 응답에 나타나지 않습니다.

SCRAM-SHA
의 배열 개체 (데이터베이스 사용자 역할)

하나의 역할과 하나의 적용 가능한 데이터베이스의 쌍을 제공하는 목록.

의 배열 개체 (데이터베이스 사용자 범위)

이 데이터베이스 사용자가 액세스할 수 있는 클러스터, MongoDB Atlas Data Lakes 및 MongoDB Atlas Streams 인스턴스가 포함된 목록입니다. 생략하면 MongoDB Cloud는 데이터베이스 사용자에게 프로젝트의 모든 클러스터, MongoDB Atlas Data Lakes 및 MongoDB Atlas Streams 인스턴스에 대한 액세스 권한을 부여합니다.

사용자 이름
필수
문자열 1024자 이하

MongoDB에 인증하는 사용자를 나타내는 인간 판독 가능 레이블. 이 레이블의 형식은 인증 방법에 따라 다릅니다.

인증 방법 필요한 매개 변수 매개 변수 값 username 형식
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType 사용자 ARN
x.509 x509Type CUSTOMER RFC 2253 고유 이름
x.509 x509Type MANAGED RFC 2253 고유 이름
LDAP ldapAuthType 사용자 RFC 2253 고유 이름
LDAP ldapAuthType GROUP RFC 2253 고유 이름
OIDC 인력 oidcAuthType IDP_GROUP Atlas OIDC IdP ID(페더레이션 설정)에 빗금 기호('/')와 IdP 그룹 이름을 합친 값
OIDC 워크로드 oidcAuthType 사용자 Atlas OIDC IdP ID(페더레이션 설정에 있음), 그 뒤에 '/', IdP 사용자 이름
SCRAM-SHA awsIAMType, x509유형, ldapAuthType, oidcAuthType none 영숫자 문자열
x509Type
문자열
기본값입니다: "NONE"
열거형: "NONE" "CUSTOMER" "MANAGED"

MongoDB Cloud에서 데이터베이스 사용자를 인증하는 데 사용하는 X.509 메서드.

  • 애플리케이션 관리형 X.509의 경우 MANAGED를 지정합니다.
  • 자체 관리형 X.509의 경우 CUSTOMER를 지정합니다.

CUSTOMER 메서드로 생성한 사용자는 사용자 이름 매개 변수에 CN(일반 이름) 이 있어야 합니다. $external 데이터베이스에 외부에서 인증된 사용자를 생성해야 합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제

AWS IAM 인증

{
  • "awsIAMType": "USER",
  • "databaseName": "$external",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "links": [],
  • "oidcAuthType": "NONE",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "string",
  • "x509Type": "NONE"
}

1개의 프로젝트에서 1명의 데이터베이스 사용자 제거

지정된 프로젝트에서 데이터베이스 사용자 한 명을 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

databaseName
필수
문자열

데이터베이스 사용자가 인증하는 데이터베이스입니다. 데이터베이스 사용자는 사용자 이름과 인증 데이터베이스를 모두 제공해야 MongoDB에 로그인할 수 있습니다. 사용자가 AWS IAM으로 인증하는 경우 x.509, LDAP 또는 OIDC 워크로드 이 값은 $external 이어야 합니다. 사용자가 SCRAM-SHA 또는 OIDC Workforce로 인증하는 경우 이 값은 admin 이어야 합니다.

사용자 이름
필수
문자열
예시: SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName

MongoDB에 인증하는 사용자를 나타내는 인간 판독 가능 레이블. 이 레이블의 형식은 인증 방법에 따라 다릅니다.

인증 방법 필요한 매개 변수 매개 변수 값 username 형식
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType 사용자 ARN
x.509 x509Type CUSTOMER RFC 2253 고유 이름
x.509 x509Type MANAGED RFC 2253 고유 이름
LDAP ldapAuthType 사용자 RFC 2253 고유 이름
LDAP ldapAuthType GROUP RFC 2253 고유 이름
OIDC 인력 oidcAuthType IDP_GROUP Atlas OIDC IdP ID(페더레이션 설정)에 빗금 기호('/')와 IdP 그룹 이름을 합친 값
OIDC 워크로드 oidcAuthType 사용자 Atlas OIDC IdP ID(페더레이션 설정에 있음), 그 뒤에 '/', IdP 사용자 이름
SCRAM-SHA awsIAMType, x509유형, ldapAuthType, oidcAuthType none 영숫자 문자열
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 프로젝트에서 1명의 데이터베이스 사용자 반환

지정된 프로젝트에 속한 데이터베이스 사용자 한 명을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

databaseName
필수
문자열

데이터베이스 사용자가 인증하는 데이터베이스입니다. 데이터베이스 사용자는 사용자 이름과 인증 데이터베이스를 모두 제공해야 MongoDB에 로그인할 수 있습니다. 사용자가 AWS IAM으로 인증하는 경우 x.509, LDAP 또는 OIDC 워크로드 이 값은 $external 이어야 합니다. 사용자가 SCRAM-SHA 또는 OIDC Workforce로 인증하는 경우 이 값은 admin 이어야 합니다.

사용자 이름
필수
문자열
예시: SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName

MongoDB에 인증하는 사용자를 나타내는 인간 판독 가능 레이블. 이 레이블의 형식은 인증 방법에 따라 다릅니다.

인증 방법 필요한 매개 변수 매개 변수 값 username 형식
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType 사용자 ARN
x.509 x509Type CUSTOMER RFC 2253 고유 이름
x.509 x509Type MANAGED RFC 2253 고유 이름
LDAP ldapAuthType 사용자 RFC 2253 고유 이름
LDAP ldapAuthType GROUP RFC 2253 고유 이름
OIDC 인력 oidcAuthType IDP_GROUP Atlas OIDC IdP ID(페더레이션 설정)에 빗금 기호('/')와 IdP 그룹 이름을 합친 값
OIDC 워크로드 oidcAuthType 사용자 Atlas OIDC IdP ID(페더레이션 설정에 있음), 그 뒤에 '/', IdP 사용자 이름
SCRAM-SHA awsIAMType, x509유형, ldapAuthType, oidcAuthType none 영숫자 문자열
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "links": [],
  • "oidcAuthType": "NONE",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "string",
  • "x509Type": "NONE"
}

1개의 프로젝트에서 1명의 데이터베이스 사용자 업데이트

지정된 프로젝트에 속한 데이터베이스 사용자 한 명을 업데이트합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 소유자 또는 프로젝트 차트 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

databaseName
필수
문자열

데이터베이스 사용자가 인증하는 데이터베이스입니다. 데이터베이스 사용자는 사용자 이름과 인증 데이터베이스를 모두 제공해야 MongoDB에 로그인할 수 있습니다. 사용자가 AWS IAM으로 인증하는 경우 x.509, LDAP 또는 OIDC 워크로드 이 값은 $external 이어야 합니다. 사용자가 SCRAM-SHA 또는 OIDC Workforce로 인증하는 경우 이 값은 admin 이어야 합니다.

사용자 이름
필수
문자열
예시: SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName

MongoDB에 인증하는 사용자를 나타내는 인간 판독 가능 레이블. 이 레이블의 형식은 인증 방법에 따라 다릅니다.

인증 방법 필요한 매개 변수 매개 변수 값 username 형식
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType 사용자 ARN
x.509 x509Type CUSTOMER RFC 2253 고유 이름
x.509 x509Type MANAGED RFC 2253 고유 이름
LDAP ldapAuthType 사용자 RFC 2253 고유 이름
LDAP ldapAuthType GROUP RFC 2253 고유 이름
OIDC 인력 oidcAuthType IDP_GROUP Atlas OIDC IdP ID(페더레이션 설정)에 빗금 기호('/')와 IdP 그룹 이름을 합친 값
OIDC 워크로드 oidcAuthType 사용자 Atlas OIDC IdP ID(페더레이션 설정에 있음), 그 뒤에 '/', IdP 사용자 이름
SCRAM-SHA awsIAMType, x509유형, ldapAuthType, oidcAuthType none 영숫자 문자열
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 속한 데이터베이스 사용자 한 명을 업데이트합니다.

awsIAMType
문자열
기본값입니다: "NONE"
열거형: "NONE" "USER" "ROLE"

새 데이터베이스 사용자가 사용자 또는 사용자의 역할과 연결된 AWS(Amazon Web Services) IAM(ID 및 액세스 관리) 자격 증명으로 인증하는지 여부를 나타내는 인간 판독 가능 레이블.

databaseName
필수
문자열
기본값입니다: "admin"
열거형: "admin" "$external"

데이터베이스 사용자가 인증하는 데이터베이스입니다. 데이터베이스 사용자는 사용자 이름과 인증 데이터베이스를 모두 제공해야 MongoDB에 로그인할 수 있습니다. 사용자가 AWS IAM으로 인증하는 경우 x.509, LDAP 또는 OIDC 워크로드 이 값은 $external 이어야 합니다. 사용자가 SCRAM-SHA 또는 OIDC Workforce로 인증하는 경우 이 값은 admin 이어야 합니다.

deleteAfterDate
문자열 <date-time>

MongoDB Cloud가 사용자를 삭제한 날짜 및 시간. 이 매개 변수는 값을 UTC의 ISO 8601 타임스탬프 형식으로 표현하며 표준 시간대 지정을 포함할 수 있습니다. API(애플리케이션 프로그래밍 인터페이스) 요청 후 1주일 이내의 미래 날짜를 지정해야 합니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$

프로젝트를 식별하는 고유한 24자리 16진수 문자열.

의 배열 개체 (컴포넌트 레이블)

MongoDB 데이터베이스 사용자를 태그 지정하고 분류하는 키-값 쌍이 포함된 목록. 사용자가 정의한 레이블은 콘솔에 표시되지 않습니다.

ldapAuthType
문자열
기본값입니다: "NONE"
열거형: "NONE" "GROUP" "USER"

데이터베이스가 LDAP(경량 디렉토리 액세스 프로토콜) 호스트에서 이 데이터베이스 사용자를 인증하는 데 사용하는 LDAP 기록의 일부.

oidcAuthType
문자열
기본값입니다: "NONE"
열거형: "NONE" "IDP_GROUP" "USER"

새 데이터베이스 사용자 또는 그룹이 OIDC 페더레이션 인증으로 인증하는지 여부를 나타내는 사람이 읽을 수 있는 레이블입니다. 페더레이션 인증 사용자를 생성하려면 이 필드에 USER 값을 지정합니다. 페더레이션 인증 그룹을 생성하려면 이 필드에 IDP_GROUP 값을 지정합니다.

비밀번호
문자열 8자 이상

databaseName에 지정된 데이터베이스에 대해 이 데이터베이스 사용자를 인증하는 영숫자 문자열. SCRAM-SHA로 인증하려면 이 매개 변수를 지정해야 합니다. 이 매개 변수는 이 응답에 나타나지 않습니다.

SCRAM-SHA
의 배열 개체 (데이터베이스 사용자 역할)

하나의 역할과 하나의 적용 가능한 데이터베이스의 쌍을 제공하는 목록.

의 배열 개체 (데이터베이스 사용자 범위)

이 데이터베이스 사용자가 액세스할 수 있는 클러스터, MongoDB Atlas Data Lakes 및 MongoDB Atlas Streams 인스턴스가 포함된 목록입니다. 생략하면 MongoDB Cloud는 데이터베이스 사용자에게 프로젝트의 모든 클러스터, MongoDB Atlas Data Lakes 및 MongoDB Atlas Streams 인스턴스에 대한 액세스 권한을 부여합니다.

사용자 이름
필수
문자열 1024자 이하

MongoDB에 인증하는 사용자를 나타내는 인간 판독 가능 레이블. 이 레이블의 형식은 인증 방법에 따라 다릅니다.

인증 방법 필요한 매개 변수 매개 변수 값 username 형식
AWS IAM awsIAMType ROLE ARN
AWS IAM awsIAMType 사용자 ARN
x.509 x509Type CUSTOMER RFC 2253 고유 이름
x.509 x509Type MANAGED RFC 2253 고유 이름
LDAP ldapAuthType 사용자 RFC 2253 고유 이름
LDAP ldapAuthType GROUP RFC 2253 고유 이름
OIDC 인력 oidcAuthType IDP_GROUP Atlas OIDC IdP ID(페더레이션 설정)에 빗금 기호('/')와 IdP 그룹 이름을 합친 값
OIDC 워크로드 oidcAuthType 사용자 Atlas OIDC IdP ID(페더레이션 설정에 있음), 그 뒤에 '/', IdP 사용자 이름
SCRAM-SHA awsIAMType, x509유형, ldapAuthType, oidcAuthType none 영숫자 문자열
x509Type
문자열
기본값입니다: "NONE"
열거형: "NONE" "CUSTOMER" "MANAGED"

MongoDB Cloud에서 데이터베이스 사용자를 인증하는 데 사용하는 X.509 메서드.

  • 애플리케이션 관리형 X.509의 경우 MANAGED를 지정합니다.
  • 자체 관리형 X.509의 경우 CUSTOMER를 지정합니다.

CUSTOMER 메서드로 생성한 사용자는 사용자 이름 매개 변수에 CN(일반 이름) 이 있어야 합니다. $external 데이터베이스에 외부에서 인증된 사용자를 생성해야 합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "oidcAuthType": "NONE",
  • "password": "stringst",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "string",
  • "x509Type": "NONE"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "awsIAMType": "NONE",
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "labels": [
    ],
  • "ldapAuthType": "NONE",
  • "links": [],
  • "oidcAuthType": "NONE",
  • "roles": [
    ],
  • "scopes": [
    ],
  • "username": "string",
  • "x509Type": "NONE"
}

고객 키 관리를 사용한 미사용 암호화

고객 키 관리 구성을 사용하여 저장 데이터 암호화를 반환하고 편집합니다. MongoDB Cloud는 자체 키 관리 사용 여부와 관계없이 모든 스토리지를 암호화합니다.

1개의 프로젝트에 고객 관리형 키를 사용하여 미사용 데이터 암호화에 대해 1개의 구성 반환

클라우드 공급자를 통해 관리하는 키를 사용하여 미사용 데이터 암호화에 대한 구성을 반환합니다. MongoDB Cloud는 자체 키 관리를 사용하지 않더라도 모든 스토리지를 암호화합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

M10 이상 한정: MongoDB Cloud는 이 기능을 M10 이상의 전용 클러스터 계층에만 한정합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "awsKms": {
    },
  • "azureKeyVault": {},
  • "googleCloudKms": {
    }
}

1개의 프로젝트에 고객 관리형 키를 사용하여 미사용 데이터 암호화에 대해 구성 업데이트

클라우드 공급자를 통해 관리하는 키를 사용하여 미사용 데이터 암호화에 대한 구성을 업데이트합니다. MongoDB Cloud는 자체 키 관리를 사용하지 않더라도 모든 스토리지를 암호화합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 이 기능은 M0 무료 클러스터, M2, M5 또는 서버리스 클러스터에는 사용할 수 없습니다.

MongoDB Cloud 프로젝트에 대해 고객 키 관리 공급자를 사용하여 하나 이상의 저장소 암호화를 구성하면 프로젝트 소유자는 암호화가 필요한 각 MongoDB Cloud 클러스터에 대해 고객 키 관리를 사용하여 저장소 암호화를 사용하도록 설정할 수 있습니다. 고객 키 관리 제공자를 사용하는 미사용 데이터 암호화는 클러스터 클라우드 서비스 제공자와 일치하지 않아도 됩니다. MongoDB Cloud는 사용자가 관리하는 암호화 키를 자동으로 회전하지 않습니다. 고객 키 관리 제공업체의 설명서 및 키 순환 권장사항 지침을 참조하여 선호하는 미사용 데이터 암호화 방식을 따르세요. MongoDB Cloud 프로젝트의 키 관리를 사용하는 고객 키 관리를 사용하여 미사용 데이터 암호화를 구성하면 MongoDB Cloud는 90일 키 순환 알림을 자동으로 생성합니다. MongoDB Cloud는 자체 키 관리 사용 여부와 관계없이 모든 스토리지를 암호화합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

필수 매개 변수는 고객 키 관리를 사용하여 미사용 데이터 암호화를 사용하도록 설정했는지 여부에 따라 다릅니다.

CMK(고객 키 관리)를 사용하여 저장 시 암호화를 사용하도록 설정한 경우 Atlas는 원하는 암호화 공급자에 대한 모든 매개 변수를 요구합니다.

  • AWS KMS(키 관리 서비스)를 사용하려면 MongoDB Cloud에서 awsKms 객체에 모든 필드가 제공되어야 합니다.
  • Azure Key Vault를 사용하려면 MongoDB Cloud에서 azureKeyVault 객체에 모든 필드가 제공되어야 합니다.
  • Google Cloud KMS(키 관리 서비스)를 사용하려면 MongoDB Cloud에서 googleCloudKms 객체에 모든 필드가 제공되어야 합니다.

고객 키 관리를 사용하여 미사용 데이터 암호화를 사용하도록 설정한 경우 관리자는 awsKms, azureKeyVault 또는 googleCloudKms 객체에서 변경된 필드만 전달하여 이 엔드포인트에 구성을 업데이트할 수 있습니다.

객체 (AWSKMSConfiguration)

AWS(Amazon Web Services) KMS 구성 세부 정보 및 지정된 프로젝트에 설정된 미사용 데이터 암호화 구성.

Amazon Web Services 키 관리 서비스
객체 (AzureKeyVault)

AKV(Azure Key Vault)를 사용한 미사용 데이터 암호화 구성을 정의하는 세부 정보.

Azure 키 볼트
객체 (GoogleCloudKMS)

Google Cloud KMS(키 관리 서비스)를 사용한 미사용 데이터 암호화 구성을 정의하는 세부 정보.

Google Cloud 키 관리 서비스

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "awsKms": {
    },
  • "azureKeyVault": {},
  • "googleCloudKms": {
    }
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "awsKms": {
    },
  • "azureKeyVault": {},
  • "googleCloudKms": {
    }
}

이벤트

이벤트를 반환합니다. 이 컬렉션은 계속 수정되며 변경될 수 있습니다.

1개의 프로젝트에서 모든 이벤트 반환

지정된 프로젝트에 대한 이벤트 하나를 반환합니다. 이벤트는 중요한 데이터베이스, 청구 또는 보안 활동이나 상태 변경을 식별합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

clusterNames
의 배열 strings[ 항목 [ 1 .. 64 ]자^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

의 배열 경고 감사 유형(객체) 또는 경고 감사 유형(객체) 또는 API 사용자 이벤트 유형(객체) 또는 서비스 계정 이벤트 유형(객체) 또는 App Services 이벤트 유형(객체) 또는 자동 인덱싱 이벤트 유형(객체) 또는 자동화 구성 이벤트 유형 (객체) 또는 AWS 피어 Vpc 감사 유형(객체) 또는 Azure 피어 네트워크 감사 유형(객체) 또는 청구 이벤트 유형(객체) 또는 클러스터 연결 감사 유형(객체) 또는 클러스터 이벤트 유형(객체) 또는 Cps 백업 이벤트 유형(객체) ) 또는 데이터 탐색기 액세스 이벤트 유형(객체) 또는 CPS 백업 컴플라이언스 정책 이벤트 유형(객체) 또는 디스크 백업 이벤트 유형(객체) 또는 암호화 이벤트 유형(객체) 또는 내보내기 버킷 감사 유형(객체) 또는 FTS 인덱스 감사 유형(객체) ) 또는 GCP 피어 Vpc 감사 유형(객체) 또는 그룹 감사 유형(객체) 또는 그룹 이벤트 유형(객체) 또는 그룹 통합 이벤트 유형(객체) 또는 호스트 이벤트 유형(객체) 또는 호스트 지표 이벤트 유형(객체) 또는 인덱스 빌드 감사 유형(객체) 또는 NDS 감사 유형(객체) 또는 NDS DB Check Audi t 유형(객체) 또는 NDS 데이터 유효성 검사 유형(객체) 또는 NDS 자동 확장 감사 유형(객체) 또는 NDS 유지 관리 기간 감사 유형(객체) 또는 NDS 서버리스 자동 확장 감사 유형(객체) 또는 NDS 서버리스 인스턴스 감사 유형(객체) ) 또는 NDS 자동 확장 감사 유형(객체) 또는 NDS 테넌트 엔드포인트 서비스 배포 감사 유형(객체) 또는 NDS x509 사용자 인증 이벤트 유형(객체) 또는 온라인 아카이브 이벤트 유형(객체) 또는 비공개 링크 감사 유형(객체) 또는 사전 작업 이벤트 유형(객체) 또는 ReplicaSet 이벤트 유형(객체) 또는 서버리스 배포 감사 유형(객체) 또는 서버리스 이벤트 유형(객체) 또는 설정 서버리스 감사 유형(객체) 또는 Streams 이벤트 유형(객체) 또는 스트림 프로세서 이벤트 유형 (객체) 또는 지원 사례 이벤트 유형(객체) 또는 지원 이벤트 유형(객체) 또는 팀 이벤트 유형(객체) 또는 테넌트 백업 이벤트 유형(객체) 또는 사용자 이벤트 유형(객체) 또는 버전 감사 유형(객체) 또는 리소스 이벤트 유형(객체) (EventTypeForNdsGroup)

현재 시점에 기록된 인시던트의 카테고리.

중요: 이벤트 유형 값의 전체 목록은 자주 변경됩니다.

의 배열 경고 감사 유형(객체) 또는 경고 감사 유형(객체) 또는 API 사용자 이벤트 유형(객체) 또는 서비스 계정 이벤트 유형(객체) 또는 App Services 이벤트 유형(객체) 또는 자동 인덱싱 이벤트 유형(객체) 또는 자동화 구성 이벤트 유형 (객체) 또는 AWS 피어 Vpc 감사 유형(객체) 또는 Azure 피어 네트워크 감사 유형(객체) 또는 청구 이벤트 유형(객체) 또는 클러스터 연결 감사 유형(객체) 또는 클러스터 이벤트 유형(객체) 또는 Cps 백업 이벤트 유형(객체) ) 또는 데이터 탐색기 액세스 이벤트 유형(객체) 또는 CPS 백업 컴플라이언스 정책 이벤트 유형(객체) 또는 디스크 백업 이벤트 유형(객체) 또는 암호화 이벤트 유형(객체) 또는 내보내기 버킷 감사 유형(객체) 또는 FTS 인덱스 감사 유형(객체) ) 또는 GCP 피어 Vpc 감사 유형(객체) 또는 그룹 감사 유형(객체) 또는 그룹 이벤트 유형(객체) 또는 그룹 통합 이벤트 유형(객체) 또는 호스트 이벤트 유형(객체) 또는 호스트 지표 이벤트 유형(객체) 또는 인덱스 빌드 감사 유형(객체) 또는 NDS 감사 유형(객체) 또는 NDS DB Check Audi t 유형(객체) 또는 NDS 데이터 유효성 검사 유형(객체) 또는 NDS 자동 확장 감사 유형(객체) 또는 NDS 유지 관리 기간 감사 유형(객체) 또는 NDS 서버리스 자동 확장 감사 유형(객체) 또는 NDS 서버리스 인스턴스 감사 유형(객체) ) 또는 NDS 자동 확장 감사 유형(객체) 또는 NDS 테넌트 엔드포인트 서비스 배포 감사 유형(객체) 또는 NDS x509 사용자 인증 이벤트 유형(객체) 또는 온라인 아카이브 이벤트 유형(객체) 또는 비공개 링크 감사 유형(객체) 또는 사전 작업 이벤트 유형(객체) 또는 ReplicaSet 이벤트 유형(객체) 또는 서버리스 배포 감사 유형(객체) 또는 서버리스 이벤트 유형(객체) 또는 설정 서버리스 감사 유형(객체) 또는 Streams 이벤트 유형(객체) 또는 스트림 프로세서 이벤트 유형 (객체) 또는 지원 사례 이벤트 유형(객체) 또는 지원 이벤트 유형(객체) 또는 팀 이벤트 유형(객체) 또는 테넌트 백업 이벤트 유형(객체) 또는 사용자 이벤트 유형(객체) 또는 버전 감사 유형(객체) 또는 리소스 이벤트 유형(객체) (EventTypeForNdsGroup)

쿼리 결과에서 제외하려는 이벤트 카테고리(CLUSTER_CREATED 등)

중요: 이벤트 유형 이름은 자주 변경됩니다. 이벤트 유형의 전체 목록을 확인하여 이벤트 유형을 올바르게 지정했는지 확인하세요.

includeRaw
부울
기본값입니다: 거짓

출력에 원시 문서를 포함할지 여부를 나타내는 플래그. 원시 문서에는 이벤트의 추가 메타 정보가 포함되어 있습니다.

maxDate
문자열 <date-time>

MongoDB Cloud가 이벤트 반환을 중지한 날짜 및 시간. 이 매개 변수는 UTC의 ISO 8601 타임스탬프 형식을 사용합니다.

minDate
문자열 <date-time>

MongoDB Cloud가 이벤트를 반환하기 시작한 날짜 및 시간. 이 매개 변수는 UTC의 ISO 8601 타임스탬프 형식을 사용합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 프로젝트에서 1개의 이벤트 반환

지정된 프로젝트에 대한 이벤트 하나를 반환합니다. 이벤트는 중요한 데이터베이스, 청구 또는 보안 활동이나 상태 변경을 식별합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

eventId
필수
문자열 = 24자 ^([a-f0-9]{24})$

반환하려는 이벤트를 식별하는 고유한 24자리 16진수 문자열. /events 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 이벤트를 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

includeRaw
부울
기본값입니다: 거짓

출력에 원시 문서를 포함할지 여부를 나타내는 플래그. 원시 문서에는 이벤트의 추가 메타 정보가 포함되어 있습니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "apiKeyId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "AUTO_INDEXING_ENABLED",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "isGlobalAdmin": false,
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "publicKey": "test.user@mongodb.com",
  • "raw": {
    },
  • "remoteAddress": "216.172.40.186",
  • "userId": "32b6e34b3d91647abb20e7b8",
  • "username": "test.user@mongodb.com"
}

1개의 조직에서 모든 이벤트 반환

지정된 조직의 모든 이벤트를 반환합니다. 이벤트는 중요한 데이터베이스, 청구 또는 보안 활동이나 상태 변경을 식별합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

의 배열 경고 감사 유형(객체) 또는 경고 감사 유형(객체) 또는 API 사용자 이벤트 유형(객체) 또는 서비스 계정 이벤트 유형(객체) 또는 청구 이벤트 유형(객체) 또는 페더레이션 설정 이벤트 유형(객체) 또는 그룹 감사 유형(객체) ) 또는 Mlab 마이그레이션 감사 유형(객체) 또는 NDS 감사 유형(객체) 또는 조직 이벤트 유형(객체) 또는 파트너 이벤트 유형(객체) 또는 지원 이벤트 유형(객체) 또는 팀 이벤트 유형(객체) 또는 사용자 이벤트 유형(객체) ) 또는 리소스 이벤트 유형(객체) (EventTypeForOrg)

현재 시점에 기록된 인시던트의 카테고리.

중요: 이벤트 유형 값의 전체 목록은 자주 변경됩니다.

includeRaw
부울
기본값입니다: 거짓

출력에 원시 문서를 포함할지 여부를 나타내는 플래그. 원시 문서에는 이벤트의 추가 메타 정보가 포함되어 있습니다.

maxDate
문자열 <date-time>

MongoDB Cloud가 이벤트 반환을 중지한 날짜 및 시간. 이 매개 변수는 UTC의 ISO 8601 타임스탬프 형식을 사용합니다.

minDate
문자열 <date-time>
예시: minDate=2021-11-17T23:15:00.06Z

MongoDB Cloud가 이벤트를 반환하기 시작한 날짜 및 시간. 이 매개 변수는 UTC의 ISO 8601 타임스탬프 형식을 사용합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 조직에서 1개의 이벤트 반환

지정된 조직의 이벤트 하나를 반환합니다. 이벤트는 중요한 데이터베이스, 청구 또는 보안 활동이나 상태 변경을 식별합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

이 리소스는 계속 수정되며 변경될 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

eventId
필수
문자열 = 24자 ^([a-f0-9]{24})$

반환하려는 이벤트를 식별하는 고유한 24자리 16진수 문자열. /events 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 이벤트를 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

includeRaw
부울
기본값입니다: 거짓

출력에 원시 문서를 포함할지 여부를 나타내는 플래그. 원시 문서에는 이벤트의 추가 메타 정보가 포함되어 있습니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "apiKeyId": "32b6e34b3d91647abb20e7b8",
  • "created": "2019-08-24T14:15:22Z",
  • "eventTypeName": "FEDERATION_SETTINGS_CREATED",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "isGlobalAdmin": false,
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "publicKey": "test.user@mongodb.com",
  • "raw": {
    },
  • "remoteAddress": "216.172.40.186",
  • "userId": "32b6e34b3d91647abb20e7b8",
  • "username": "test.user@mongodb.com"
}

페더레이션 인증

역할 매핑 및 연결된 조직 구성과 같은 연합 관련 기능을 반환, 추가, 편집 및 제거합니다.

1개의 페더레이션 설정 인스턴스 삭제

연합 설정 인스턴스와 모든 관련 데이터(ID 공급자 및 도메인 등)를 삭제합니다. 이 리소스를 사용하려면 요청하는 API 키에 마지막으로 연결된 조직의 소유자 역할이 있어야 합니다. 참고: 연합에 연결된 조직이 두 개 이상 있는 경우 이 리소스에 대한 요청이 실패합니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1개의 페더레이션에서 연결된 모든 조직 구성 반환

지정된 연합에 연결된 모든 조직 구성을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 연결된 조직 중 하나의 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 페더레이션에 연결된 1개의 조직 구성 제거

지정된 연합에서 연결된 조직 구성 하나를 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다. 참고: 연합에 연결된 조직이 하나만 있는 경우 이 요청이 실패합니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

제거할 연결된 조직 구성을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 페더레이션에 연결된 1개의 조직 구성 반환

지정된 연합에서 지정된 연결된 조직 구성을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 연결된 조직의 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

반환할 연결된 조직 구성을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

1개의 페더레이션에 연결된 1개의 조직 구성 업데이트

지정된 연합에서 연결된 조직 구성 한 개를 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

참고: 조직 구성에 연결된 ID 제공자가 없는 경우 이 리소스를 사용하여 역할 매핑을 업데이트하거나 승인 역할 부여를 게시할 수 없습니다.

참고: domainRestrictionEnabled 필드는 요청에 제공되지 않은 경우 기본값 'false'로 설정됩니다.

참고: identityProviderId 필드를 제공하지 않으면 조직과 ID 공급업체의 연결이 끊어집니다.

참고: 현재 연결된 데이터 액세스 ID 제공자가 dataAccessIdentityProviderIds 필드에서 누락된 경우 연결이 끊어집니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

업데이트할 연결된 조직 구성을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

업데이트하려는 연결된 조직 구성.

dataAccessIdentityProviderIds
의 배열 strings unique [ 항목 = 24자 ^([a-f0-9]{24})$ ]

이 조직에서 데이터 액세스에 사용할 수 있는 ID 제공자를 나타내는 고유 ID 컬렉션.

domainAllowList
의 배열 strings unique

이메일 주소를 기반으로 조직에 가입할 수 있는 사용자를 제한하는 승인된 도메인입니다.

domainRestrictionEnabled
필수
부울

이 연결된 조직의 도메인 제한 사용 설정 여부를 나타내는 값.

identityProviderId
문자열 = 20자 ^([a-f0-9]{20})$

레거시 20- 연결된 이 조직 구성이 연결된 UI 액세스 ID 제공자를 식별하는 16진수 문자열입니다. 이 ID는 Federation Management Console(페더레이션 관리 콘솔) > Identity Providers(ID 제공자) 탭 내에서 구성된 ID 제공자의 IdP ID 행에 있는 정보 아이콘을 클릭하여 찾을 수 있습니다.

postAuthRoleGrants
의 배열 strings unique
항목 열거형: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_BILLING_READ_ONLY" "ORG_READ_ONLY"

인증 후 이 조직의 사용자에게 부여되는 Atlas 역할. 역할은 MongoDB Cloud가 특정 MongoDB Cloud 사용자에게 부여하는 권한 모음을 식별하는 인간 판독 가능 레이블입니다. 이러한 역할은 조직별 역할만 가능합니다.

의 배열 개체 (연합 인증 역할 매핑) unique

이 조직에 구성된 역할 매핑입니다.

의 배열 개체 (연합 사용자)

허용 목록에 있는 어떤 도메인과도 일치하지 않는 이메일 주소를 가진 사용자가 포함된 목록.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "dataAccessIdentityProviderIds": [
    ],
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

1개의 조직에서 모든 역할 매핑 반환

지정된 연합의 지정된 조직에서 모든 역할 매핑을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 조직에 1개의 역할 매핑 추가

지정된 연합의 지정된 조직에 역할 매핑을 하나 추가합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

만들려는 역할 매핑.

externalGroupName
필수
문자열 [1 ... 200 ]자

이 역할 매핑이 적용되는 ID 공급자 그룹을 식별하는 사람이 읽을 수 있는 고유한 레이블입니다.

의 배열 개체 (RoleAssignment) unique

Atlas 역할과 각 역할과 연관된 그룹 및 조직의 고유 식별자입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "externalGroupName": "string",
  • "roleAssignments": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "externalGroupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "roleAssignments": [
    ]
}

1개의 조직에서 1개의 역할 매핑 제거

지정된 연합의 지정된 조직에서 역할 매핑 하나를 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

id
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

제거하려는 역할 매핑을 식별하는 고유한 24자리 16진수 문자열.

orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1개의 조직에서 1개의 역할 매핑 반환

지정된 연합의 지정된 조직에서 역할 매핑 하나를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

id
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

반환하려는 역할 매핑을 식별하는 고유한 24자리 16진수 문자열.

orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "externalGroupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "roleAssignments": [
    ]
}

1개의 조직에서 1개의 역할 매핑 업데이트

지정된 연합의 지정된 조직에 있는 역할 매핑 하나를 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

id
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

업데이트하려는 역할 매핑을 식별하는 고유한 24자리 16진수 문자열.

orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

업데이트하려는 역할 매핑.

externalGroupName
필수
문자열 [1 ... 200 ]자

이 역할 매핑이 적용되는 ID 공급자 그룹을 식별하는 사람이 읽을 수 있는 고유한 레이블입니다.

의 배열 개체 (RoleAssignment) unique

Atlas 역할과 각 역할과 연관된 그룹 및 조직의 고유 식별자입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "externalGroupName": "string",
  • "roleAssignments": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "externalGroupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "roleAssignments": [
    ]
}

1개의 페더레이션에서 모든 ID 제공자 반환

지정된 연합에서 제공된 프로토콜 및 유형을 가진 모든 ID 제공자를 반환합니다. 프로토콜이 지정되지 않으면 SAML ID 제공자만 반환됩니다. idpType을 지정하지 않으면 WORKFORCE ID 제공자만 반환됩니다. 이 리소스를 사용하려면 요청 API 키에 연결된 조직 중 하나의 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

protocol
의 배열 strings
항목 열거형: "SAML" "OIDC"

대상 ID 제공자의 프로토콜.

idpType
의 배열 strings
항목 열거형: "WORKFORCE" "WORKLOAD"

대상 ID 제공자의 유형입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 ID 제공자 만들기

지정된 연합에서 ID 제공자 하나를 생성합니다. 이 리소스를 사용하려면 요청 API 키에 연결된 조직 중 하나의 조직 소유자 역할이 있어야 합니다.

참고: 이 리소스는 OIDC ID 제공자 생성만 지원합니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-11-15+json

업데이트하려는 ID 제공자입니다.

다음 중 하나
associatedDomains
의 배열 strings unique

ID 제공자와 연결된 도메인이 포함된 목록.

오디언스
문자열

토큰을 받을 수신자의 식별자입니다.

authorizationType
문자열
열거형: "GROUP" "USER"

그룹 멤버십 또는 사용자 ID를 기준으로 권한이 부여되는지 여부를 나타냅니다.

clientId
문자열

ID 제공자가 애플리케이션에 할당한 클라이언트 식별자입니다.

description
문자열

ID 제공자에 대한 설명.

displayName
문자열 [1 ... 50 ]자

ID 공급자를 식별하는 인간 판독 가능 레이블.

groupsClaim
문자열

토큰에 IdP 그룹 ID가 포함된 클레임의 식별자입니다.

idpType
문자열
열거형: "WORKFORCE" "WORKLOAD"

ID 제공자의 유형을 나타내는 문자열 열거형. 기본값은 WORKFORCE입니다.

issuerUri
문자열

SAML 어설션 또는 OIDC 메타데이터/검색 문서 URL의 발급자를 식별하는 고유한 문자열.

protocol
문자열

ID 제공자의 프로토콜. SAML 또는 OIDC가 될 수 있습니다.

requestedScopes
의 배열 strings

MongoDB 애플리케이션이 권한 부여 엔드포인트에서 요청할 범위입니다.

userClaim
문자열

토큰에 사용자 ID를 포함하는 클레임의 식별자입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
예제
{
  • "associatedDomains": [
    ],
  • "audience": "string",
  • "authorizationType": "GROUP",
  • "clientId": "string",
  • "description": "string",
  • "displayName": "string",
  • "groupsClaim": "string",
  • "idpType": "WORKFORCE",
  • "issuerUri": "urn:idp:default",
  • "protocol": "string",
  • "requestedScopes": [
    ],
  • "userClaim": "string"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
예제
{
  • "associatedDomains": [
    ],
  • "associatedOrgs": [
    ],
  • "audience": "string",
  • "authorizationType": "GROUP",
  • "clientId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "displayName": "string",
  • "groupsClaim": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "idpType": "WORKFORCE",
  • "issuerUri": "string",
  • "oktaIdpId": "stringstringstringst",
  • "protocol": "string",
  • "requestedScopes": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "userClaim": "string"
}

1개의 ID 제공자 삭제

지정된 연합에서 ID 제공자 한 명을 업데이트합니다. 이 리소스를 사용하려면 요청 API 키에 연결된 조직 중 하나의 조직 소유자 역할이 있어야 합니다.

참고: ID 제공자에 연결된 조직이 있으면 이 리소스에 대한 요청이 실패합니다. ID 제공자를 삭제하기 전에 모든 조직의 연결을 끊고 계정의 어떤 조직도 이 ID 제공자를 사용하지 않는지 확인합니다. 자세한 내용은 페더레이션 인증을 위한 조직 매핑 관리를 참조하세요.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

identityProviderId
필수
문자열
예시: 32b6e34b3d91647abb20e7b8

연결할 ID 제공자를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

ID별로 1개의 ID 제공자 반환

ID 제공자의 ID로 지정된 연합의 ID 공급자 한 명을 반환합니다. 이 리소스를 사용하려면 요청 API 키에 연결된 조직 중 하나의 조직 소유자 역할이 있어야 합니다. 사용 중단된 버전: v2-{2023-01-01}

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

identityProviderId
필수
문자열
예시: 32b6e34b3d91647abb20e7b8

연결할 ID 제공자를 식별하는 고유 문자열입니다. 11-15-2023 이전의 API 버전을 사용하는 경우 레거시 20-16진수 ID를 사용합니다. 이 ID는 Federation Management Console(페더레이션 관리 콘솔) > Identity Providers(ID 제공자) 탭 내에서 구성된 ID 제공자의 IdP ID 행에 있는 정보 아이콘을 클릭하여 찾을 수 있습니다. 다른 모든 버전의 경우 24-16진수 ID를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
예제
{
  • "acsUrl": "string",
  • "associatedDomains": [
    ],
  • "associatedOrgs": [
    ],
  • "audienceUri": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "displayName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "idpType": "WORKFORCE",
  • "issuerUri": "string",
  • "oktaIdpId": "stringstringstringst",
  • "pemFileInfo": {
    },
  • "protocol": "string",
  • "requestBinding": "HTTP-POST",
  • "responseSignatureAlgorithm": "SHA-1",
  • "slug": "string",
  • "ssoDebugEnabled": true,
  • "ssoUrl": "string",
  • "status": "ACTIVE",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

1개의 ID 제공자 업데이트

지정된 연합에서 ID 제공자 한 명을 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 연결된 조직 중 하나의 조직 소유자 역할이 있어야 합니다.

참고: 권한 부여 유형 변경 및/또는 권한 부여 클레임 업데이트 시 현재 사용자 및/또는 그룹이 데이터베이스에 액세스하지 못할 수 있습니다. 사용 중단된 버전: v2-{2023-01-01}

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

identityProviderId
필수
문자열
예시: 32b6e34b3d91647abb20e7b8

연결할 ID 제공자를 식별하는 고유 문자열입니다. 11-15-2023 이전의 API 버전을 사용하는 경우 레거시 20-16진수 ID를 사용합니다. 이 ID는 Federation Management Console(페더레이션 관리 콘솔) > Identity Providers(ID 제공자) 탭 내에서 구성된 ID 제공자의 IdP ID 행에 있는 정보 아이콘을 클릭하여 찾을 수 있습니다. 다른 모든 버전의 경우 24-16진수 ID를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-11-15+json

업데이트하려는 ID 제공자.

다음 중 하나
associatedDomains
의 배열 strings unique

ID 제공자와 연결된 도메인이 포함된 목록.

description
문자열

ID 제공자에 대한 설명.

displayName
문자열 [1 ... 50 ]자

ID 공급자를 식별하는 인간 판독 가능 레이블.

idpType
문자열
열거형: "WORKFORCE" "WORKLOAD"

ID 제공자의 유형을 나타내는 문자열 열거형. 기본값은 WORKFORCE입니다.

issuerUri
문자열

SAML 어설션 또는 OIDC 메타데이터/검색 문서 URL의 발급자를 식별하는 고유한 문자열.

객체 (PemFileInfoUpdate)

ID 제공자의 현재 인증서에 대한 PEM 파일 정보.

protocol
문자열

ID 제공자의 프로토콜. SAML 또는 OIDC가 될 수 있습니다.

requestBinding
문자열
열거형: "HTTP-POST" "HTTP-REDIRECT"

연합 인증이 인증 요청을 보내는 데 사용하는 SAML 인증 요청 프로토콜 HTTP 메서드 바인딩(POST 또는 REDIRECT).

responseSignatureAlgorithm
문자열
열거형: "SHA-1" "SHA-256"

연합 인증이 ID 제공자 서명을 암호화하는 데 사용하는 서명 알고리즘.

slug
문자열

ID 제공자가 사용하는 사용자 지정 SSO URL입니다.

ssoDebugEnabled
필수
부울

ID 제공자의 SSO 디버그를 사용 설정 여부를 나타내는 플래그.

ssoUrl
문자열

SAML 인증 요청 수신자를 가리키는 URL.

상태
문자열
열거형: "ACTIVE" "INACTIVE"

ID 제공자의 활성 상태 여부를 나타내는 문자열 열거형.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
예제
{
  • "associatedDomains": [
    ],
  • "description": "string",
  • "displayName": "string",
  • "idpType": "WORKFORCE",
  • "issuerUri": "urn:idp:default",
  • "pemFileInfo": {
    },
  • "protocol": "string",
  • "requestBinding": "HTTP-POST",
  • "responseSignatureAlgorithm": "SHA-1",
  • "slug": "string",
  • "ssoDebugEnabled": true,
  • "ssoUrl": "https://example.com",
  • "status": "ACTIVE"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
예제
{
  • "acsUrl": "string",
  • "associatedDomains": [
    ],
  • "associatedOrgs": [
    ],
  • "audienceUri": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "displayName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "idpType": "WORKFORCE",
  • "issuerUri": "string",
  • "oktaIdpId": "stringstringstringst",
  • "pemFileInfo": {
    },
  • "protocol": "string",
  • "requestBinding": "HTTP-POST",
  • "responseSignatureAlgorithm": "SHA-1",
  • "slug": "string",
  • "ssoDebugEnabled": true,
  • "ssoUrl": "string",
  • "status": "ACTIVE",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

1개의 OIDC ID 제공자에서 JWKS 해지

요청된 OIDC ID 제공자로부터 JWKS 토큰을 해지합니다. 이 리소스를 사용하려면 요청 API 키에 연결된 조직 중 하나의 조직 소유자 역할이 있어야 합니다.

참고: JWKS 토큰을 해지하면 모든 Atlas 클러스터에서 IdP 공개 키가 즉시 새로 고침되어 이전에 서명된 액세스 토큰이 무효화되고 모든 사용자가 로그아웃됩니다. MongoDB 클라이언트를 다시 시작해야 할 수도 있습니다. ID 제공자와 연결된 모든 조직이 영향을 받게 됩니다. 자세한 내용은 OIDC 인증 구성을 참조하세요.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

identityProviderId
필수
문자열
예시: 32b6e34b3d91647abb20e7b8

연결할 ID 제공자를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1개의 ID 제공자의 메타데이터 반환

지정된 연합에 있는 ID 제공자 한 명의 메타데이터를 반환합니다. 이 리소스를 사용하려면 요청 API 키에 연결된 조직 중 하나의 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
federationSettingsId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 55fa922fb343282757d9554e

연합을 식별하는 고유한 24자리 16진수 문자열.

identityProviderId
필수
문자열 = 20자 ^([a-f0-9]{20})$
예시: c2777a9eca931f29fc2f

레거시 20-ID 제공자를 식별하는 16진수 문자열입니다. 이 ID는 Federation Management Console(페더레이션 관리 콘솔) > Identity Providers(ID 제공자) 탭 내에서 구성된 ID 제공자의 IdP ID 행에 있는 정보 아이콘을 클릭하여 찾을 수 있습니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
"string"

1개의 조직에 대해 페더레이션 설정 반환

지정한 조직의 연합 설정에 대한 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 연결된 조직의 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "federatedDomains": [
    ],
  • "hasRoleMappings": true,
  • "id": "32b6e34b3d91647abb20e7b8",
  • "identityProviderId": "c2777a9eca931f29fc2f",
  • "identityProviderStatus": "ACTIVE"
}

글로벌 클러스터

전역 클러스터 관리형 네임스페이스 및 사용자 지정 영역 매핑을 반환, 추가 및 제거합니다. 글로벌 클러스터의 각 컬렉션은 관리되는 네임스페이스와 연결됩니다. 글로벌 클러스터의 관리형 네임스페이스를 생성하면 MongoDB Cloud는 해당 네임스페이스에 대해 빈 컬렉션을 생성합니다. 관리되는 네임스페이스를 생성해도 컬렉션이 데이터로 채워지지는 않습니다. 마찬가지로 관리되는 네임스페이스를 삭제해도 연결된 컬렉션은 삭제되지 않습니다. MongoDB Cloud는 필수 위치 필드와 사용자 지정 샤드 키를 사용하여 빈 컬렉션을 샤딩합니다. 예를 들어 사용자 지정 샤드 키가 city이면 복합 샤드 키는 location, city입니다. 각 글로벌 클러스터는 하나 이상의 글로벌 쓰기 영역과도 연결됩니다. 사용자가 글로벌 클러스터를 생성하면 MongoDB Cloud는 각 위치 코드를 가장 가까운 지리적 영역에 자동으로 매핑합니다. 사용자 지정 영역 매핑을 통해 관리자는 이러한 자동 매핑을 재정의할 수 있습니다. 예를 들어, 사용 사례에서는 지리적으로 멀리 떨어진 구역에 위치 코드를 매핑해야 할 수도 있습니다. 관리자는 아래 API와 글로벌 클러스터를 생성하거나 수정할 때 글로벌 클러스터 구성 창을 사용하여 사용자 지정 영역 매핑을 관리할 수 있습니다.

1개의 글로벌 클러스터에서 1개의 관리형 네임스페이스 반환

지정된 글로벌 클러스터 내에서 관리되는 네임스페이스 하나를 반환합니다. 관리되는 네임스페이스는 데이터베이스 이름, 점 구분 기호 및 컬렉션 이름을 사용하여 컬렉션을 식별합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다. 사용 중단된 버전: v2-{2023-01-01}

글로벌 클러스터
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

이 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

1개의 글로벌 클러스터에서 모든 사용자 지정 영역 매핑 제거

지정된 글로벌 클러스터에 대한 모든 사용자 지정 영역 매핑을 제거합니다. 사용자 지정 영역 매핑은 하나의 ISO 3166-2 위치 코드를 글로벌 클러스터의 영역에 일치시킵니다. 사용자 정의 영역 매핑을 제거하면 기본 매핑이 복원됩니다. 기본적으로 MongoDB Cloud는 각 위치 코드를 가장 가까운 지리적 영역에 매핑합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 사용 중단된 버전: v2-{2023-01-01}

글로벌 클러스터
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

이 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

1개의 사용자 지정 영역 매핑에 1개의 항목 추가

지정된 글로벌 클러스터에 대해 하나의 사용자 지정 영역 매핑을 만듭니다. 사용자 지정 영역 매핑은 하나의 ISO 3166-2 위치 코드를 글로벌 클러스터의 영역에 일치시킵니다. 기본적으로 MongoDB Cloud는 각 위치 코드를 가장 가까운 지리적 영역에 매핑합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 사용 중단된 버전: v2-{2023-01-01}

글로벌 클러스터
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

이 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-02-01+json

지정된 글로벌 클러스터에 추가할 사용자 지정 영역 매핑.

의 배열 개체 (글로벌 클러스터 영역)

영역을 지리적 영역에 매핑하기 위해 쉼표로 구분된 키 값 쌍이 포함된 목록입니다. 이러한 쌍은 ISO 3166-1a2 위치 코드(가능한 경우 ISO 3166-2 세분화 코드 포함)를 원하는 사용자 지정 영역의 사람이 읽을 수 있는 레이블에 매핑합니다. MongoDB 클라우드는 기본적으로 ISO 3166-1a2 코드를 가장 가까운 지리적 영역에 매핑합니다. 이 매개변수를 포함하면 기본 매핑을 재정의할 수 있습니다.

이 매개변수는 사용자 지정 영역이 없는 경우 빈 객체를 반환합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "customZoneMappings": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

1개의 글로벌 클러스터에서 1개의 관리형 네임스페이스 제거

지정된 글로벌 클러스터 내에서 관리되는 네임스페이스를 하나 제거합니다. 관리되는 네임스페이스는 데이터베이스 이름, 점 구분자 및 컬렉션 이름을 사용하여 컬렉션을 식별합니다. 관리되는 네임스페이스를 삭제해도 연결된 컬렉션이나 데이터는 제거되지 않습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 데이터 액세스 관리자 역할이 있어야 합니다. 사용 중단된 버전: v2-{2023-01-01}

글로벌 클러스터
권한 부여
DigestAuth
경로 매개변수
clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

이 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

db
문자열

컬렉션이 포함된 데이터베이스를 식별하는 사람이 읽을 수 있는 라벨입니다.

컬렉션
문자열

관리형 네임스페이스와 연결된 컬렉션을 식별하는 사람이 읽을 수 있는 레이블입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

1개의 글로벌 클러스터에 1개의 관리형 네임스페이스 생성

지정된 글로벌 클러스터 내에 하나의 관리형 네임스페이스를 만듭니다. 관리되는 네임스페이스는 데이터베이스 이름, 점 구분 기호 및 컬렉션 이름을 사용하여 컬렉션을 식별합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 데이터 액세스 관리자 역할이 있어야 합니다. 사용 중단된 버전: v2-{2023-01-01}

글로벌 클러스터
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

이 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-02-01+json

지정된 글로벌 클러스터 내에 생성할 관리형 네임스페이스입니다.

컬렉션
문자열

이 글로벌 클러스터에 대해 관리할 컬렉션의 사람이 읽을 수 있는 레이블입니다.

customShardKey
문자열

컬렉션을 분할된 데이터베이스로 나누는 데 사용되는 데이터베이스 매개 변수입니다. 글로벌 클러스터에는 복합 샤드 키가 필요합니다. 이 복합 샤드 키는 위치 매개변수와 사용자가 선택한 사용자 정의 키를 결합합니다.

db
문자열

이 글로벌 클러스터에 대해 관리할 데이터베이스의 사람이 읽을 수 있는 레이블입니다.

isCustomShardKeyHashed
부울
기본값입니다: 거짓

누군가가 사용자 정의 분할 키를 해시했는지 여부를 나타내는 플래그입니다. 이 매개 변수가 false을 반환하면 이 클러스터는 범위 샤딩을 사용합니다.

isShardKeyUnique
부울
기본값입니다: 거짓

기본 인덱스가 고유 값을 적용하는지 여부를 나타내는 플래그입니다.

numInitialChunks
integer <int64>

해시 샤드 키로 빈 컬렉션을 샤딩할 때 처음에 생성할 청크의 최소 개수를 지정합니다.

presplitHashedZones
부울
기본값입니다: 거짓

MongoDB Cloud가 비어 있거나 존재하지 않는 컬렉션에 대해 첫 청크를 생성하고 분산시켜야 하는지 여부를 나타내는 플래그입니다. MongoDB Cloud는 컬렉션에 대해 정의된 영역 및 영역 범위를 기반으로 데이터를 배포합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "collection": "string",
  • "customShardKey": "string",
  • "db": "string",
  • "isCustomShardKeyHashed": false,
  • "isShardKeyUnique": false,
  • "numInitialChunks": 0,
  • "presplitHashedZones": false
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ],
  • "selfManagedSharding": true
}

송장

인보이스를 반환합니다.

비용 탐색기 쿼리 프로세스 만들기

비용 탐색기 내에서 지정된 매개변수에 대한 쿼리 프로세스를 생성합니다. 쿼리 상태를 폴링하고 최종적으로 결과를 검색하는 데 사용할 수 있는 토큰이 반환됩니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

비용 탐색기 쿼리에 대한 필터 매개변수를 설정합니다.

클러스터
의 배열 strings

Cost Explorer 쿼리에 포함할 프로젝트 목록입니다.

endDate
필수
문자열 <date>

비용 탐색기 쿼리의 독점 종료일입니다. 날짜는 한 달의 시작일이어야 합니다.

그룹화 기준
문자열
열거형: "organizations" "projects" "Clusters" "services"

반환된 사용량 결과를 그룹화할 기준이 되는 차원입니다. 측정기준을 사용하려면 하나 이상의 필터 값을 제공해야 합니다.

includePartialMatches
부울

필터 조건과 일치하지만 모든 필터 조건에 대한 값이 없는 사용량이 응답에 포함되는지 여부를 제어하는 플래그입니다. 기본값은 거짓으로, 부분적으로 일치하는 데이터를 제외합니다.

조직
의 배열 strings

Cost Explorer 쿼리에 포함할 조직 목록입니다.

프로젝트
의 배열 strings

Cost Explorer 쿼리에 포함할 프로젝트 목록입니다.

서비스
의 배열 strings
항목 열거형: "atlas" "clusters" "Storage" "Serverless Instances" "Backup" "Data Transfer" "BI Connector" "Premium Features" "Atlas Data Federation" "Atlas Stream Processing" "App Services" "Charts" "Cloud Manager" "Cloud Manager Standard/Premium" "Legacy Backup" "Flex Consulting" "Support" "Credits"

Cost Explorer 쿼리에 포함할 프로젝트 목록입니다.

startDate
필수
문자열 <date>

Cost Explorer 쿼리의 포괄적 시작 날짜입니다. 날짜는 한 달의 시작일이어야 합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusters": [
    ],
  • "endDate": "2022-02-01",
  • "groupBy": "organizations",
  • "includePartialMatches": true,
  • "organizations": [
    ],
  • "projects": [
    ],
  • "services": [
    ],
  • "startDate": "2022-02-01"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "token": "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71"
}

특정 비용 탐색기 쿼리의 결과를 반환하거나 결과가 아직 준비되지 않았음을 알립니다.

쿼리가 완료되고 데이터를 볼 준비가 된 경우 Cost Explorer 쿼리에 대한 사용 세부 정보를 반환합니다. 데이터가 준비되지 않은 경우 '처리' 응답은 나중에 데이터를 보려면 다른 요청을 보내야 한다는 의미입니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

토큰
필수
문자열 = 64자
예시: 4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C

Cost Explorer 쿼리를 식별하는 고유한 64자리 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
샘플 없음

1개의 조직에 대해 모든 청구서 반환

MongoDB가 지정된 조직에 발행한 모든 청구서를 반환합니다. 이 목록에는 청구서 상태에 관계없이 모든 청구서가 포함됩니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 결제 뷰어, 조직 결제 관리자 또는 조직 소유자 역할이 있어야 합니다. 조직 간 설정이 있는 경우 조직 청구 관리자 또는 조직 소유자 역할이 있으면 연결된 청구서를 볼 수 있습니다. 청구서의 총 미결제 금액을 계산하려면 각 청구서의 미결제 금액 합계를 합산합니다. 청구서에 포함된 각 결제의 미결제 금액 합계로 계산할 수 있습니다. 결제 금액을 계산하려면 totalBilledCents * unitPrice + SalesTax - StartingBalanceCents 공식을 사용합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 조직에 대해 보류 중인 모든 청구서 반환

지정된 조직의 현재 청구 주기에 대해 비용이 발생한 모든 청구서을 반환합니다. 이 리소스를 사용하려면 요청 API 키에 조직 청구 뷰어, 조직 청구 관리자 또는 조직 소유자 역할이 있어야 합니다. 조직 간 설정이 있는 경우 조직 청구 관리자 또는 조직 소유자 역할이 있으면 연결된 청구서를 볼 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 조직 청구서 반환

MongoDB가 지정된 조직에 발행한 청구서 1개를 반환합니다. 고유한 2416진수 문자열로 청구서를 식별합니다. 이 청구서를 JSON 또는 CSV 형식으로 받도록 선택할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 결제 뷰어, 조직 결제 관리자 또는 조직 소유자 역할이 있어야 합니다. 조직 간 설정이 있는 경우 조직 청구 관리자 또는 조직 소유자 역할이 있는 경우 연결된 청구서를 쿼리할 수 있습니다. 청구서의 총 미결제 금액을 계산하려면 청구서에 포함된 각 결제의 총 미결제 금액을 합산합니다. 결제 금액을 계산하려면 totalBilledCents * unitPrice + SalesTax - StartingBalanceCents 공식을 사용합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

invoiceId
필수
문자열 = 24자 ^([a-f0-9]{24})$

지정된 조직에 제출된 청구서를 식별하는 고유한 24자리 16진수 문자열입니다. 요금은 일반적으로 다음 날 청구됩니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
샘플 없음

1개의 조직 청구서를 CSV로 반환

MongoDB가 지정된 조직에 발행한 청구서 1개를 CSV 형식으로 반환합니다. 고유한 2416진수 문자열로 청구서를 식별합니다. 이 리소스를 사용하려면 요청하는 API 키에 최소한 조직 결제 뷰어, 조직 결제 관리자 또는 조직 소유자 역할이 있어야 합니다. 조직 간 설정이 있는 경우 조직 청구 관리자 또는 조직 소유자 역할이 있는 경우 연결된 청구서를 쿼리할 수 있습니다. 청구서의 총 미결제 금액을 계산하려면 청구서에 포함된 각 결제의 총 미결제 금액을 합산합니다. 결제 금액을 계산하려면 totalBilledCents * unitPrice + SalesTax - StartingBalanceCents 공식을 사용합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

invoiceId
필수
문자열[0-9a-f]+

지정된 조직에 제출된 청구서를 식별하는 고유한 24자리 16진수 문자열입니다. 요금은 일반적으로 다음 날 청구됩니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "reason": "Unauthorized"
}

LDAP 구성

LDAP 구성을 반환, 편집, 확인 및 제거합니다. LDAP 구성은 사용자 인증 및 권한 부여를 위해 MongoDB Cloud가 TLS를 통해 LDAP 서버에 연결하기 위한 설정을 정의합니다. LDAP 서버는 인터넷에 표시되거나 VPC 피어링을 사용하여 MongoDB Cloud 클러스터에 연결되어 있어야 합니다. 또한 LDAP 서버는 TLS를 사용해야 합니다. 이러한 엔드포인트를 사용하려면 MongoDB Cloud 관리자 사용자 권한이 있어야 합니다. 또한 LDAPS를 사용하여 사용자 인증 및 권한 부여를 구성하려면 클러스터에서 MongoDB 3.6 이상을 실행해야 합니다. LDAPS를 구성한 그룹은 MongoDB 3.6 이하 버전을 사용하여 클러스터를 생성할 수 없습니다.

현재 LDAP 또는 X.509 구성 반환

지정된 프로젝트에 대한 현재 LDAP 구성을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}

LDAP 또는 X.509 구성 편집

지정된 프로젝트에 대한 LDAP 구성을 편집합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

이 구성을 업데이트하면 데이터베이스의 롤링 재시작이 트리거됩니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 대한 LDAP 구성을 업데이트합니다.

객체 (데이터베이스 사용자 TLS 인증서 설정)

데이터베이스 사용자를 위한 TLS 인증서를 구성하는 설정입니다.

객체 (LDAP 보안 설정)

지정된 프로젝트에 적용되는 TLS (전송 계층 보안) 구성 세부 정보를 통한 경량 디렉토리 액세스 프로토콜 (LDAP)

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "customerX509": {
    },
  • "ldap": {
    }
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}

현재 LDAP 사용자를 DN 매핑으로 제거

지정된 프로젝트의 LDAP 구성에서 userToDNMapping 문서에 캡처된 현재 LDAP 식별 이름 매핑을 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}

1개의 프로젝트에서 LDAP 구성 확인

지정된 프로젝트에 대한 LDAP 구성을 확인합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

확인하려는 지정된 프로젝트에 대한 LDAP 구성입니다.

authzQueryTemplate
문자열
기본값입니다: "{USER}?memberOf?base"

인증된 MongoDB 사용자와 연결된 LDAP 그룹을 반환하기 위해 LDAP 쿼리를 생성하는 데 MongoDB Cloud가 적용하는 경량 디렉토리 액세스 프로토콜(LDAP) 쿼리 템플릿입니다. MongoDB Cloud는 이 매개변수를 사용자 인증에만 사용합니다.

유니폼 리소스 로케이터 (URL) 의 {USER} 플레이스홀더를 사용하여 인증된 사용자 이름을 대체하세요. 쿼리는 호스트 이름으로 지정된 호스트와 관련된 쿼리입니다. RFC 4515 및 RFC 4516 에 따라 이 쿼리의 형식을 지정하세요.

bindPassword
필수
문자열

MongoDB Cloud가 bindUsername을 인증하는 데 사용하는 비밀번호입니다.

바인드 사용자 이름
필수
문자열^ (?:(?<cn>CN =(?<name>[^,] *)),)?(?:(?<path>(?:...

MongoDB Cloud가 LDAP 호스트에 연결하는 데 사용하는 경량 디렉토리 액세스 프로토콜(LDAP) 사용자의 전체 고유 이름(DN)입니다. LDAP 고유 이름은 RFC 2253에 따라 서식을 지정해야 합니다.

RFC 2253
caCertificate
문자열

MongoDB 클라우드가 경량 디렉토리 액세스 프로토콜(LDAP) 호스트의 신원을 확인하는 데 사용하는 인증 기관(CA) 인증서입니다. MongoDB Cloud는 자체 서명된 인증서를 허용합니다. 할당된 값을 삭제하려면 빈 문자열을 전달합니다: "caCertificate": "".

호스트 이름
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}:)...

경량 디렉토리 액세스 프로토콜(LDAP) 호스트의 호스트 이름 또는 인터넷 프로토콜(IP) 주소를 식별하는 사람이 읽을 수 있는 레이블입니다. 이 호스트는 인터넷에 액세스할 수 있거나 클러스터에 대한 가상 사설 클라우드 (VPC) 피어링 연결이 있어야 합니다.

포트
필수
integer <int32>
기본값입니다: 636

경량 디렉토리 액세스 프로토콜 (LDAP) 호스트가 클라이언트 연결을 수신하는 IANA 포트입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "authzQueryTemplate": "{USER}?memberOf?base",
  • "bindPassword": "string",
  • "bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
  • "caCertificate": "string",
  • "hostname": "string",
  • "port": 636
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "request": {
    },
  • "requestId": "32b6e34b3d91647abb20e7b8",
  • "status": "FAIL",
  • "validations": [
    ]
}

1개의 LDAP 구성 확인 요청 상태 반환

지정된 프로젝트에 대한 하나의 LDAP 구성을 확인하기 위한 하나의 요청 상태를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

requestId
필수
문자열 = 24자 ^([a-f0-9]{24})$

LDAP 구성 확인 요청을 식별하는 고유 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "request": {
    },
  • "requestId": "32b6e34b3d91647abb20e7b8",
  • "status": "FAIL",
  • "validations": [
    ]
}

레거시 백업

레거시 백업 스냅샷, 복원 작업, 일정 및 체크포인트를 관리합니다.

사용되지 않는 모든 레거시 백업 체크포인트 반환

지정된 프로젝트의 한 클러스터에 대한 모든 레거시 백업 체크포인트를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

반환하려는 체크포인트가 포함된 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

사용되지 않는 레거시 백업 체크포인트 1개 반환

지정된 프로젝트의 클러스터 하나에 대한 레거시 백업 체크포인트 하나를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

checkpointId
필수
문자열 = 24자 ^([a-f0-9]{24})$

체크포인트를 식별하는 고유한 24자리 16진수 문자열입니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

반환하려는 체크포인트가 포함된 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "completed": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "parts": [
    ],
  • "restorable": true,
  • "started": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"
}

사용되지 않는 모든 레거시 백업 복원 작업 반환

지정된 프로젝트의 한 클러스터에 대한 모든 레거시 백업 복원 작업을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

2020년 3월 23일부터 모든 새 클러스터는 클라우드 백업만 사용할 수 있습니다. 버전 4.4 이상으로 업그레이드할 때 백업 시스템이 현재 레거시 백업으로 설정되어 있는 경우 클라우드 백업으로 업그레이드합니다. 이 업그레이드 후에도 기존의 모든 레거시 백업 스냅샷을 계속 사용할 수 있습니다. 사용자의 보유 정책에 따라 시간이 지나면 만료됩니다. 백업 정책이 기본 일정으로 재설정됩니다. 레거시 백업과 함께 사용자 정의 백업 정책이 있는 경우 Cloud Backup 설명서 에 설명된 절차에 따라 이를 다시 생성해야 합니다. BATCH-ID 쿼리 매개변수를 사용하면 지정된 배치의 모든 복원 작업을 검색할 수 있습니다. 샤딩된 클러스터에 대한 복원 작업을 생성할 때, MongoDB Cloud는 각 샤드에 대해 별도의 작업을 생성하고 구성 서버에 대해 또 다른 작업을 생성합니다. 이러한 각 작업은 일괄 처리의 일부입니다. 그러나 일괄 처리에는 복제본 세트에 대한 복원 작업이 포함될 수 없습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

반환하려는 스냅샷이 포함된 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

batchId
문자열 = 24자 ^([a-f0-9]{24})$

반환할 복원 작업의 일괄 처리를 식별하는 고유한 24진수 문자열입니다. ISO 8601 날짜 및 시간 형식(UTC)의 타임스탬프 - 샤드 클러스터에 대한 복원 작업을 생성할 때 애플리케이션은 각 샤드에 대해 별도의 작업을 생성하고 구성 호스트에 대해 다른 작업을 생성합니다. 이러한 각 작업은 하나의 배치로 구성됩니다. 복제본 세트에 대한 복원 작업은 배치에 포함될 수 없습니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

레거시 백업 복원 작업 한 개 생성이 더 이상 사용되지 않음

지정된 프로젝트의 cluster 한 개에 대해 레거시 백업 한 개를 복원합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 2020년 3월 23일부터 모든 새 cluster는 클라우드 백업만 사용할 수 있습니다. 4.2로 업그레이드하면, 백업 시스템이 현재 레거시 백업으로 설정되어 있는 경우 클라우드 백업으로 업그레이드됩니다. 이 업그레이드 후에도 기존의 모든 레거시 백업 스냅샷을 계속 사용할 수 있습니다. 사용자의 보유 정책에 따라 시간이 지나면 만료됩니다. 백업 정책이 기본 일정으로 재설정됩니다. 레거시 백업에 사용자 지정 백업 정책을 적용한 경우 클라우드 백업 설명서에 설명된 절차에 따라 백업 정책을 다시 생성해야 합니다. 이 엔드포인트는 샤드 클러스터에 대한 체크포인트 복원 작업 생성이나 쿼리 가능 백업 스냅샷에 대한 복원 작업 생성을 지원하지 않습니다. 요청 본문에 AUTOMATED_RESTORE 중 delivery.methodName을(를) 지정하여 자동 복원 작업을 생성하는 경우 MongoDB Cloud는 복원 전에 대상 cluster의 기존 데이터를 모두 제거합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

반환하려는 스냅샷이 포함된 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

레거시 백업으로 지정된 프로젝트의 cluster 한 개로 복원합니다.

checkpointId
문자열 = 24자 ^([a-f0-9]{24})$

샤드 클러스터 체크포인트를 식별하는 고유한 24자리 16진수 문자열입니다. 체크포인트는 데이터를 복원하려는 시점을 나타냅니다. 이 매개변수는 "delivery.methodName" : "AUTOMATED_RESTORE"일 때 적용됩니다. 이 매개변수는 샤드 클러스터에만 사용합니다.

  • checkpointId를 설정하면 oplogInc, oplogTs, snapshotId 또는 pointInTimeUTCMillis는 설정할 수 없습니다.
  • 이 매개변수를 제공하면 이 엔드포인트는 이 체크포인트까지의 모든 데이터를 전달 객체에서 지정한 데이터베이스에 복원합니다.
필수
객체 (스냅샷 전달 메타데이터 복원)

복원된 스냅샷 데이터를 전달하는 방법을 나타내는 메서드 및 세부 정보입니다.

oplogInc
integer <int32> >= 1

주어진 초 내의 작업을 나타내는 32비트 증분 서수입니다. oplogT와 함께 사용할 경우 이는 MongoDB Cloud가 데이터를 복원하는 시점을 나타냅니다. 이 매개변수는 "delivery.methodName" : "AUTOMATED_RESTORE" 시 적용됩니다.

  • oplogInc를 설정하면 반드시 oplogT를 설정해야 하며 checkpointId, snapshotId 또는 pointInTimeUTCMillis는 설정할 수 없습니다.
  • 이 매개변수를 제공하면 이 엔드포인트는 이 Oplog 타임스탬프를 포함한 모든 데이터를 전달 객체에서 지정한 데이터베이스에 복원합니다.
oplogTs
문자열^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9...

이 스냅샷을 복원할 날짜 및 시간입니다. 이 매개변수는 값을 UTC의 ISO 8601 형식으로 표현합니다. 이는 Oplog 타임스탬프의 첫 번째 부분을 나타냅니다. oplogInc와 함께 사용하면 데이터를 복원하려는 마지막 데이터베이스 작업을 나타냅니다. 이 매개변수는 "delivery.methodName" : "AUTOMATED_RESTORE" 시 적용됩니다. 복제본 세트에서 local.oplog.rs에 대한 쿼리를 실행하여 원하는 타임스탬프를 찾습니다.

  • oplogT를 설정하면 반드시 oplogInc를 설정해야 하며 checkpointId, snapshotId 또는 pointInTimeUTCMillis는 설정할 수 없습니다.
  • 이 매개변수를 제공하면 이 엔드포인트는 이 Oplog 타임스탬프를 포함한 모든 데이터를 전달 객체에서 지정한 데이터베이스에 복원합니다.
pointInTimeUTCMillis
integer <int64> >= 1199145600000

이 스냅샷을 복원하려는 타임스탬프입니다. 이 매개변수는 유닉스 시간 이후 경과된 시간(밀리초)으로 값을 표현합니다. 이 타임스탬프는 현재 시간으로부터 최근 24시간 이내여야 합니다. 이 매개변수는 "delivery.methodName" : "AUTOMATED_RESTORE" 시 적용됩니다.

  • 이 매개변수를 제공하면 이 엔드포인트는 이 시점까지의 모든 데이터를 전달 객체에서 지정한 데이터베이스에 복원합니다.
  • pointInTimeUTCMillis를 설정하면 oplogInc, oplogTs, snapshotId 또는 checkpointId는 설정할 수 없습니다.
snapshotId
문자열 = 24자 ^([a-f0-9]{24})$

복원할 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다. snapshotId를 설정하는 경우 oplogInc, oplogTs, pointInTimeUTCMillis 또는 checkpointId는 설정할 수 없습니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "checkpointId": "32b6e34b3d91647abb20e7b8",
  • "delivery": {
    },
  • "oplogInc": 1,
  • "oplogTs": "string",
  • "pointInTimeUTCMillis": 1199145600000,
  • "snapshotId": "32b6e34b3d91647abb20e7b8"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

사용되지 않는 레거시 백업 복원 작업 1개 반환

지정된 프로젝트의 클러스터 하나에 대한 레거시 백업 복원 작업 하나를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

2020년 3월 23일부터 모든 새 클러스터는 클라우드 백업만 사용할 수 있습니다. 버전 4.4 이상으로 업그레이드할 때 백업 시스템이 현재 레거시 백업으로 설정되어 있는 경우 클라우드 백업으로 업그레이드합니다. 이 업그레이드 후에도 기존의 모든 레거시 백업 스냅샷을 계속 사용할 수 있습니다. 사용자의 보유 정책에 따라 시간이 지나면 만료됩니다. 백업 정책이 기본 일정으로 재설정됩니다. 레거시 백업과 함께 사용자 정의 백업 정책이 있는 경우 Cloud Backup 설명서 에 설명된 절차에 따라 이를 다시 생성해야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

반환하려는 스냅샷이 포함된 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

jobId
필수
문자열 = 24자 ^([a-f0-9]{24})$

복원 작업을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "batchId": "32b6e34b3d91647abb20e7b8",
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "delivery": {
    },
  • "encryptionEnabled": true,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hashes": [],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "statusName": "IN_PROGRESS",
  • "timestamp": {
    }
}

사용되지 않는 스냅샷 일정 1개 반환

지정된 프로젝트에 있는 클러스터 1개의 스냅샷 일정을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

2020년 3월 23일부터 모든 새 클러스터는 클라우드 백업만 사용할 수 있습니다. 버전 4.4 이상으로 업그레이드할 때 백업 시스템이 현재 레거시 백업으로 설정되어 있는 경우 클라우드 백업으로 업그레이드합니다. 이 업그레이드 후에도 기존의 모든 레거시 백업 스냅샷을 계속 사용할 수 있습니다. 사용자의 보유 정책에 따라 시간이 지나면 만료됩니다. 백업 정책이 기본 일정으로 재설정됩니다. 레거시 백업과 함께 사용자 정의 백업 정책이 있는 경우 Cloud Backup 설명서 에 설명된 절차에 따라 이를 다시 생성해야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

반환하려는 스냅샷이 포함된 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "dailySnapshotRetentionDays": 0,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "monthlySnapshotRetentionMonths": 0,
  • "pointInTimeWindowHours": 0,
  • "snapshotIntervalHours": 6,
  • "snapshotRetentionDays": 2,
  • "weeklySnapshotRetentionWeeks": 0
}

사용되지 않는 클러스터 1개의 스냅샷 일정 업데이트

지정된 프로젝트에 있는 한 클러스터의 스냅샷 일정을 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

2020년 3월 23일부터 모든 새 클러스터는 클라우드 백업만 사용할 수 있습니다. 버전 4.4 이상으로 업그레이드할 때 백업 시스템이 현재 레거시 백업으로 설정되어 있는 경우 클라우드 백업으로 업그레이드합니다. 이 업그레이드 후에도 기존의 모든 레거시 백업 스냅샷을 계속 사용할 수 있습니다. 사용자의 보유 정책에 따라 시간이 지나면 만료됩니다. 백업 정책이 기본 일정으로 재설정됩니다. 레거시 백업과 함께 사용자 정의 백업 정책이 있는 경우 Cloud Backup 설명서 에 설명된 절차에 따라 이를 다시 생성해야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

반환하려는 스냅샷이 포함된 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 있는 한 클러스터의 스냅샷 일정을 업데이트합니다.

clusterCheckpointIntervalMin
필수
integer <int32>
열거형: 15 30 60

연속적인 클러스터 체크포인트 사이의 시간을 분 단위로 표시합니다. 이 매개변수는 샤딩된 클러스터에만 적용됩니다. 이 숫자는 샤딩된 클러스터에 대한 지속적인 클라우드 백업의 세분성을 결정합니다.

clusterId
필수
문자열 = 24자 ^([a-f0-9]{24})$

반환할 스냅샷이 있는 클러스터를 식별하는 고유한 24자리 16진수 문자열입니다.

dailySnapshotRetentionDays
필수
integer <int32>
열거형: 0 3 4 5 6 7 15 30 60 90 120 180 360

일일 스냅샷을 보관할 시간입니다. MongoDB Cloud는 이 값을 일 단위로 표현합니다. 일일 스냅샷 보존을 사용하지 않으려면 이 값을 0 으로 설정합니다.

monthlySnapshotRetentionMonths
필수
integer <int32>
열거형: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 18 24 36

MongoDB Cloud가 월별 스냅샷을 보관해야 하는 개월 수입니다. 월별 스냅샷 보존을 사용하지 않으려면 이 값을 0 으로 설정합니다.

pointInTimeWindowHours
필수
integer <int32>

MongoDB Cloud가 지속적 클라우드 백업 스냅샷을 생성할 수 있는 현재 시간까지의 시간 수입니다.

snapshotIntervalHours
필수
integer <int32>
열거형: 6 8 12 24

다른 스냅샷을 찍기 전에 경과해야 하는 시간 수입니다.

snapshotRetentionDays
필수
integer <int32>
열거형: 2 3 4 5

몽고DB 클라우드가 최근 스냅샷을 보관해야 하는 일수입니다.

weeklySnapshotRetentionWeeks
필수
integer <int32>
열거형: 0 1 2 3 4 5 6 7 8 12 16 20 24 52

MongoDB Cloud가 주간 스냅샷을 보관해야 하는 주 수입니다. 주간 스냅샷 보존을 사용하지 않으려면 이 값을 0 으로 설정합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "dailySnapshotRetentionDays": 0,
  • "monthlySnapshotRetentionMonths": 0,
  • "pointInTimeWindowHours": 0,
  • "snapshotIntervalHours": 6,
  • "snapshotRetentionDays": 2,
  • "weeklySnapshotRetentionWeeks": 0
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "dailySnapshotRetentionDays": 0,
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "monthlySnapshotRetentionMonths": 0,
  • "pointInTimeWindowHours": 0,
  • "snapshotIntervalHours": 6,
  • "snapshotRetentionDays": 2,
  • "weeklySnapshotRetentionWeeks": 0
}

사용되지 않는 모든 레거시 백업 스냅샷 반환

지정된 프로젝트의 한 클러스터에 대한 모든 레거시 백업 스냅샷을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다. 2020년 3월 23일부터 모든 새 클러스터는 클라우드 백업만 사용할 수 있습니다. 버전 4.4 이상으로 업그레이드할 때 백업 시스템이 현재 레거시 백업으로 설정되어 있는 경우 클라우드 백업으로 업그레이드합니다. 이 업그레이드 후에도 기존의 모든 레거시 백업 스냅샷을 계속 사용할 수 있습니다. 사용자의 보유 정책에 따라 시간이 지나면 만료됩니다. 백업 정책이 기본 일정으로 재설정됩니다. 레거시 백업과 함께 사용자 정의 백업 정책이 있는 경우 Cloud Backup 설명서 에 설명된 절차에 따라 이를 다시 생성해야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

completed
문자열
기본값입니다: "true"
열거형: "all" "true" "false"

완료된 스냅샷만 반환할지, 완료되지 않은 스냅샷만 반환할지, 아니면 모든 스냅샷을 반환할지 지정하는 사람이 읽을 수 있는 레이블입니다. 기본적으로 MongoDB Cloud는 완료된 스냅샷만 반환합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

사용되지 않는 레거시 백업 스냅샷 1개 제거

지정된 프로젝트의 클러스터 하나에 대한 레거시 백업 스냅샷 하나를 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 2020년 3월 23일부터 모든 새 클러스터는 클라우드 백업만 사용할 수 있습니다. 4.2로 업그레이드하면, 백업 시스템이 현재 레거시 백업으로 설정되어 있는 경우 클라우드 백업으로 업그레이드됩니다. 이 업그레이드 후에도 기존의 모든 레거시 백업 스냅샷을 계속 사용할 수 있습니다. 사용자의 보유 정책에 따라 시간이 지나면 만료됩니다. 백업 정책이 기본 일정으로 재설정됩니다. 레거시 백업에 사용자 지정 백업 정책을 적용한 경우 클라우드 백업 설명서에 설명된 절차에 따라 백업 정책을 다시 생성해야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

사용되지 않는 레거시 백업 스냅샷 1개 반환

지정된 프로젝트의 클러스터 하나에 대한 레거시 백업 스냅샷 하나를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다. 2020년 3월 23일부터 모든 새 클러스터는 클라우드 백업만 사용할 수 있습니다. 4.2로 업그레이드하면, 백업 시스템이 현재 레거시 백업으로 설정되어 있는 경우 클라우드 백업으로 업그레이드됩니다. 이 업그레이드 후에도 기존의 모든 레거시 백업 스냅샷을 계속 사용할 수 있습니다. 사용자의 보유 정책에 따라 시간이 지나면 만료됩니다. 백업 정책이 기본 일정으로 재설정됩니다. 레거시 백업에 사용자 지정 백업 정책을 적용한 경우 클라우드 백업 설명서에 설명된 절차에 따라 백업 정책을 다시 생성해야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "complete": true,
  • "created": {
    },
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "incremental": true,
  • "lastOplogAppliedTimestamp": {
    },
  • "links": [],
  • "parts": [
    ]
}

사용되지 않는 레거시 백업 스냅샷 만료일 1개 변경

지정된 프로젝트의 한 클러스터에 대한 기존 백업 스냅샷 하나의 만료 날짜를 변경합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 2020년 3월 23일부터 모든 새 클러스터는 클라우드 백업만 사용할 수 있습니다. 4.2로 업그레이드하면, 백업 시스템이 현재 레거시 백업으로 설정되어 있는 경우 클라우드 백업으로 업그레이드됩니다. 이 업그레이드 후에도 기존의 모든 레거시 백업 스냅샷을 계속 사용할 수 있습니다. 사용자의 보유 정책에 따라 시간이 지나면 만료됩니다. 백업 정책이 기본 일정으로 재설정됩니다. 레거시 백업에 사용자 지정 백업 정책을 적용한 경우 클라우드 백업 설명서에 설명된 절차에 따라 백업 정책을 다시 생성해야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

레거시 백업 스냅샷 만료일 하나를 변경합니다.

doNotDelete
부울

다른 사람이 이 스냅샷을 삭제할 수 있는지 여부를 나타내는 플래그입니다. 동일한 요청에서 "doNotDelete" : true 설정과 만료 타임스탬프를 설정할 수 없습니다.

expires
문자열 <date-time>

MongoDB Cloud가 스냅샷을 삭제하는 날짜 및 시간입니다. "doNotDelete" : true 인 경우 MongoDB Cloud는 이 매개변수에 설정된 모든 값을 제거합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterId": "32b6e34b3d91647abb20e7b8",
  • "complete": true,
  • "created": {
    },
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "incremental": true,
  • "lastOplogAppliedTimestamp": {
    },
  • "links": [],
  • "parts": [
    ]
}

유지 관리 창

유지 관리 창을 반환, 편집 및 제거합니다. MongoDB Cloud가 수행하는 유지 관리 절차에는 유지 관리 기간 동안 복제본 세트당 하나 이상의 복제본 세트 선택이 필요합니다. 프로젝트에 대해 예약된 유지 관리 이벤트를 최대 두 번까지 연기할 수 있습니다. 지연된 유지 관리 이벤트는 이전에 예약한 날짜 및 시간으로부터 정확히 1주일 후에 원하는 유지 관리 기간 동안 발생합니다.

1개의 프로젝트에 대해 1개의 유지 관리 기간 재설정

지정된 프로젝트의 유지 관리 기간을 재설정합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 보안 패치와 같은 긴급 유지 관리 활동은 선택한 기간을 기다릴 수 없습니다. MongoDB Cloud는 필요할 때 이러한 유지 관리 활동을 시작합니다. 클러스터에 대한 유지 관리를 예약한 후에는 현재 유지 관리 작업이 완료될 때까지 유지 관리 기간을 변경할 수 없습니다. MongoDB Cloud가 수행하는 유지 관리 절차에는 유지 관리 기간 동안 복제본 세트당 하나 이상의 복제본 세트 선택이 필요합니다. 유지 관리는 항상 가급적 예정된 시간에 가깝게 시작하지만, 진행 중인 클러스터 업데이트 또는 예기치 않은 시스템 문제로 인해 시작 시간이 지연될 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1개의 프로젝트에 1개의 유지 관리 기간 반환

지정된 프로젝트에 대한 유지 관리 기간을 반환합니다. 몽고DB 클라우드는 필요할 때 이러한 유지 관리 활동을 시작합니다. 현재 유지 관리 작업이 완료될 때까지는 유지 관리 기간을 변경할 수 없습니다. MongoDB Cloud가 수행하는 유지 관리 절차에는 유지 관리 기간 동안 복제본 세트당 하나 이상의 복제본 세트 선택이 필요합니다. 유지 관리는 항상 가급적 예정된 시간에 가깝게 시작하지만, 진행 중인 클러스터 업데이트 또는 예기치 않은 시스템 문제로 인해 시작 시간이 지연될 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "autoDeferOnceEnabled": true,
  • "dayOfWeek": 1,
  • "hourOfDay": 23,
  • "numberOfDeferrals": 0,
  • "startASAP": true
}

1개의 프로젝트에 대해 유지 관리 기간 업데이트

지정된 프로젝트의 유지 관리 기간을 업데이트합니다. 보안 패치와 같은 긴급 유지 관리 활동은 선택한 기간을 기다릴 수 없습니다. MongoDB Cloud는 필요할 때 이러한 유지 관리 활동을 시작합니다. 클러스터에 대한 유지 관리를 예약한 후에는 현재 유지 관리 작업이 완료될 때까지 유지 관리 기간을 변경할 수 없습니다. MongoDB Cloud가 수행하는 유지 관리 절차에는 유지 관리 기간 동안 복제본 세트당 하나 이상의 복제본 세트 선택이 필요합니다. 유지 관리는 항상 가급적 예정된 시간에 가깝게 시작하지만, 진행 중인 클러스터 업데이트 또는 예기치 않은 시스템 문제로 인해 시작 시간이 지연될 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트의 유지 관리 기간을 업데이트합니다.

autoDeferOnceEnabled
부울

MongoDB Cloud가 모든 유지 관리 기간을 활성화한 후 1주일 동안 연기해야 하는지 여부를 나타내는 플래그입니다.

dayOfWeek
필수
integer <int32> [ 1 .. 7 ]

유지 관리 기간이 시작되는 요일을 나타내는 1부터 시작하는 정수입니다.

값 요일
1 Sunday
2 Monday
3 화요일
4 수요일
5 목요일
6 Friday
7 토요일
hourOfDay
integer <int32> [0.. 23]

24시간제에 따라 유지 관리 기간이 시작되는 시간을 나타내는 0부터 시작하는 정수입니다. 자정에는 0 을 사용하고 정오에는 12 을 사용합니다.

startASAP
부울

MongoDB Cloud가 이 요청을 수신하는 즉시 유지 관리 기간을 시작할지 여부를 나타내는 플래그입니다. 프로젝트에 대한 유지 관리 기간을 즉시 시작하려면 MongoDB Cloud에 유지 관리가 예약되어 있어야 하며, 유지 관리 기간을 설정해야 합니다. 이 플래그는 MongoDB Cloud가 유지보수를 완료한 후 false 로 재설정됩니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "autoDeferOnceEnabled": true,
  • "dayOfWeek": 1,
  • "hourOfDay": 23,
  • "startASAP": true
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 프로젝트에 대해 유지 관리 자동 연기 전환

지정된 프로젝트에 대한 유지 관리 기간의 자동 연기를 전환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1개의 프로젝트에 대해 1개의 유지 관리 기간 연기

지정된 프로젝트에 대한 유지 관리 기간을 연기합니다. 보안 패치와 같은 긴급 유지 관리 활동은 선택한 기간을 기다릴 수 없습니다. MongoDB Cloud는 필요할 때 이러한 유지 관리 활동을 시작합니다. 클러스터에 대한 유지 관리를 예약한 후에는 현재 유지 관리 작업이 완료될 때까지 유지 관리 기간을 변경할 수 없습니다. MongoDB Cloud가 수행하는 유지 관리 절차에는 유지 관리 기간 동안 복제본 세트당 하나 이상의 복제본 세트 선택이 필요합니다. 유지 관리는 항상 가급적 예정된 시간에 가깝게 시작하지만, 진행 중인 클러스터 업데이트 또는 예기치 않은 시스템 문제로 인해 시작 시간이 지연될 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

MongoDB 클라우드 사용자

MongoDB Cloud 사용자를 반환, 추가, 편집합니다.

1명의 MongoDB 클라우드 사용자 생성

하나의 MongoDB Cloud 사용자 계정을 생성합니다. MongoDB Cloud 사용자 계정은 MongoDB Cloud 애플리케이션에 대한 액세스 권한만 부여합니다. 데이터베이스 액세스 권한을 부여하려면 데이터베이스 사용자를 만듭니다. MongoDB Cloud는 지정한 사용자에게 프로젝트에 참여하도록 초대하는 이메일을 보냅니다. 초대를 받은 사용자는 초대를 수락할 때까지 프로젝트에 액세스할 수 없습니다. 초대는 30일 후에 만료됩니다.

MongoDB Cloud는 MongoDB Cloud 사용자 멤버십을 팀당 최대 250명의 MongoDB Cloud 사용자로 제한합니다. MongoDB Cloud는 MongoDB 클라우드 사용자 멤버십을 프로젝트당 500명의 MongoDB 클라우드 사용자와 조직당 500명의 MongoDB 클라우드 사용자로 제한합니다. 여기에는 조직 내 모든 프로젝트의 통합 멤버십이 포함됩니다. 작업이 이러한 제한을 초과하면 MongoDB Cloud에서 오류를 발생시킵니다. 예를 들어, 5개의 프로젝트가 있는 조직이 있고 각 프로젝트에 100명의 MongoDB Cloud 사용자가 있으며 각 MongoDB Cloud 사용자가 하나의 프로젝트에만 속해 있는 경우, 먼저 조직에서 기존 MongoDB Cloud 사용자를 제거하지 않고는 이 조직에 어떤 MongoDB Cloud 사용자도 추가할 수 없습니다.

이 리소스를 사용하기 위해 요청하는 API 키는 어떤 역할이든 가질 수 있습니다.

권한 부여
DigestAuth
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

MongoDB 클라우드 사용자 계정을 생성합니다.

국가
필수
문자열^ ([A-Z]{2}) $

MongoDB Cloud 사용자의 지리적 위치를 식별하는 두 개의 알파벳 문자입니다. 이 매개변수는 ISO 3166-1a2 코드 형식을 사용합니다.

이름
필수
문자열

MongoDB Cloud 사용자의 이름입니다.

성
필수
문자열

MongoDB Cloud 사용자의 성입니다.

mobileNumber
필수
문자열(?:(?:\\ +?1\\ s* (?: [.-]\\ s*)?)?(?:(\\ s* ([2-9] 1...

MongoDB Cloud 사용자의 휴대폰 번호입니다.

비밀번호
필수
문자열 8자 이상

비밀번호는 MongoDB 클라우드에 로그인할 사용자 이름으로 적용됩니다. MongoDB Cloud는 새로운 MongoDB Cloud 사용자 생성에 대한 응답을 제외하고 이 매개변수를 반환하지 않습니다. MongoDB Cloud 콘솔에서 비밀번호가 설정된 후에는 MongoDB Cloud 사용자만 비밀번호를 업데이트할 수 있습니다.

의 배열 개체 (역할 할당)

MongoDB Cloud 사용자의 역할과 해당 역할이 적용되는 해당 조직 또는 프로젝트를 표시하는 오브젝트 목록입니다. 하나의 역할이 하나의 조직 또는 하나의 프로젝트에 적용될 수는 있지만 둘 다 적용될 수는 없습니다.

사용자 이름
필수
문자열 <email>

MongoDB 클라우드 사용자의 사용자 이름을 나타내는 이메일 주소입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "country": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "username": "user@example.com"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "emailAddress": "user@example.com",
  • "firstName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastAuth": "2019-08-24T14:15:22Z",
  • "lastName": "string",
  • "links": [],
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

사용자 이름을 사용하여 MongoDB 클라우드 사용자 1명을 반환합니다.

지정된 사용자 이름을 가진 하나의 MongoDB Cloud 사용자 계정에 대한 세부 정보를 반환합니다. 이 엔드포인트를 사용하여 API 키에 대한 정보를 반환할 수 없습니다. API 키에 대한 정보를 반환하려면 조직 API 키 1개 반환 엔드포인트를 사용합니다. 이 리소스를 사용하기 위해 요청하는 API 키는 어떤 역할이든 가질 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
사용자 이름
필수
문자열^ [a-z0-9!#$% & '*+/=?^_` {|} ~-] + (?:\.[a-z0-9!#$%...

MongoDB 클라우드 사용자 계정에 속한 이메일 주소입니다. 사용자를 만든 후에는 이 주소를 수정할 수 없습니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "emailAddress": "user@example.com",
  • "firstName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastAuth": "2019-08-24T14:15:22Z",
  • "lastName": "string",
  • "links": [],
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

해당 ID를 사용하여 MongoDB 클라우드 사용자 1명을 반환합니다.

사용자에 대해 지정된 고유 식별자를 가진 하나의 MongoDB Cloud 사용자 계정에 대한 세부 정보를 반환합니다. 이 엔드포인트를 사용하여 API 키에 대한 정보를 반환할 수 없습니다. API 키에 대한 정보를 반환하려면 조직 API 키 1개 반환 엔드포인트를 사용합니다. 귀하는 언제든지 자신의 사용자 계정을 검색할 수 있습니다. MongoDB Cloud 조직 또는 프로젝트의 소유자인 경우 해당 조직 또는 프로젝트의 멤버십이 있는 모든 사용자의 사용자 프로필을 검색할 수도 있습니다. 이 리소스를 사용하기 위해 요청하는 API 키는 어떤 역할이든 가질 수 있습니다.

권한 부여
DigestAuth
경로 매개변수
userId
필수
문자열 = 24자 ^([a-f0-9]{24})$

이 사용자를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "emailAddress": "user@example.com",
  • "firstName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "lastAuth": "2019-08-24T14:15:22Z",
  • "lastName": "string",
  • "links": [],
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

모니터링 및 로그

데이터베이스 배포 모니터링 및 로깅 데이터를 반환합니다.

1개의 프로젝트에서 1개의 클러스터 호스트에 대해 로그 다운로드

지정된 프로젝트의 지정된 호스트에 대한 로그 메시지 범위가 포함된 압축(.gz) 로그 파일을 반환합니다. MongoDB는 5분마다 클러스터 백엔드 인프라의 프로세스 및 감사 로그를 업데이트하며 이전 5분 동안의 로그 데이터를 포함합니다. 로그 파일에 대해 API를 폴링하는 경우 5분마다 폴링하는 것이 좋습니다. 예를 들어, 로그가 4:00 UTC에 업데이트된 후 API를 폴링하는 경우 API는 3:55 UTC와 4:00 UTC 사이의 로그 데이터를 반환합니다. . 이 기능은 M0 무료 클러스터, M2, M5 또는 서버리스 클러스터에서는 사용할 수 없습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 데이터 액세스 읽기 전용 이상의 역할이 있어야 합니다. API는 json 응답 스키마를 사용한 직접 호출을 지원하지 않습니다. 'Accept: application/vnd.atlas.YYYY-MM-DD+gzip' 형식의 수락 헤더를 사용하여 gzip 응답 스키마를 요청해야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

호스트 이름
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}:)...

다운로드하려는 로그 파일을 저장하는 호스트를 식별하는 사람이 읽을 수 있는 레이블입니다.

logName
필수
문자열
열거형: "mongodb" "mongos" "mongodb-audit-log" "mongos-audit-log"

반환하려는 로그 파일을 식별하는 사람이 읽을 수 있는 레이블입니다. 감사 로그를 반환하려면 지정된 프로젝트에 대해 데이터베이스 감사를 활성화하십시오.

데이터베이스 감사를 설정합니다.
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

endDate
integer <int64> >= 1199145600

기간이 검색할 로그 메시지 범위의 포함 종료 지점을 지정하는 날짜 및 시간입니다. 이 매개변수는 UNIX 에포크 이후 경과된 시간(초)으로 값을 표시합니다.

startDate
integer <int64> >= 1199145600

기간에 검색할 로그 메시지 범위의 시작 시점이 포함되도록 지정하는 날짜 및 시간입니다. 이 매개변수는 UNIX 에포크 이후 경과된 시간(초)으로 값을 표시합니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1개의 프로세스에 대해 모든 Atlas Search 지표 유형 반환

지정된 프로젝트의 한 프로세스에 사용할 수 있는 모든 Atlas Search 지표 유형을 반환합니다. Atlas Search 지표 유형을 보려면 프로젝트 읽기 전용 이상의 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: my.host.name.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 IANA 포트의 조합입니다. 호스트는 MongoDB 프로세스 (mongod 또는 mongos) 를 실행하는 호스트의 호스트 이름, FQDN (정규화된 도메인 이름) 또는 인터넷 프로토콜 주소 (IPv4 또는 IPv6) 여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신 대기하는 IANA 포트여야 합니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hardwareMetrics": [
    ],
  • "indexMetrics": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "statusMetrics": [
    ]
}

1개의 네임스페이스에 대해 모든 Atlas Search 인덱스 지표 반환

지정된 프로세스의 한 네임스페이스에 대해 지정된 시간 범위 내의 Atlas Search 인덱스 지표를 반환합니다.

권한 부여
DigestAuth
경로 매개변수
processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: my.host.name.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 IANA 포트의 조합입니다. 호스트는 MongoDB 프로세스 (mongod 또는 mongos) 를 실행하는 호스트의 호스트 이름, FQDN (정규화된 도메인 이름) 또는 인터넷 프로토콜 주소 (IPv4 또는 IPv6) 여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신 대기하는 IANA 포트여야 합니다.

databaseName
필수
문자열
예시: mydb

데이터베이스를 식별하는 사람이 읽을 수 있는 레이블입니다.

collectionName
필수
문자열
예시: mycoll

컬렉션을 식별하는 사람이 읽을 수 있는 레이블입니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
세분성
필수
문자열
예시: granularity=PT1M

Atlas가 측정항목을 보고하는 간격을 지정하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다.

period
문자열
예시: period=PT10H

Atlas가 메트릭을 보고하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다. 시작과 끝을 설정하지 않을 경우 이 매개변수를 포함하세요.

시작하기
문자열 <date-time>

MongoDB Cloud가 측정항목 보고를 시작한 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

end
문자열 <date-time>

MongoDB 클라우드가 메트릭 보고를 중단하는 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

지표
필수
의 배열 strings <= 10개 항목 unique
항목 열거형: "INDEX_SIZE_ON_DISK" "NUMBER_OF_DELETES" "NUMBER_OF_ERROR_QUERIES" "NUMBER_OF_GETMORE_COMMANDS" "NUMBER_OF_INDEX_FIELDS" "NUMBER_OF_INSERTS" "NUMBER_OF_SUCCESS_QUERIES" "NUMBER_OF_UPDATES" "REPLICATION_LAG" "TOTAL_NUMBER_OF_QUERIES"

MongoDB Atlas가 관련 데이터 계열에 대해 보고하는 측정값이 포함된 목록입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "indexIds": [
    ],
  • "indexStatsMeasurements": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

1개의 지정된 네임스페이스에서 1개의 인덱스에 대해 Atlas Search 지표 반환

지정된 프로세스에서 하나의 네임스페이스 및 인덱스 이름에 대해 제공된 시간 범위 내에서 Atlas Search 지표 데이터 시리즈를 반환합니다. Atlas Search 지표 유형을 보려면 프로젝트 읽기 전용 이상의 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: my.host.name.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 IANA 포트의 조합입니다. 호스트는 MongoDB 프로세스 (mongod 또는 mongos) 를 실행하는 호스트의 호스트 이름, FQDN (정규화된 도메인 이름) 또는 인터넷 프로토콜 주소 (IPv4 또는 IPv6) 여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신 대기하는 IANA 포트여야 합니다.

인덱스 이름
필수
문자열
예시: myindex

인덱스를 식별하는 사람이 읽을 수 있는 레이블입니다.

databaseName
필수
문자열
예시: mydb

데이터베이스를 식별하는 사람이 읽을 수 있는 레이블입니다.

collectionName
필수
문자열
예시: mycoll

컬렉션을 식별하는 사람이 읽을 수 있는 레이블입니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
세분성
필수
문자열
예시: granularity=PT1M

Atlas가 측정항목을 보고하는 간격을 지정하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다.

period
문자열
예시: period=PT10H

Atlas가 메트릭을 보고하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다. 시작과 끝을 설정하지 않을 경우 이 매개변수를 포함하세요.

시작하기
문자열 <date-time>

MongoDB Cloud가 측정항목 보고를 시작한 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

end
문자열 <date-time>

MongoDB 클라우드가 메트릭 보고를 중단하는 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

지표
필수
의 배열 strings <= 10개 항목 unique
항목 열거형: "INDEX_SIZE_ON_DISK" "NUMBER_OF_DELETES" "NUMBER_OF_ERROR_QUERIES" "NUMBER_OF_GETMORE_COMMANDS" "NUMBER_OF_INDEX_FIELDS" "NUMBER_OF_INSERTS" "NUMBER_OF_SUCCESS_QUERIES" "NUMBER_OF_UPDATES" "REPLICATION_LAG" "TOTAL_NUMBER_OF_QUERIES"

MongoDB Atlas가 관련 데이터 계열에 대해 보고하는 측정값이 포함된 목록입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "collectionName": "string",
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "indexIds": [
    ],
  • "indexStatsMeasurements": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

Atlas Search 하드웨어 및 상태 지표 반환

지정된 프로젝트의 한 프로세스에 대해 제공된 시간 범위 내에서 Atlas Search 하드웨어 및 상태 데이터 시리즈를 반환합니다. Atlas Search 지표 유형을 보려면 프로젝트 읽기 전용 이상의 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: my.host.name.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 IANA 포트의 조합입니다. 호스트는 MongoDB 프로세스 (mongod 또는 mongos) 를 실행하는 호스트의 호스트 이름, FQDN (정규화된 도메인 이름) 또는 인터넷 프로토콜 주소 (IPv4 또는 IPv6) 여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신 대기하는 IANA 포트여야 합니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
세분성
필수
문자열
예시: granularity=PT1M

Atlas가 측정항목을 보고하는 간격을 지정하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다.

period
문자열
예시: period=PT10H

Atlas가 메트릭을 보고하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다. 시작과 끝을 설정하지 않을 경우 이 매개변수를 포함하세요.

시작하기
문자열 <date-time>

MongoDB Cloud가 측정항목 보고를 시작한 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

end
문자열 <date-time>

MongoDB 클라우드가 메트릭 보고를 중단하는 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

지표
필수
의 배열 strings <= 10개 항목 unique
항목 열거형: "FTS_DISK_USAGE" "FTS_PROCESS_CPU_KERNEL" "FTS_PROCESS_CPU_USER" "FTS_PROCESS_NORMALIZED_CPU_KERNEL" "FTS_PROCESS_NORMALIZED_CPU_USER" "FTS_PROCESS_RESIDENT_MEMORY" "FTS_PROCESS_SHARED_MEMORY" "FTS_PROCESS_VIRTUAL_MEMORY" "JVM_CURRENT_MEMORY" "JVM_MAX_MEMORY" "PAGE_FAULTS"

MongoDB Atlas에서 관련 데이터 시리즈에 대해 보고하려는 지표가 포함된 목록입니다. 이 매개변수를 설정하지 않으면 이 리소스는 관련 데이터 시리즈에 대한 모든 hardware 및 상태 지표를 반환합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hardwareMeasurements": [
    ],
  • "links": [],
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z",
  • "statusMeasurements": [
    ]
}

1개의 프로젝트에서 모든 MongoDB 프로세스 반환

지정된 프로젝트의 모든 프로세스에 대한 세부 정보를 반환합니다. MongoDB 프로세스는 mongod 또는 mongos일 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

ID별로 1개의 MongoDB 프로세스 반환

지정된 프로젝트의 지정된 호스팅에 대한 프로세스를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: mongodb.example.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 인터넷 할당 번호 관리 기관(Assigned Numbers Authority, IANA) 포트의 조합입니다. 호스트는 MongoDB 프로세스(mongod 또는 mongos)를 실행하는 호스트의 호스트 이름, 전체 주소 도메인 이름(Fully Qualified Domain Name, FQDN) 또는 인터넷 프로토콜 주소(IPv4 또는 IPv6)여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신하는 IANA 포트여야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "created": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostname": "string",
  • "id": "string",
  • "lastPing": "2019-08-24T14:15:22Z",
  • "links": [],
  • "port": 0,
  • "replicaSetName": "string",
  • "shardName": "string",
  • "typeName": "REPLICA_PRIMARY",
  • "userAlias": "string",
  • "version": "string"
}

1개의 MongoDB 프로세스에 사용 가능한 데이터베이스 반환

지정된 프로젝트의 지정된 호스팅에서 실행 중인 데이터베이스 목록을 반환합니다. M0 무료 cluster, M2, M5 및 서버리스 cluster에는 몇 가지 운영 제한 사항이 있습니다. MongoDB Cloud 프로세스는 mongod이어야 합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: mongodb.example.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 인터넷 할당 번호 관리 기관(Assigned Numbers Authority, IANA) 포트의 조합입니다. 호스트는 MongoDB 프로세스(mongod)를 실행하는 호스트의 호스트 이름, 전체 주소 도메인 이름(Fully Qualified Domain Name, FQDN) 또는 인터넷 프로토콜 주소(IPv4 또는 IPv6)여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신하는 IANA 포트여야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

MongoDB 프로세스에 대해 1개의 데이터베이스 반환

지정된 프로젝트의 지정된 호스팅에서 실행 중인 데이터베이스 한 개를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

databaseName
필수
문자열

지정된 MongoDB 프로세스가 제공하는 데이터베이스를 식별하는 사람이 읽을 수 있는 레이블입니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: mongodb.example.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 인터넷 할당 번호 관리 기관(Assigned Numbers Authority, IANA) 포트의 조합입니다. 호스트는 MongoDB 프로세스(mongod 또는 mongos)를 실행하는 호스트의 호스트 이름, 전체 주소 도메인 이름(Fully Qualified Domain Name, FQDN) 또는 인터넷 프로토콜 주소(IPv4 또는 IPv6)여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신하는 IANA 포트여야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 MongoDB 프로세스에 대해 1개의 데이터베이스의 측정값 반환

지정된 프로젝트의 지정된 호스팅에 대한 데이터베이스 한 개의 측정값을 반환합니다. MongoDB dbStats 명령 출력을 기반으로 데이터베이스의 디스크 저장 공간을 반환합니다. 일부 메트릭 계열을 계산하기 위해 Atlas는 인접한 두 지점 사이의 비율을 취합니다. 이러한 메트릭 계열의 경우, 쿼리 시간 범위에서 첫 번째 데이터 요소에 대한 비율을 계산할 수 없기 때문에 첫 번째 데이터 요소는 null 값을 갖습니다. Atlas는 20분마다 데이터베이스 지표를 검색하지만, 데이터베이스 성능을 최적화하기 위해 필요한 경우 빈도를 줄입니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

databaseName
필수
문자열

지정된 MongoDB 프로세스가 제공하는 데이터베이스를 식별하는 사람이 읽을 수 있는 레이블입니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: mongodb.example.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 인터넷 할당 번호 관리 기관(Assigned Numbers Authority, IANA) 포트의 조합입니다. 호스트는 MongoDB 프로세스(mongod 또는 mongos)를 실행하는 호스트의 호스트 이름, 전체 주소 도메인 이름(Fully Qualified Domain Name, FQDN) 또는 인터넷 프로토콜 주소(IPv4 또는 IPv6)여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신하는 IANA 포트여야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

분
의 배열 strings [1 ... 10 ] 항목 unique
항목 열거형: "DATABASE_AVERAGE_OBJECT_SIZE" "DATABASE_COLLECTION_COUNT" "DATABASE_DATA_SIZE" "DATABASE_STORAGE_SIZE" "DATABASE_INDEX_SIZE" "DATABASE_INDEX_COUNT" "DATABASE_EXTENT_COUNT" "DATABASE_OBJECT_COUNT" "DATABASE_VIEW_COUNT"

이 MongoDB 프로세스에 대해 요청할 하나 이상의 측정 유형입니다. 생략하면 리소스는 모든 측정값을 반환합니다. m에 여러 값을 지정하려면 각 값에 대해 m 매개변수를 반복합니다. 지정된 호스팅에 적용되는 측정값을 지정합니다. 유효하지 않은 측정값을 지정한 경우 MongoDB Cloud에서 오류를 반환합니다.

세분성
필수
문자열
예시: granularity=PT1M

Atlas가 측정항목을 보고하는 간격을 지정하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다.

period
문자열
예시: period=PT10H

Atlas가 메트릭을 보고하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다. 시작과 끝을 설정하지 않을 경우 이 매개변수를 포함하세요.

시작하기
문자열 <date-time>

MongoDB Cloud가 측정항목 보고를 시작한 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

end
문자열 <date-time>

MongoDB 클라우드가 메트릭 보고를 중단하는 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostId": "mongodb.example.com:27017",
  • "links": [],
  • "measurements": [
    ],
  • "partitionName": "string",
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

1개의 MongoDB 프로세스에 사용 가능한 디스크 반환

지정된 프로젝트의 지정된 호스팅에 대한 디스크 또는 파티션 목록을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: mongodb.example.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 인터넷 할당 번호 관리 기관(Assigned Numbers Authority, IANA) 포트의 조합입니다. 호스트는 MongoDB 프로세스(mongod 또는 mongos)를 실행하는 호스트의 호스트 이름, 전체 주소 도메인 이름(Fully Qualified Domain Name, FQDN) 또는 인터넷 프로토콜 주소(IPv4 또는 IPv6)여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신하는 IANA 포트여야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 디스크의 측정값 반환

지정된 프로젝트의 지정된 호스팅에 대한 디스크 또는 파티션 한 개에 대한 측정 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
partitionName
필수
문자열

측정값이 적용되는 디스크 또는 파티션의 사람이 읽을 수 있는 레이블입니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: mongodb.example.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 인터넷 할당 번호 관리 기관(Assigned Numbers Authority, IANA) 포트의 조합입니다. 호스트는 MongoDB 프로세스(mongod 또는 mongos)를 실행하는 호스트의 호스트 이름, 전체 주소 도메인 이름(Fully Qualified Domain Name, FQDN) 또는 인터넷 프로토콜 주소(IPv4 또는 IPv6)여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신하는 IANA 포트여야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 MongoDB 프로세스에 대해 1개의 디스크의 측정값 반환

지정된 프로젝트의 지정된 호스팅에 대한 디스크 또는 파티션 한 개의 측정값을 반환합니다. 반환되는 값은 다음 중 한 개일 수 있습니다.

  • MongoDB 프로세스에 사용되는 디스크 파티션의 I/O 작업 처리량
  • 파티션 실행 및 서비스 요청 시간의 백분율
  • MongoDB 프로세스에 사용되는 디스크 파티션의 작업 유형별 지연 시간
  • MongoDB 프로세스에 사용되는 디스크 파티션의 사용 가능한 디스크 공간과 사용된 디스크 공간의 양

이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

partitionName
필수
문자열

측정값이 적용되는 디스크 또는 파티션의 사람이 읽을 수 있는 레이블입니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: mongodb.example.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 인터넷 할당 번호 관리 기관(Assigned Numbers Authority, IANA) 포트의 조합입니다. 호스트는 MongoDB 프로세스(mongod 또는 mongos)를 실행하는 호스트의 호스트 이름, 전체 주소 도메인 이름(Fully Qualified Domain Name, FQDN) 또는 인터넷 프로토콜 주소(IPv4 또는 IPv6)여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신하는 IANA 포트여야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

분
의 배열 strings [1 ... 10 ] 항목 unique
항목 열거형: "DISK_PARTITION_IOPS_READ" "MAX_DISK_PARTITION_IOPS_READ" "DISK_PARTITION_IOPS_WRITE" "MAX_DISK_PARTITION_IOPS_WRITE" "DISK_PARTITION_IOPS_TOTAL" "MAX_DISK_PARTITION_IOPS_TOTAL" "DISK_PARTITION_LATENCY_READ" "MAX_DISK_PARTITION_LATENCY_READ" "DISK_PARTITION_LATENCY_WRITE" "MAX_DISK_PARTITION_LATENCY_WRITE" "DISK_PARTITION_SPACE_FREE" "MAX_DISK_PARTITION_SPACE_FREE" "DISK_PARTITION_SPACE_USED" "MAX_DISK_PARTITION_SPACE_USED" "DISK_PARTITION_SPACE_PERCENT_FREE" "MAX_DISK_PARTITION_SPACE_PERCENT_FREE" "DISK_PARTITION_SPACE_PERCENT_USED" "MAX_DISK_PARTITION_SPACE_PERCENT_USED"

이 MongoDB 프로세스에 대해 요청할 하나 이상의 측정 유형입니다. 생략하면 리소스는 모든 측정값을 반환합니다. m에 여러 값을 지정하려면 각 값에 대해 m 매개변수를 반복합니다. 지정된 호스팅에 적용되는 측정값을 지정합니다. 유효하지 않은 측정값을 지정한 경우 MongoDB Cloud에서 오류를 반환합니다.

세분성
필수
문자열
예시: granularity=PT1M

Atlas가 측정항목을 보고하는 간격을 지정하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다.

period
문자열
예시: period=PT10H

Atlas가 메트릭을 보고하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다. 시작과 끝을 설정하지 않을 경우 이 매개변수를 포함하세요.

시작하기
문자열 <date-time>

MongoDB Cloud가 측정항목 보고를 시작한 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

end
문자열 <date-time>

MongoDB 클라우드가 메트릭 보고를 중단하는 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostId": "mongodb.example.com:27017",
  • "links": [],
  • "measurements": [
    ],
  • "partitionName": "string",
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

1개의 MongoDB 프로세스에 대해 측정값 반환

지정된 프로젝트의 지정된 호스팅에 대한 프로세스당 디스크, 파티션 또는 호스팅 측정값을 반환합니다. 반환되는 값은 다음 중 한 개일 수 있습니다.

  • MongoDB 프로세스에 사용되는 디스크 파티션의 I/O 작업 처리량
  • 파티션 실행 및 서비스 요청 시간의 백분율
  • MongoDB 프로세스에 사용되는 디스크 파티션의 작업 유형별 지연 시간
  • MongoDB 프로세스에 사용되는 디스크 파티션의 사용 가능한 디스크 공간과 사용된 디스크 공간의 양
  • 호스트에 대한 측정값(예: CPU 사용량 또는 I/O 작업 수)

이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...
예시: mongodb.example.com:27017

MongoDB 프로세스를 제공하는 호스트 이름과 인터넷 할당 번호 관리 기관(Assigned Numbers Authority, IANA) 포트의 조합입니다. 호스트는 MongoDB 프로세스(mongod 또는 mongos)를 실행하는 호스트의 호스트 이름, 전체 주소 도메인 이름(Fully Qualified Domain Name, FQDN) 또는 인터넷 프로토콜 주소(IPv4 또는 IPv6)여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신하는 IANA 포트여야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

분
의 배열 strings [1 ... 10 ] 항목 unique
항목 열거형: "ASSERT_MSG" "ASSERT_REGULAR" "ASSERT_USER" "ASSERT_WARNING" "BACKGROUND_FLUSH_AVG" "CACHE_BYTES_READ_INTO" "CACHE_BYTES_WRITTEN_FROM" "CACHE_DIRTY_BYTES" "CACHE_USED_BYTES" "COMPUTED_MEMORY" "CONNECTIONS" "CURSORS_TOTAL_OPEN" "CURSORS_TOTAL_TIMED_OUT" "DB_DATA_SIZE_TOTAL" "DB_STORAGE_TOTAL" "DOCUMENT_METRICS_DELETED" "DOCUMENT_METRICS_INSERTED" "DOCUMENT_METRICS_RETURNED" "DOCUMENT_METRICS_UPDATED" "EXTRA_INFO_PAGE_FAULTS" "FTS_DISK_UTILIZATION" "FTS_MEMORY_MAPPED" "FTS_MEMORY_RESIDENT" "FTS_MEMORY_VIRTUAL" "FTS_PROCESS_CPU_KERNEL" "FTS_PROCESS_CPU_USER" "FTS_PROCESS_NORMALIZED_CPU_KERNEL" "FTS_PROCESS_NORMALIZED_CPU_USER" "GLOBAL_ACCESSES_NOT_IN_MEMORY" "GLOBAL_LOCK_CURRENT_QUEUE_READERS" "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" "INDEX_COUNTERS_BTREE_ACCESSES" "INDEX_COUNTERS_BTREE_HITS" "INDEX_COUNTERS_BTREE_MISS_RATIO" "INDEX_COUNTERS_BTREE_MISSES" "JOURNALING_COMMITS_IN_WRITE_LOCK" "JOURNALING_MB" "JOURNALING_WRITE_DATA_FILES_MB" "MAX_PROCESS_CPU_CHILDREN_KERNEL" "MAX_PROCESS_CPU_CHILDREN_USER" "MAX_PROCESS_CPU_KERNEL" "MAX_PROCESS_CPU_USER" "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL" "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER" "MAX_PROCESS_NORMALIZED_CPU_KERNEL" "MAX_PROCESS_NORMALIZED_CPU_USER" "MAX_SWAP_USAGE_FREE" "MAX_SWAP_USAGE_USED " "MAX_SYSTEM_CPU_GUEST" "MAX_SYSTEM_CPU_IOWAIT" "MAX_SYSTEM_CPU_IRQ" "MAX_SYSTEM_CPU_KERNEL" "MAX_SYSTEM_CPU_SOFTIRQ" "MAX_SYSTEM_CPU_STEAL" "MAX_SYSTEM_CPU_USER" "MAX_SYSTEM_MEMORY_AVAILABLE" "MAX_SYSTEM_MEMORY_FREE" "MAX_SYSTEM_MEMORY_USED" "MAX_SYSTEM_NETWORK_IN" "MAX_SYSTEM_NETWORK_OUT" "MAX_SYSTEM_NORMALIZED_CPU_GUEST" "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT" "MAX_SYSTEM_NORMALIZED_CPU_IRQ" "MAX_SYSTEM_NORMALIZED_CPU_KERNEL" "MAX_SYSTEM_NORMALIZED_CPU_NICE" "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ" "MAX_SYSTEM_NORMALIZED_CPU_STEAL" "MAX_SYSTEM_NORMALIZED_CPU_USER" "MEMORY_MAPPED" "MEMORY_RESIDENT" "MEMORY_VIRTUAL" "NETWORK_BYTES_IN" "NETWORK_BYTES_OUT" "NETWORK_NUM_REQUESTS" "OP_EXECUTION_TIME_COMMANDS" "OP_EXECUTION_TIME_READS" "OP_EXECUTION_TIME_WRITES" "OPCOUNTER_CMD" "OPCOUNTER_DELETE" "OPCOUNTER_GETMORE" "OPCOUNTER_INSERT" "OPCOUNTER_QUERY" "OPCOUNTER_REPL_CMD" "OPCOUNTER_REPL_DELETE" "OPCOUNTER_REPL_INSERT" "OPCOUNTER_REPL_UPDATE" "OPCOUNTER_UPDATE" "OPERATIONS_SCAN_AND_ORDER" "OPLOG_MASTER_LAG_TIME_DIFF" "OPLOG_MASTER_TIME" "OPLOG_RATE_GB_PER_HOUR" "OPLOG_SLAVE_LAG_MASTER_TIME" "OPLOG_REPLICATION_LAG" "PROCESS_CPU_CHILDREN_KERNEL" "PROCESS_CPU_CHILDREN_USER" "PROCESS_CPU_KERNEL" "PROCESS_CPU_USER" "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL" "PROCESS_NORMALIZED_CPU_CHILDREN_USER" "PROCESS_NORMALIZED_CPU_KERNEL" "PROCESS_NORMALIZED_CPU_USER" "QUERY_EXECUTOR_SCANNED" "QUERY_EXECUTOR_SCANNED_OBJECTS" "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" "QUERY_TARGETING_SCANNED_PER_RETURNED" "RESTARTS_IN_LAST_HOUR" "SWAP_USAGE_FREE" "SWAP_USAGE_USED" "SYSTEM_CPU_GUEST" "SYSTEM_CPU_IOWAIT" "SYSTEM_CPU_IRQ" "SYSTEM_CPU_KERNEL" "SYSTEM_CPU_NICE" "SYSTEM_CPU_SOFTIRQ" "SYSTEM_CPU_STEAL" "SYSTEM_CPU_USER" "SYSTEM_MEMORY_AVAILABLE" "SYSTEM_MEMORY_FREE" "SYSTEM_MEMORY_USED" "SYSTEM_NETWORK_IN" "SYSTEM_NETWORK_OUT" "SYSTEM_NORMALIZED_CPU_GUEST" "SYSTEM_NORMALIZED_CPU_IOWAIT" "SYSTEM_NORMALIZED_CPU_IRQ" "SYSTEM_NORMALIZED_CPU_KERNEL" "SYSTEM_NORMALIZED_CPU_NICE" "SYSTEM_NORMALIZED_CPU_SOFTIRQ" "SYSTEM_NORMALIZED_CPU_STEAL" "SYSTEM_NORMALIZED_CPU_USER" "TICKETS_AVAILABLE_READS" "TICKETS_AVAILABLE_WRITE"

이 MongoDB 프로세스에 대해 요청할 하나 이상의 측정 유형입니다. 생략하면 리소스는 모든 측정값을 반환합니다. m에 여러 값을 지정하려면 각 값에 대해 m 매개변수를 반복합니다. 지정된 호스팅에 적용되는 측정값을 지정합니다. 유효하지 않은 측정값을 지정한 경우 MongoDB Cloud에서 오류를 반환합니다.

period
문자열
예시: period=PT10H

Atlas가 메트릭을 보고하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다. 시작과 끝을 설정하지 않을 경우 이 매개변수를 포함하세요.

세분성
필수
문자열
예시: granularity=PT1M

Atlas가 측정항목을 보고하는 간격을 지정하는 기간입니다. 이 매개변수는 UTC 단위의 ISO 8601 기간 형식으로 값을 표현합니다.

시작하기
문자열 <date-time>

MongoDB Cloud가 측정항목 보고를 시작한 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

end
문자열 <date-time>

MongoDB 클라우드가 메트릭 보고를 중단하는 날짜 및 시간입니다. 이 매개변수는 UTC 단위의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 기간을 설정하지 않을 경우 이 매개변수를 포함하세요.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "databaseName": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "granularity": "PT1M",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostId": "mongodb.example.com:27017",
  • "links": [],
  • "measurements": [
    ],
  • "partitionName": "string",
  • "processId": "mongodb.example.com:27017",
  • "start": "2019-08-24T14:15:22Z"
}

네트워크 피어링

네트워크 피어링 컨테이너 및 피어링 연결을 반환, 추가, 편집 및 제거합니다. M10+ 전용 클러스터를 배포할 때 해당 제공자 및 리전에 대한 기존 VPC 또는 VPC 피어링 연결이 없는 경우, Atlas는 선택한 제공자 및 리전에 대한 VPC를 생성합니다. Atlas는 VPC에 클래스 없는 도메인 간 라우팅(CIDR) 블록을 할당합니다.

1개의 클라우드 제공자에 대해 1개의 프로젝트에서 모든 네트워크 피어링 컨테이너 반환

지정된 cloud 제공자에 대해 지정된 프로젝트의 모든 네트워크 피어링 컨테이너에 대한 세부 정보를 반환합니다. cloud 제공자를 지정하지 않으면, MongoDB Cloud는 프로젝트의 모든 네트워크 피어링 컨테이너에 대한 세부 정보를 AWS(Amazon Web Services)용으로 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

providerName
필수
문자열
기본값입니다: "A"
열거형: "A" "AZURE" "GCP"

원하는 네트워크 피어링 컨테이너를 제공하는 cloud 서비스 제공자입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 새 네트워크 피어링 컨테이너 만들기

지정된 프로젝트에 새 네트워크 피어링 컨테이너 한 개를 생성합니다. MongoDB Cloud는 네트워크 피어링 컨테이너에 네트워크 피어링 연결을 배포할 수 있습니다. GCP는 프로젝트당 컨테이너 한 개를 가질 수 있습니다. AWS 및 Azure는 cloud 제공자 리전당 컨테이너 한 개를 가질 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 새 네트워크 피어링 컨테이너 한 개를 생성합니다.

providerName
문자열

요청된 네트워크 피어링 컨테이너를 제공하는 cloud 서비스 제공자입니다.

atlasCidrBlock
문자열^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a...

프로젝트의 네트워크 피어링 컨테이너에 대해 MongoDB Cloud가 사용하는 클래스 없는 도메인 간 라우팅(CIDR) 표기법으로 표현된 IP 주소입니다. MongoDB Cloud는 이 cloud 제공자에 배포된 모든 프로젝트 cluster에 이 범위의 IP 주소를 할당합니다. MongoDB Cloud는 이 프로젝트에 M10 이상의 cluster 또는 네트워크 피어링 연결이 있는 경우 이 값을 잠급니다.

이러한 CIDR 블록은 RFC 1918에 따라 예약된 범위 내에 있어야 합니다. AWS와 Azure는 블록을 /24 ~ /21 범위로 더 제한합니다.

CIDR 블록을 수정하려면 대상 프로젝트에 다음을 포함하면 안 됩니다.

  • M10 이상의 모든 cluster
  • 기타 모든 VPC 피어링 연결

또한 새 프로젝트를 생성하고 네트워크 피어링 연결을 생성하여 해당 프로젝트에 대해 원하는 MongoDB Cloud 네트워크 피어링 컨테이너 CIDR 블록을 설정할 수 있습니다. MongoDB Cloud는 CIDR 블록 및 프로젝트에 대해 선택한 리전을 기반으로 네트워크 피어링 연결당 MongoDB 노드 수를 제한합니다.

예제: 가용성 영역 세 개와 MongoDB CIDR 네트워크 피어링 컨테이너 블록 제한 /24개를 지원하는 Amazon Web Services (AWS) 리전의 프로젝트는 복제본 세트 27개의 3노드와 같습니다.

regionName
필수
문자열
열거형: "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "CA_CENTRAL_1" "EU_NORTH_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_CENTRAL_1" "EU_CENTRAL_2" "SA_EAST_1" "AP_EAST_1" "AP_SOUTHEAST_2" "AP_SOUTHEAST_3" "AP_SOUTHEAST_4" "AP_NORTHEAST_1" "AP_NORTHEAST_2" "AP_NORTHEAST_3" "AP_SOUTHEAST_1" "AP_SOUTH_1" "AP_SOUTH_2" "CN_NORTH_1" "CN_NORTHWEST_1" "ME_CENTRAL_1" "ME_SOUTH_1" "AF_SOUTH_1" "EU_SOUTH_1" "EU_SOUTH_2" "IL_CENTRAL_1" "CA_WEST_1" "GLOBAL" "US_GOV_WEST_1" "US_GOV_EAST_1"

Amazon Web Services(AWS)가 정의한 지리적 영역으로 MongoDB Cloud가 이 네트워크 피어링 컨테이너를 배포했습니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "providerName": "AWS",
  • "atlasCidrBlock": "string",
  • "region": "US_CENTRAL",
  • "regionName": "US_EAST_1"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "provisioned": true,
  • "atlasCidrBlock": "string",
  • "azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
  • "region": "US_CENTRAL",
  • "vnetName": "stringstringstringstringstringstringst",
  • "regionName": "US_EAST_1",
  • "vpcId": "vpc-b555d3b0d9cb783b0"
}

1개의 프로젝트에서 모든 네트워크 피어링 컨테이너 반환

지정된 프로젝트의 모든 네트워크 피어링 컨테이너에 대한 세부 정보를 반환합니다. 네트워크 피어링 컨테이너에는 네트워크 피어링 연결이 포함되어 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 네트워크 피어링 컨테이너 제거

지정된 프로젝트에서 네트워크 피어링 컨테이너 한 개를 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

containerId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

제거하려는 MongoDB Cloud 네트워크 컨테이너를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 네트워크 피어링 컨테이너 반환

지정된 프로젝트 한 개의 네트워크 피어링 컨테이너 한 개에 대한 세부 정보를 반환합니다. 네트워크 피어링 컨테이너에는 네트워크 피어링 연결이 포함되어 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

containerId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

제거하려는 MongoDB Cloud 네트워크 컨테이너를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "provisioned": true,
  • "atlasCidrBlock": "string",
  • "azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
  • "region": "US_CENTRAL",
  • "vnetName": "stringstringstringstringstringstringst",
  • "regionName": "US_EAST_1",
  • "vpcId": "vpc-b555d3b0d9cb783b0"
}

1개의 네트워크 피어링 컨테이너 업데이트

지정된 프로젝트에서 지정된 네트워크 피어링 컨테이너 한 개의 네트워크 세부 정보 및 레이블을 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

containerId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

제거하려는 MongoDB Cloud 네트워크 컨테이너를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에서 지정된 네트워크 피어링 컨테이너 한 개의 네트워크 세부 정보 및 레이블을 업데이트합니다.

providerName
문자열

요청된 네트워크 피어링 컨테이너를 제공하는 cloud 서비스 제공자입니다.

atlasCidrBlock
문자열^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a...

프로젝트의 네트워크 피어링 컨테이너에 대해 MongoDB Cloud가 사용하는 클래스 없는 도메인 간 라우팅(CIDR) 표기법으로 표현된 IP 주소입니다. MongoDB Cloud는 이 cloud 제공자에 배포된 모든 프로젝트 cluster에 이 범위의 IP 주소를 할당합니다. MongoDB Cloud는 이 프로젝트에 M10 이상의 cluster 또는 네트워크 피어링 연결이 있는 경우 이 값을 잠급니다.

이러한 CIDR 블록은 RFC 1918에 따라 예약된 범위 내에 있어야 합니다. AWS와 Azure는 블록을 /24 ~ /21 범위로 더 제한합니다.

CIDR 블록을 수정하려면 대상 프로젝트에 다음을 포함하면 안 됩니다.

  • M10 이상의 모든 cluster
  • 기타 모든 VPC 피어링 연결

또한 새 프로젝트를 생성하고 네트워크 피어링 연결을 생성하여 해당 프로젝트에 대해 원하는 MongoDB Cloud 네트워크 피어링 컨테이너 CIDR 블록을 설정할 수 있습니다. MongoDB Cloud는 CIDR 블록 및 프로젝트에 대해 선택한 리전을 기반으로 네트워크 피어링 연결당 MongoDB 노드 수를 제한합니다.

예제: 가용성 영역 세 개와 MongoDB CIDR 네트워크 피어링 컨테이너 블록 제한 /24개를 지원하는 Amazon Web Services (AWS) 리전의 프로젝트는 복제본 세트 27개의 3노드와 같습니다.

regionName
필수
문자열
열거형: "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "CA_CENTRAL_1" "EU_NORTH_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_CENTRAL_1" "EU_CENTRAL_2" "SA_EAST_1" "AP_EAST_1" "AP_SOUTHEAST_2" "AP_SOUTHEAST_3" "AP_SOUTHEAST_4" "AP_NORTHEAST_1" "AP_NORTHEAST_2" "AP_NORTHEAST_3" "AP_SOUTHEAST_1" "AP_SOUTH_1" "AP_SOUTH_2" "CN_NORTH_1" "CN_NORTHWEST_1" "ME_CENTRAL_1" "ME_SOUTH_1" "AF_SOUTH_1" "EU_SOUTH_1" "EU_SOUTH_2" "IL_CENTRAL_1" "CA_WEST_1" "GLOBAL" "US_GOV_WEST_1" "US_GOV_EAST_1"

Amazon Web Services(AWS)가 정의한 지리적 영역으로 MongoDB Cloud가 이 네트워크 피어링 컨테이너를 배포했습니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "providerName": "AWS",
  • "atlasCidrBlock": "string",
  • "region": "US_CENTRAL",
  • "regionName": "US_EAST_1"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "provisioned": true,
  • "atlasCidrBlock": "string",
  • "azureSubscriptionId": "32b6e34b3d91647abb20e7b8",
  • "region": "US_CENTRAL",
  • "vnetName": "stringstringstringstringstringstringst",
  • "regionName": "US_EAST_1",
  • "vpcId": "vpc-b555d3b0d9cb783b0"
}

1개의 프로젝트에서 모든 네트워크 피어링 연결 반환

지정된 프로젝트의 모든 네트워크 피어링 연결에 대한 세부 정보를 반환합니다. 네트워크 피어링을 사용하면 여러 개의 cloud 호스팅 애플리케이션을 동일한 프로젝트에 안전하게 연결할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

providerName
문자열
기본값입니다: "A"
열거형: "A" "AZURE" "GCP"

이 VPC 피어링 연결에 사용할 cloud 서비스 제공자입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 새 네트워크 피어링 연결 만들기

지정된 프로젝트에 새 네트워크 피어링 연결 한 개를 생성합니다. 네트워크 피어링을 사용하면 여러 개의 cloud 호스팅 애플리케이션을 동일한 프로젝트에 안전하게 연결할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 고려 사항 및 전제 조건에 대해 자세히 알아보려면 네트워크 피어링 설명서를 참조하세요.

Azure 네트워크 피어링 전제 조건
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

네트워크 피어링 연결 한 개를 생성합니다.

accepterRegionName
필수
문자열

MongoDB Cloud VPC로 피어링한 가상 피어링 연결(Virtual Peering Connection, VPC)이 위치한 Amazon Web Services(AWS) 리전입니다. VPC와 MongoDB Cloud VPC가 동일한 리전에 있는 경우 리소스는 null을(를) 반환합니다.

awsAccountId
필수
문자열 = 12자 ^[0-9]{12}$

MongoDB Cloud VPC와 피어링된 VPC를 소유한 Amazon Web Services (AWS) 계정을 식별하는 고유한 12자리 문자열입니다.

containerId
필수
문자열 = 24자 ^([a-f0-9]{24})$

지정된 네트워크 피어링 연결을 포함하는 MongoDB Cloud 네트워크 컨테이너를 식별하는 고유한 24자리 16진수 문자열입니다.

providerName
문자열

요청된 네트워크 피어링 연결을 제공하는 cloud 서비스 제공자입니다.

routeTableCidrBlock
필수
문자열^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

MongoDB Cloud VPC와 피어링하려는 VPC의 서브넷에 대해 클래스 없는 도메인 간 라우팅(CIDR) 표기법으로 표현된 인터넷 프로토콜(IP) 주소입니다.

vpcId
필수
문자열 >= 5자 ^vpc-[0-9a-f]{17}$

MongoDB Cloud VPC와 피어링하려는 Amazon Web Services (AWS)의 VPC를 식별하는 고유 문자열입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "vpcId": "string"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "connectionId": "string",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "errorStateName": "REJECTED",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "statusName": "INITIATING",
  • "vpcId": "string"
}

1개의 기존 네트워크 피어링 연결 제거

지정된 프로젝트에서 네트워크 피어링 연결 한 개를 제거합니다. 프로젝트와 연결된 마지막 네트워크 피어링 연결을 제거하면 MongoDB Cloud는 프로젝트 IP 액세스 목록에서 모든 AWS 보안 그룹도 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

peerId
필수
문자열 = 24자 ^([a-f0-9]{24})$

삭제하려는 네트워크 피어링 연결을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 프로젝트에서 1개의 네트워크 피어링 연결 반환

지정된 프로젝트의 지정된 네트워크 피어링 연결 한 개에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

peerId
필수
문자열 = 24자 ^([a-f0-9]{24})$

조회하려는 네트워크 피어링 연결을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "connectionId": "string",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "errorStateName": "REJECTED",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "statusName": "INITIATING",
  • "vpcId": "string"
}

1개의 새 네트워크 피어링 연결 업데이트

지정된 프로젝트에서 지정된 네트워크 피어링 연결 한 개를 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

peerId
필수
문자열 = 24자 ^([a-f0-9]{24})$

업데이트하려는 네트워크 피어링 연결을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

네트워크 피어링 연결 한 개를 수정합니다.

accepterRegionName
필수
문자열

MongoDB Cloud VPC로 피어링한 가상 피어링 연결(Virtual Peering Connection, VPC)이 위치한 Amazon Web Services(AWS) 리전입니다. VPC와 MongoDB Cloud VPC가 동일한 리전에 있는 경우 리소스는 null을(를) 반환합니다.

awsAccountId
필수
문자열 = 12자 ^[0-9]{12}$

MongoDB Cloud VPC와 피어링된 VPC를 소유한 Amazon Web Services (AWS) 계정을 식별하는 고유한 12자리 문자열입니다.

containerId
필수
문자열 = 24자 ^([a-f0-9]{24})$

지정된 네트워크 피어링 연결을 포함하는 MongoDB Cloud 네트워크 컨테이너를 식별하는 고유한 24자리 16진수 문자열입니다.

providerName
문자열

요청된 네트워크 피어링 연결을 제공하는 cloud 서비스 제공자입니다.

routeTableCidrBlock
필수
문자열^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

MongoDB Cloud VPC와 피어링하려는 VPC의 서브넷에 대해 클래스 없는 도메인 간 라우팅(CIDR) 표기법으로 표현된 인터넷 프로토콜(IP) 주소입니다.

vpcId
필수
문자열 >= 5자 ^vpc-[0-9a-f]{17}$

MongoDB Cloud VPC와 피어링하려는 Amazon Web Services (AWS)의 VPC를 식별하는 고유 문자열입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "vpcId": "string"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "connectionId": "string",
  • "containerId": "32b6e34b3d91647abb20e7b8",
  • "errorStateName": "REJECTED",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "providerName": "AWS",
  • "routeTableCidrBlock": "string",
  • "statusName": "INITIATING",
  • "vpcId": "string"
}

프로젝트 한 개에 대해 피어링 전용 모드를 통한 연결 확인 더 이상 사용되지 않음

누군가가 지정된 프로젝트를 피어링 전용을 통해서만 연결 모드로 설정했는지 확인합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

연결 문자열 변경 사항
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

프로젝트 한 개에 대해 피어링 전용 모드를 통한 연결 비활성화 더 이상 사용되지 않음

지정된 프로젝트에 대해 피어링 전용을 통한 연결 모드를 비활성화합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

연결 문자열 변경 사항
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 대해 피어링 전용을 통한 연결 모드를 비활성화합니다.

enabled
필수
부울

지정된 프로젝트에 대해 누군가가 피어링 전용을 통한 연결 모드를 활성화했는지 여부를 나타내는 플래그입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

온라인 아카이브

온라인 아카이브를 반환, 추가, 편집 또는 제거합니다.

1개의 클러스터에 대해 모든 온라인 아카이브 반환

모든 온라인 아카이브의 세부 정보를 반환합니다. 이 아카이브는 프로젝트 한 개 내에 cluster 한 개의 데이터를 저장합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

온라인 아카이브
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

온라인 아카이브를 반환하려는 컬렉션이 포함된 cluster를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 온라인 아카이브 만들기

온라인 아카이브 한 개를 생성합니다. 이 아카이브는 프로젝트 한 개 내에 cluster 한 개의 데이터를 저장합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 데이터 액세스 관리자 역할이 있어야 합니다.

온라인 아카이브
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

온라인 아카이브 한 개를 생성하려는 컬렉션이 포함된 cluster를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

온라인 아카이브 한 개를 생성합니다.

collName
필수
문자열

온라인 아카이브를 생성한 컬렉션을 식별하는 사람이 읽을 수 있는 레이블입니다.

collectionType
문자열
기본값입니다: "standard"
열거형: "TIMESERIES" "standard"

반환하려는 MongoDB 데이터베이스 컬렉션의 분류입니다.

이 매개변수를 TIMESERIES(으)로 설정하는 경우 "criteria.type" : "date" 및 "criteria.dateFormat" : "ISODATE"을(를) 설정합니다.

필수
객체 (CriteriaView)

MongoDB Cloud가 데이터를 보관하는 규칙입니다.

criteria.type 필드를 사용하여 MongoDB Cloud가 보관할 데이터를 선택하는 방법을 선택합니다. 데이터의 연식 또는 MongoDB 쿼리를 사용하여 데이터를 선택합니다. 'criteria.type': 'DATE'은(는) 날짜를 기반으로 보관할 문서를 선택합니다. 'criteria.type': 'CUSTOM'은(는) 사용자 지정 JSON 쿼리를 기반으로 보관할 문서를 선택합니다. MongoDB Cloud는 'collectionType': 'TIMESERIES' 시 'criteria.type': 'CUSTOM'을(를) 지원하지 않습니다.

객체 (DataExpirationRuleView)

아카이브에서 데이터를 삭제해야 하는 시기를 지정하는 규칙입니다.

객체 (CreateDataProcessRegionView)

보관된 데이터를 저장할 리전을 구성하기 위한 설정입니다.

dbName
필수
문자열

온라인 아카이브가 포함된 컬렉션이 포함된 데이터베이스의 사람이 읽을 수 있는 레이블입니다.

의 배열 개체 (온라인 아카이브 파티션) 비어 있지 않음

컬렉션 내에서 데이터를 논리적으로 나누는 데 사용할 문서 매개변수가 포함된 목록입니다. 파티션은 기본 컬렉션 데이터에 대한 대략적인 수준의 필터링 기능을 제공합니다. 데이터를 분할하려면 자주 쿼리하는 매개변수를 지정합니다. 'specified :criteria.type'(이)라면 CREATE ONE ONLINE ARCHIVE 엔드포인트에 'DATE'를 입력한 다음 쿼리할 매개변수를 최대 세 개까지 지정할 수 있습니다. 이러한 매개변수 중 한 개는 DATE 값이어야 합니다.(이 경우 필수) 'specified :criteria.type'(이)라면 CREATE ONE ONLINE ARCHIVE 엔드포인트에 'CUSTOM'을 입력한 다음 쿼리할 매개변수를 최대 두 개까지 지정할 수 있습니다. ':criteria.type': 'DATE' 또는 ':criteria.type': 'CUSTOM' 매개변수를 사용하지 않는 쿼리는 MongoDB가 모든 보관 문서의 전체 컬렉션을 스캔하게 합니다. 이렇게 하면 시간이 더 걸리고 비용도 증가합니다.

paused
부울

이 온라인 아카이브가 일시 중지된 상태로 있는지 여부를 나타내는 플래그입니다. 컬렉션에 다른 활성 온라인 아카이브가 있는 경우 재개 요청은 실패합니다. 활성 온라인 아카이브를 일시 중지하거나 일시 중지된 온라인 아카이브를 재개하려면 이 매개변수를 포함해야 합니다. 활성 아카이브를 일시 중지하려면 이를 true로 설정합니다. 일시 중지된 아카이브를 재개하려면 이를 false로 설정합니다.

객체 (온라인 아카이브 일정)

보관 프로세스가 발생하는 정기적인 빈도 및 기간입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dbName": "string",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    }
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dataSetName": "string",
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    },
  • "state": "PENDING"
}

온라인 아카이브 쿼리 로그 다운로드

지정된 온라인 아카이브에 대한 쿼리 로그를 다운로드합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 데이터 액세스 읽기 전용 이상의 역할이 있어야 합니다. API는 json 응답 스키마를 사용한 직접 호출을 지원하지 않습니다. 'Accept: application/vnd.atlas.YYYY-MM-DD+gzip' 형식의 수락 헤더를 사용하여 gzip 응답 스키마를 요청해야 합니다.

온라인 아카이브
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

온라인 아카이브 한 개에서 쿼리 로그를 반환하려는 컬렉션이 포함된 cluster를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

startDate
integer <int64> >= 1199145600
예시: startDate=1636481348

반환할 로그 메시지 범위의 시작 지점을 지정하는 날짜 및 시간입니다. 이 리소스는 유닉스 시간 이후 경과된 시간(초)으로 이 값을 표현합니다.

endDate
integer <int64> >= 1199145600
예시: endDate=1636481348

반환할 로그 메시지 범위의 종료 지점을 지정하는 날짜 및 시간입니다. 이 리소스는 유닉스 시간 이후 경과된 시간(초)으로 이 값을 표현합니다.

archiveOnly
부울
기본값입니다: 거짓

온라인 아카이브에 대한 쿼리에 대해서만 로그를 다운로드할지, 아니면 온라인 아카이브와 cluster 모두에 대한 로그를 다운로드할지를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1개의 온라인 아카이브 제거

온라인 아카이브 한 개를 제거합니다. 이 아카이브는 프로젝트 한 개 내에 cluster 한 개의 데이터를 저장합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 데이터 액세스 관리자 역할이 있어야 합니다.

온라인 아카이브
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

archiveId
필수
문자열 = 24자 ^([a-f0-9]{24})$

삭제할 온라인 아카이브를 식별하는 고유한 24자리 16진수 문자열입니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

온라인 아카이브를 제거하려는 컬렉션이 포함된 cluster를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 온라인 아카이브 반환

cluster 한 개의 온라인 아카이브 한 개를 반환합니다. 이 아카이브는 프로젝트 한 개 내에 cluster 한 개의 데이터를 저장합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

온라인 아카이브
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

archiveId
필수
문자열 = 24자 ^([a-f0-9]{24})$

반환할 온라인 아카이브를 식별하는 고유한 24자리 16진수 문자열입니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

애플리케이션에서 온라인 아카이브를 생성한 특정 컬렉션이 포함된 cluster를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dataSetName": "string",
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    },
  • "state": "PENDING"
}

1개의 온라인 아카이브 업데이트

온라인 아카이브 한 개를 업데이트, 일시 중지 또는 재개합니다. 이 아카이브는 프로젝트 한 개 내에 cluster 한 개의 데이터를 저장합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 데이터 액세스 관리자 역할이 있어야 합니다.

온라인 아카이브
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

archiveId
필수
문자열 = 24자 ^([a-f0-9]{24})$

업데이트할 온라인 아카이브를 식별하는 고유한 24자리 16진수 문자열입니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

애플리케이션에서 온라인 아카이브를 생성한 특정 컬렉션이 포함된 cluster를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

온라인 아카이브 한 개를 업데이트, 일시 중지 또는 재개합니다.

객체 (CriteriaView)

MongoDB Cloud가 데이터를 보관하는 규칙입니다.

criteria.type 필드를 사용하여 MongoDB Cloud가 보관할 데이터를 선택하는 방법을 선택합니다. 데이터의 연식 또는 MongoDB 쿼리를 사용하여 데이터를 선택합니다. 'criteria.type': 'DATE'은(는) 날짜를 기반으로 보관할 문서를 선택합니다. 'criteria.type': 'CUSTOM'은(는) 사용자 지정 JSON 쿼리를 기반으로 보관할 문서를 선택합니다. MongoDB Cloud는 'collectionType': 'TIMESERIES' 시 'criteria.type': 'CUSTOM'을(를) 지원하지 않습니다.

객체 (DataExpirationRuleView)

아카이브에서 데이터를 삭제해야 하는 시기를 지정하는 규칙입니다.

paused
부울

이 온라인 아카이브가 일시 중지된 상태로 있는지 여부를 나타내는 플래그입니다. 컬렉션에 다른 활성 온라인 아카이브가 있는 경우 재개 요청은 실패합니다. 활성 온라인 아카이브를 일시 중지하거나 일시 중지된 온라인 아카이브를 재개하려면 이 매개변수를 포함해야 합니다. 활성 아카이브를 일시 중지하려면 이를 true로 설정합니다. 일시 중지된 아카이브를 재개하려면 이를 false로 설정합니다.

객체 (온라인 아카이브 일정)

보관 프로세스가 발생하는 정기적인 빈도 및 기간입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "paused": true,
  • "schedule": {
    }
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "TIMESERIES",
  • "criteria": {
    },
  • "dataExpirationRule": {
    },
  • "dataProcessRegion": {
    },
  • "dataSetName": "string",
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "partitionFields": [
    ],
  • "paused": true,
  • "schedule": {
    },
  • "state": "PENDING"
}

조직

MongoDB Cloud에서 조직 단위를 반환, 추가 및 편집할 수 있습니다.

모든 조직 반환

요청하는 API 키가 액세스할 수 있는 모든 조직을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

권한 부여
DigestAuth
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

이름
문자열

반환된 목록을 필터링하는 데 사용할 조직의 사람이 읽을 수 있는 레이블입니다. 지정된 이름으로 시작하는 조직에 대해 대소문자를 구분하지 않는 검색을 수행합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 조직 만들기

MongoDB Cloud에 조직 한 개를 생성하고 이를 요청하는 API 키의 조직에 연결합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다. 요청하는 API 키의 조직은 유료 조직이어야 합니다. 자세한 내용은 MongoDB Atlas 설명서의 유료 조직 구성을 참조하세요.

권한 부여
DigestAuth
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

생성하려는 조직입니다.

객체 (CreateAtlasOrganizationApiKey)

생성할 프로그래밍 방식 API 키의 세부 정보입니다.

federationSettingsId
문자열 = 24자 ^([a-f0-9]{24})$

새로 생성된 조직을 연결할 페더레이션을 식별하는 고유한 24자리 16진수 문자열입니다. 지정된 경우 새 조직의 제안된 조직 소유자는 페더레이션과 관련된 조직에서 조직 소유자 역할이 있어야 합니다.

이름
필수
문자열 [ 1 ... 64 ] 문자 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

조직을 식별하는 사람이 읽을 수 있는 레이블입니다.

orgOwnerId
문자열 = 24자 ^([a-f0-9]{24})$

조직 소유자 역할을 할당하려는 MongoDB Cloud 사용자를 식별하는 고유한 24자리 16진수 문자열입니다. 이 사용자는 호출하는 API 키와 동일한 조직의 구성원이어야 합니다. federationSettingsId을(를) 제공하는 경우 대신 이 사용자는 지정된 페더레이션의 조직에 대한 조직 소유자 역할이 있어야 합니다. 이 매개변수는 프로그래밍 방식 API 키로 인증하는 경우에만 필요합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "apiKey": {
    },
  • "federationSettingsId": "32b6e34b3d91647abb20e7b8",
  • "name": "string",
  • "orgOwnerId": "32b6e34b3d91647abb20e7b8"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "apiKey": {
    },
  • "federationSettingsId": "32b6e34b3d91647abb20e7b8",
  • "orgOwnerId": "32b6e34b3d91647abb20e7b8",
  • "organization": {}
}

1개의 조직 제거

지정된 조직 한 개를 제거합니다. MongoDB Cloud는 이 리소스에 대해 다음과 같은 제한 사항을 적용합니다.

  • 활성 프로젝트가 있는 조직은 제거할 수 없습니다.
  • 조직을 제거하려면 먼저 조직의 모든 프로젝트를 제거해야 합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 조직 반환

요청하는 API 키가 액세스할 수 있는 조직 한 개를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 조직 이름 바꾸기

조직 한 개의 이름을 변경합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 조직에서 업데이트할 세부 정보입니다.

이름
필수
문자열 [ 1 ... 64 ] 문자 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

조직을 식별하는 사람이 읽을 수 있는 레이블입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "name": "string"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 조직에서 1개 이상의 프로젝트 반환

지정된 조직의 여러 프로젝트를 반환합니다. 각 조직에는 여러 개의 프로젝트가 있을 수 있습니다. 프로젝트를 사용하여 다음을 수행할 수 있습니다.

  • 개발, 테스트, 프로덕션 환경 등 다양한 환경을 서로 격리합니다.
  • 다양한 MongoDB Cloud 사용자 또는 팀을 다양한 환경과 연결하거나 다양한 환경의 MongoDB Cloud 사용자에게 다양한 권한을 부여합니다.
  • 별도의 cluster 보안 구성을 유지 관리합니다.
  • 다양한 경고 설정을 생성합니다.

이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

이름
문자열

반환된 목록을 필터링하는 데 사용할 프로젝트의 사람이 읽을 수 있는 레이블입니다. 지정된 이름이 접두사로 붙은 조직 내 프로젝트에 대해 대소문자를 구분하지 않고 검색을 수행합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

모든 조직 초대 반환

지정된 조직에 대기 중인 모든 초대를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

사용자 이름
문자열 <email>

이 조직에 초대된 사용자 계정의 이메일 주소입니다. 이 매개변수를 제외하면 이 리소스는 대기 중인 모든 초대를 반환합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1개의 조직 초대 업데이트

지정된 조직에 대기 중인 초대 한 개의 세부 정보를 업데이트합니다. 초대를 지정하려면 초대된 사용자의 사용자 이름을 제공합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 조직에 대기 중인 초대 한 개의 세부 정보를 업데이트합니다.

의 배열 개체 (OrganizationInvitationGroupRoleAssignmentsRequest)

사용자가 조직에 대한 초대를 수락하면 추가될 프로젝트 목록입니다.

roles
의 배열 strings unique
항목 열거형: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

MongoDB Cloud 사용자에게 할당할 한 개 이상의 조직 수준 역할입니다.

teamIds
의 배열 strings unique [ 항목 = 24자 ^([a-f0-9]{24})$ ]

원하는 MongoDB Cloud 사용자를 초대하려는 팀 목록입니다.

사용자 이름
문자열 <email>

원하는 MongoDB Cloud 사용자의 이메일 주소입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "groupRoleAssignments": [
    ],
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

1명의 MongoDB 클라우드 사용자를 1개의 Atlas 조직에 초대

지정된 조직에 조인하도록 MongoDB Cloud 사용자 한 명을 초대합니다. 지정된 조직 내의 정보에 액세스하려면 사용자가 초대를 수락해야 합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 조직에 조인하도록 MongoDB Cloud 사용자 한 명을 초대합니다.

의 배열 개체 (OrganizationInvitationGroupRoleAssignmentsRequest)

사용자가 조직에 대한 초대를 수락하면 추가될 프로젝트 목록입니다.

roles
의 배열 strings unique
항목 열거형: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

MongoDB Cloud 사용자에게 할당할 한 개 이상의 조직 수준 역할입니다.

teamIds
의 배열 strings unique [ 항목 = 24자 ^([a-f0-9]{24})$ ]

원하는 MongoDB Cloud 사용자를 초대하려는 팀 목록입니다.

사용자 이름
문자열 <email>

원하는 MongoDB Cloud 사용자의 이메일 주소입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "groupRoleAssignments": [
    ],
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

1개의 조직 초대 취소

조직에 조인하도록 지정된 MongoDB Cloud 사용자에게 보낸 대기 중인 초대 한 개를 취소합니다. 사용자가 수락한 초대는 취소할 수 없습니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

invitationId
필수
문자열

초대를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 조직 초대 반환

지정된 조직에 대기 중인 초대 한 개의 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

invitationId
필수
문자열 = 24자 ^([a-f0-9]{24})$

초대를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

초대 ID로 1개의 조직 초대 업데이트

지정된 조직에 대기 중인 초대 한 개의 세부 정보를 업데이트합니다. 초대를 지정하려면 해당 초대에 대한 고유 ID 문자열을 제공합니다. 모든 조직 초대 반환 엔드포인트를 사용하여 대기 중인 모든 조직 초대의 ID를 조회합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

invitationId
필수
문자열 = 24자 ^([a-f0-9]{24})$

초대를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 조직에 대기 중인 초대 한 개의 세부 정보를 업데이트합니다.

의 배열 개체 (OrganizationInvitationGroupRoleAssignmentsRequest)

사용자가 조직에 대한 초대를 수락하면 추가될 프로젝트 목록입니다.

roles
의 배열 strings unique
항목 열거형: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

MongoDB Cloud 사용자에게 할당할 한 개 이상의 조직 수준 역할입니다.

teamIds
의 배열 strings unique [ 항목 = 24자 ^([a-f0-9]{24})$ ]

원하는 MongoDB Cloud 사용자를 초대하려는 팀 목록입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "groupRoleAssignments": [
    ],
  • "roles": [
    ],
  • "teamIds": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

1개의 조직에 대해 설정 반환

지정된 조직의 설정에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "apiAccessListRequired": true,
  • "multiFactorAuthRequired": true,
  • "restrictEmployeeAccess": true
}

1개의 조직에 대해 설정 업데이트

조직의 설정을 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 조직의 설정을 업데이트할 세부 정보입니다.

apiAccessListRequired
부울

지정된 조직의 API 액세스 목록에 추가된 IP 주소에서 API 작업 시작을 요구할지 여부를 나타내는 플래그입니다.

multiFactorAuthRequired
부울

사용자가 지정된 조직에 액세스하기 전에 MFA(다단계 인증) 설정을 요구할지 여부를 나타내는 플래그입니다. 자세한 내용은 https://www.mongodb.com/ko-kr/docs/atlas/security-multi-factor-authentication/ 을 참조하세요.

restrictEmployeeAccess
부울

지정된 조직의 모든 배포에 대해 명시적인 권한 없이 MongoDB 지원이 Atlas 인프라에 액세스하는 것을 차단할지 여부를 나타내는 플래그입니다. 이 설정을 켜면 MongoDB 지원팀에 24시간의 Atlas 배포서버 우회 액세스 권한을 부여하여 지원 문제를 해결할 수 있습니다. 자세한 내용은 https://www.mongodb.com/ko-kr/docs/atlas/security-restrict-support-access/ 를 참조하세요.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "apiAccessListRequired": true,
  • "multiFactorAuthRequired": true,
  • "restrictEmployeeAccess": true
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "apiAccessListRequired": true,
  • "multiFactorAuthRequired": true,
  • "restrictEmployeeAccess": true
}

1개의 조직에서 모든 MongoDB 클라우드 사용자 반환

지정된 조직과 연결된 MongoDB Cloud 사용자에 대한 세부 정보를 반환합니다. 반환된 각 MongoDB Cloud 사용자는 지정된 조직 또는 지정된 조직 내의 프로젝트에 속해야 합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 조직에서 1명의 MongoDB 클라우드 사용자 제거

지정된 조직에서 MongoDB Cloud 사용자 한 명을 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 사용자 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

userId
필수
문자열 = 24자 ^([a-f0-9]{24})$

삭제할 사용자를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1명의 MongoDB 클라우드 사용자에 대해 조직 역할 업데이트

지정된 조직에서 지정된 사용자의 역할을 업데이트합니다. 업데이트할 사용자를 지정하려면 지정된 조직의 사용자를 식별하는 고유한 24자리 16진수 문자열을 제공합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 사용자 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

userId
필수
문자열 = 24자 ^([a-f0-9]{24})$

수정할 사용자를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 사용자에 대해 업데이트할 역할입니다.

orgRoles
의 배열 strings unique
항목 열거형: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

MongoDB Cloud 사용자에게 할당할 한 개 이상의 조직 수준 역할입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "orgRoles": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

Performance Advisor

데이터베이스 배포를 위한 추천 인덱스 및 느린 쿼리 데이터를 반환합니다. 또한 MongoDB Cloud에서 관리되는 느린 작업 임계값을 활성화 또는 비활성화합니다. 샘플 쿼리에서 필드 값을 보려면 프로젝트 데이터 액세스 읽기 전용 역할 이상이 있어야 합니다. 그렇지 않으면 MongoDB Cloud는 필드 값이 아닌 수정된 데이터를 반환합니다.

느린 작업 임계값 관리 비활성화

지정된 프로젝트에 대해 MongoDB Cloud가 계산한 느린 작업 임계값을 비활성화합니다. 임계값은 Performance Advisor와 쿼리 프로파일러가 느리다고 간주하는 작업을 결정합니다. 이 기능을 활성화하면 MongoDB Cloud는 cluster에서 작업의 평균 실행 시간을 사용하여 느리게 실행되는 쿼리를 결정합니다. 따라서 임계값은 cluster 워크로드와 더 관련이 있습니다. 느린 작업 임계값은 전용 클러스터(M10+)에 대해 기본값으로 활성화되어 있습니다. 비활성화되면 MongoDB Cloud는 100밀리초 이상 걸리는 모든 작업을 느린 작업으로 간주합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "reason": "Unauthorized"
}

느린 작업 임계값 관리 활성화

지정된 프로젝트에 대해 MongoDB Cloud의 느린 작업 임계값 사용을 활성합니다. 임계값은 Performance Advisor와 쿼리 프로파일러가 느리다고 간주하는 작업을 결정합니다. 이 기능을 활성화하면 MongoDB Cloud는 cluster에서 작업의 평균 실행 시간을 사용하여 느리게 실행되는 쿼리를 결정합니다. 따라서 임계값은 cluster 워크로드와 더 관련이 있습니다. 느린 작업 임계값은 전용 클러스터(M10+)에 대해 기본값으로 활성화되어 있습니다. 비활성화되면 MongoDB Cloud는 100밀리초 이상 걸리는 모든 작업을 느린 작업으로 간주합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "reason": "Unauthorized"
}

1개의 호스트의 모든 네임스페이스 반환

지정된 호스팅에서 쿼리 속도가 느린 컬렉션에 대해 최대 20개의 네임스페이스를 반환합니다. 데이터베이스 읽기 작업을 받지 않은 복제본 세트의 세컨더리 멤버를 지정하는 경우 엔드포인트는 네임스페이스를 반환하지 않습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...

MongoDB 프로세스를 제공하는 호스트와 포트의 조합입니다. 호스트는 MongoDB 프로세스(mongod 또는 mongos)를 실행하는 호스트의 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신하는 IANA 포트여야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

기간
integer <int64>

쿼리가 cluster의 관리형 네임스페이스 중에서 추천 인덱스를 찾는 동안 표현된 시간입니다. 이 매개변수는 해당 값을 밀리초 단위로 표현합니다.

  • 이후 매개변수를 지정하지 않으면 엔드포인트는 현재 시간 이전의 기간을 포함하는 데이터를 반환합니다.
  • 기간 또는 이후 매개변수를 모두 지정하지 않으면 엔드포인트는 이전 24시간 동안의 데이터를 반환합니다.
이후
integer <int64> >= 1199145600000

쿼리가 추천 인덱스를 조회하는 날짜 및 시간입니다. 이 매개변수는 유닉스 시간 이후 경과된 시간(밀리초)으로 값을 표현합니다.

  • 기간 매개변수를 지정하지 않으면 엔드포인트는 이후 값과 현재 시간을 포함하는 데이터를 반환합니다.
  • 기간 또는 이후 매개변수를 모두 지정하지 않으면 엔드포인트는 이전 24시간 동안의 데이터를 반환합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "namespaces": [
    ]
}

느린 쿼리 반환

Performance Advisor와 쿼리 프로파일러가 식별한 느린 쿼리에 대한 로그 줄을 반환합니다. Performance Advisor는 MongoDB가 느리다고 판단한 쿼리를 모니터링하고 쿼리 성능을 향상시키기 위해 새 인덱스를 추천합니다. MongoDB Cloud는 cluster의 평균 작업 시간을 기준으로 느린 쿼리에 대한 임계값을 설정합니다. 이를 통해 워크로드 관련 추천이 활성화됩니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 데이터 액세스 읽기 쓰기 (write) 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...

MongoDB 프로세스를 제공하는 호스트와 포트의 조합입니다. 호스트는 MongoDB 프로세스(mongod 또는 mongos)를 실행하는 호스트의 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신하는 IANA 포트여야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

기간
integer <int64>

쿼리가 cluster의 관리형 네임스페이스 중에서 느린 쿼리를 찾는 동안 표현된 시간입니다. 이 매개변수는 해당 값을 밀리초 단위로 표현합니다.

  • 이후 매개변수를 지정하지 않으면 엔드포인트는 현재 시간 이전의 기간을 포함하는 데이터를 반환합니다.
  • 기간 또는 이후 매개변수를 모두 지정하지 않으면 엔드포인트는 이전 24시간 동안의 데이터를 반환합니다.
namespaces
의 배열 strings

느린 쿼리를 조회할 네임스페이스입니다. 네임스페이스는 데이터베이스 한 개와 .: <database>.<collection>(으)로 작성된 컬렉션 리소스 한 개로 구성됩니다. 여러 네임스페이스를 포함하려면 각 네임스페이스 사이에 앰퍼샌드(&)로 구분하여 매개변수를 여러 번 전달합니다. 모든 네임스페이스에 대한 결과를 반환하려면 이 매개변수를 생략합니다.

nLogs
integer <int64> [ 0 .. 20000 ]
기본값입니다: 20000

반환할 로그의 최대 줄 수입니다.

이후
integer <int64> >= 1199145600000

쿼리가 느린 쿼리를 조회하는 날짜 및 시간입니다. 이 매개변수는 유닉스 시간 이후 경과된 시간(밀리초)으로 값을 표현합니다.

  • 기간 매개변수를 지정하지 않으면 엔드포인트는 이후 값과 현재 시간을 포함하는 데이터를 반환합니다.
  • 기간 또는 이후 매개변수를 모두 지정하지 않으면 엔드포인트는 이전 24시간 동안의 데이터를 반환합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "slowQueries": [
    ]
}

추천 인덱스 반환

Performance Advisor가 제안하는 인덱스를 반환합니다. Performance Advisor는 MongoDB가 느리다고 판단한 쿼리를 모니터링하고 쿼리 성능을 향상시키기 위해 새 인덱스를 추천합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

processId
필수
문자열^ ([0-9] {1,3}\.){3}[0-9] {1,3} | ([0-9a-f] {1,4}\:...

MongoDB 프로세스를 제공하는 호스트와 포트의 조합입니다. 호스트는 MongoDB 프로세스(mongod 또는 mongos)를 실행하는 호스트의 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소여야 합니다. 포트는 MongoDB 프로세스가 요청을 수신하는 IANA 포트여야 합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

기간
integer <int64>

쿼리가 cluster의 관리형 네임스페이스 중에서 추천 인덱스를 찾는 동안 표현된 시간입니다. 이 매개변수는 해당 값을 밀리초 단위로 표현합니다.

  • 이후 매개변수를 지정하지 않으면 엔드포인트는 현재 시간 이전의 기간을 포함하는 데이터를 반환합니다.
  • 기간 또는 이후 매개변수를 모두 지정하지 않으면 엔드포인트는 이전 24시간 동안의 데이터를 반환합니다.
namespaces
의 배열 strings

추천 인덱스를 조회할 네임스페이스입니다. 네임스페이스는 데이터베이스 한 개와 .: <database>.<collection>(으)로 작성된 컬렉션 리소스 한 개로 구성됩니다. 여러 네임스페이스를 포함하려면 각 네임스페이스 사이에 앰퍼샌드(&)로 구분하여 매개변수를 여러 번 전달합니다. 모든 네임스페이스에 대한 결과를 반환하려면 이 매개변수를 생략합니다.

nExamples
integer <int64>
기본값입니다: 5

추천 인덱스의 이점을 누릴 수 있는 최대 예제 쿼리 수입니다.

nIndexes
integer <int64>

추천할 최대 인덱스를 나타내는 숫자입니다.

이후
integer <int64> >= 1199145600000

쿼리가 추천 인덱스를 조회하는 날짜 및 시간입니다. 이 매개변수는 유닉스 시간 이후 경과된 시간(밀리초)으로 값을 표현합니다.

  • 기간 매개변수를 지정하지 않으면 엔드포인트는 이후 값과 현재 시간을 포함하는 데이터를 반환합니다.
  • 기간 또는 이후 매개변수를 모두 지정하지 않으면 엔드포인트는 이전 24시간 동안의 데이터를 반환합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "shapes": [
    ],
  • "suggestedIndexes": [
    ]
}

서버리스 자동 인덱싱 활성화 상태 반환

서버리스 자동 인덱싱 기능이 활성화되어 있는지 확인합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
true

서버리스 자동 인덱싱 설정

서버리스 자동 인덱싱 기능을 활성화할지 여부를 설정합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
활성화
필수
부울

서버리스 자동 인덱싱 토글에 대해 설정하려는 값입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

비공개 엔드포인트 서비스

비공개 엔드포인트 서비스를 반환, 추가, 편집 및 제거합니다.

1개의 제공자에 대해 1개의 비공개 엔드포인트 서비스 만들기

지정된 cloud 서비스 제공자에 대한 비공개 엔드포인트 서비스 한 개를 생성합니다. 이 cloud 서비스 제공자는 프로젝트의 비공개 엔드포인트 서비스를 managed합니다. 비공개 엔드포인트 서비스를 생성할 때 MongoDB Cloud는 비공개 엔드포인트 서비스를 생성하는 클라우드 공급자에 대한 네트워크 container를 프로젝트에 생성합니다(아직 없는 경우). MongoDB Cloud의 비공개 엔드포인트 용어에 대해 자세히 알아보려면 비공개 엔드포인트 개념을 참조하세요. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

비공개 엔드포인트 개념
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 cloud 서비스 제공자에 대한 비공개 엔드포인트 한 개를 생성합니다.

providerName
필수
문자열
열거형: "A" "AZURE" "GCP"

비공개 엔드포인트 서비스를 생성하려는 cloud 서비스 제공자를 식별하는 사람이 읽을 수 있는 레이블입니다.

region
필수
문자열

비공개 엔드포인트 서비스를 생성하려는 cloud 제공자 리전입니다. 값으로 허용되는 리전은 Amazon Web Services, Google Cloud Platform 및 Microsoft Azure에 따라 다릅니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "providerName": "AWS",
  • "region": "string"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "cloudProvider": "AWS",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "interfaceEndpoints": [
    ],
  • "regionName": "string",
  • "status": "INITIATING"
}

리전화된 비공개 엔드포인트 상태 반환

지정된 cloud 서비스 제공자의 각 리전이 리전당 여러 비공개 엔드포인트를 생성할 수 있는지 확인합니다. cloud 서비스 제공자가 프로젝트의 비공개 엔드포인트를 관리합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

리전화된 비공개 엔드포인트 상태 토글

프로젝트 한 개에서 모든 cloud 서비스 제공자가 리전별로 비공개 엔드포인트를 여러 개 생성하는 기능을 활성화하거나 비활성화합니다. cloud 서비스 제공자가 프로젝트의 비공개 엔드포인트를 관리합니다. 이 설정을 활성화하면 기존 멀티 리전 및 글로벌 샤드 클러스터에 대한 연결 문자열이 변경됩니다. 새 연결 문자열을 사용하려면 애플리케이션을 업데이트해야 합니다. 이로 인해 다운타임이 발생할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 하며 배포서버의 모든 cluster가 샤딩 클러스터여야 합니다. 활성화하면 복제본 세트를 생성할 수 없습니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

프로젝트 한 개에서 모든 cloud 서비스 제공자가 리전별로 비공개 엔드포인트를 여러 개 생성하는 기능을 활성화하거나 비활성화합니다.

enabled
필수
부울

누군가가 지정된 프로젝트에 대해 리전화된 비공개 엔드포인트 설정을 활성화했는지 여부를 나타내는 플래그입니다.

  • 리전화된 비공개 엔드포인트를 사용하려면 이 값을 true(으)로 설정합니다. 이렇게 하면 cloud 제공자 리전에 비공개 엔드포인트를 두 개 이상 생성할 수 있습니다. 멀티 리전 및 글로벌 MongoDB Cloud 샤드 클러스터에 연결하려면 이 설정을 활성화해야 합니다. 리전화된 비공개 엔드포인트를 활성화하면 다음과 같은 제한 사항이 발생합니다.

    • 애플리케이션은 기존 멀티 리전 및 글로벌 샤드 클러스터에 대해 새 연결 문자열을 사용해야 합니다. 이로 인해 다운타임이 발생할 수 있습니다.

    • MongoDB Cloud 프로젝트에는 복제본 세트가 포함될 수 없으며 이 프로젝트에서 새 복제본 세트를 생성할 수도 없습니다.

    • 다음의 경우 비활성화할 수 없습니다.

      • 리전 두 곳 이상에 있는 비공개 엔드포인트 두 개 이상
      • 한 리전에 두 개 이상의 비공개 엔드포인트와 하나 이상의 리전에 있는 하나의 비공개 엔드포인트.

  • 리전화된 비공개 엔드포인트를 비활성화하려면 이 값을 false(으)로 설정합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "enabled": true
}

1개의 제공자에 대해 모든 비공개 엔드포인트 서비스 반환

지정된 cloud 서비스 제공자에 대한 모든 비공개 엔드포인트 서비스의 이름, 인터페이스 및 상태를 반환합니다. 이 cloud 서비스 제공자는 프로젝트의 비공개 엔드포인트 서비스를 관리합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

cloudProviders
필수
문자열
기본값입니다: "A"
열거형: "A" "AZURE" "GCP"

이 비공개 엔드포인트 서비스를 관리하는 cloud 서비스 제공자입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1개의 제공자에 대해 1개의 비공개 엔드포인트 서비스 제거

지정된 프로젝트에서 비공개 엔드포인트 서비스 한 개를 제거합니다. 이 cloud 서비스 제공자는 프로젝트에 속한 비공개 엔드포인트 서비스를 관리합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

cloudProviders
필수
문자열
기본값입니다: "A"
열거형: "A" "AZURE" "GCP"

이 비공개 엔드포인트 서비스를 관리하는 cloud 서비스 제공자입니다.

endpointServiceId
필수
문자열 = 24자 ^([a-f0-9]{24})$

삭제하려는 비공개 엔드포인트 서비스를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 제공자에 대해 1개의 비공개 엔드포인트 서비스 반환

프로젝트 한 개에서 지정된 비공개 엔드포인트 서비스의 이름, 인터페이스 및 상태를 반환합니다. cloud 서비스 제공자는 프로젝트에 속하는 이 비공개 엔드포인트 서비스를 호스팅했습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

cloudProviders
필수
문자열
기본값입니다: "A"
열거형: "A" "AZURE" "GCP"

이 비공개 엔드포인트 서비스를 관리하는 cloud 서비스 제공자입니다.

endpointServiceId
필수
문자열 = 24자 ^([a-f0-9]{24})$

반환하려는 비공개 엔드포인트 서비스를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "cloudProvider": "AWS",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "interfaceEndpoints": [
    ],
  • "regionName": "string",
  • "status": "INITIATING"
}

1개의 제공자에 대해 1개의 비공개 엔드포인트 만들기

지정된 cloud 서비스 제공자에 대한 비공개 엔드포인트 한 개를 생성합니다. 이 cloud 서비스 제공자는 비공개 엔드포인트 서비스를 관리하며, 이 서비스는 다시 프로젝트의 비공개 엔드포인트를 관리합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 고려 사항, 제한 사항 및 필수 구성 요소에 대한 자세한 내용은 비공개 엔드포인트 설정에 대한 MongoDB 설명서를 참조하세요.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

cloudProviders
필수
문자열
기본값입니다: "A"
열거형: "A" "AZURE" "GCP"

이 비공개 엔드포인트를 관리하는 cloud 서비스 제공자입니다.

endpointServiceId
필수
문자열 = 24자 ^([a-f0-9]{24})$

비공개 엔드포인트를 생성하려는 비공개 엔드포인트 서비스를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 cloud 서비스 제공자에 대한 비공개 엔드포인트 한 개를 생성합니다.

다음 중 하나
객체 AWS 재귀

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "id": "vpce-3bf78b0ddee411ba1"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "cloudProvider": "AWS",
  • "connectionStatus": "PENDING_ACCEPTANCE",
  • "deleteRequested": true,
  • "errorMessage": "string",
  • "interfaceEndpointId": "32b6e34b3d91647abb20e7b8"
}

1개의 제공자에 대해 1개의 비공개 엔드포인트 제거

지정된 cloud 서비스 제공자가 관리하는 지정된 프로젝트 및 비공개 엔드포인트 서비스에서 비공개 엔드포인트 한 개를 제거합니다. 주어진 비공개 엔드포인트 서비스에서 마지막 비공개 엔드포인트가 제거되면 해당 비공개 엔드포인트 서비스도 제거됩니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

cloudProviders
필수
문자열
기본값입니다: "A"
열거형: "A" "AZURE" "GCP"

이 비공개 엔드포인트를 관리하는 cloud 서비스 제공자입니다.

endpointId
필수
문자열^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF]...

삭제하려는 비공개 엔드포인트를 식별하는 고유 문자열입니다. endpointId 매개변수의 형식은 AWS와 Azure에 따라 다릅니다. Azure 비공개 엔드포인트의 endpointId를 URL 인코딩해야 합니다.

endpointServiceId
필수
문자열 = 24자 ^([a-f0-9]{24})$

비공개 엔드포인트를 삭제하려는 비공개 엔드포인트 서비스를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 제공자에 대해 1개의 비공개 엔드포인트 반환

지정된 비공개 엔드포인트의 연결 상태를 반환합니다. 비공개 엔드포인트 서비스는 한 cloud 서비스 제공자가 호스팅하는 프로젝트 한 개에 속하는 이 비공개 엔드포인트를 관리합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

cloudProviders
필수
문자열
기본값입니다: "A"
열거형: "A" "AZURE" "GCP"

이 비공개 엔드포인트를 관리하는 cloud 서비스 제공자입니다.

endpointId
필수
문자열^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF]...

반환하려는 비공개 엔드포인트를 식별하는 고유 문자열입니다. endpointId 매개변수의 형식은 AWS와 Azure에 따라 다릅니다. Azure 비공개 엔드포인트의 endpointId를 URL 인코딩해야 합니다.

endpointServiceId
필수
문자열 = 24자 ^([a-f0-9]{24})$

비공개 엔드포인트를 반환하려는 비공개 엔드포인트 서비스를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "cloudProvider": "AWS",
  • "connectionStatus": "PENDING_ACCEPTANCE",
  • "deleteRequested": true,
  • "errorMessage": "string",
  • "interfaceEndpointId": "32b6e34b3d91647abb20e7b8"
}

프로그래밍 방식 API 키

MongoDB Cloud API를 사용하기 위한 액세스 토큰을 반환, 추가, 편집 및 제거합니다. MongoDB Cloud는 이러한 키를 조직에 적용합니다. 이러한 리소스는 지정된 프로젝트 내에서 이러한 키의 사용을 반환, 할당 또는 취소할 수 있습니다.

1개의 프로젝트에 할당된 모든 조직 API 키 반환

지정된 프로젝트에 할당한 모든 조직 API 키를 반환합니다. API 키와 연결된 프로젝트에서 프로젝트 소유자 역할이 있는 사용자는 조직 API 키를 사용하여 리소스에 액세스할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

프로그래밍 방식 API 키
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 프로젝트에 조직 API 키 1개 생성 및 할당

지정된 조직 API 키를 생성하고 지정된 프로젝트에 할당합니다. API 키와 연결된 프로젝트에서 프로젝트 소유자 역할이 있는 사용자는 조직 API 키를 사용하여 리소스에 액세스할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 생성 및 할당될 조직 API 키입니다.

desc
필수
문자열 [1 ... 250 ]자

누군가 이 프로젝트 API 키를 생성했을 때 제공한 목적 또는 설명입니다.

roles
필수
의 배열 strings 비어 있지 않음
항목 열거형: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN" "GROUP_ATLAS_ADMIN" "GROUP_AUTOMATION_ADMIN" "GROUP_BACKUP_ADMIN" "GROUP_MONITORING_ADMIN" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_USER_ADMIN" "GROUP_BILLING_ADMIN" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_CHARTS_ADMIN" "GROUP_CLUSTER_MANAGER" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER"

이 API 키를 부여할 역할 목록입니다. 이 목록을 제공하는 경우 역할을 최소 한 개 제공하고 각 역할이 이 프로젝트에 적용되는지 확인합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "roles": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

1개의 프로젝트에 조직 API 키 1개의 할당 해제

지정된 프로젝트에서 조직 API 키 한 개를 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

프로그래밍 방식 API 키
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

apiUserId
필수
문자열 = 24자 ^([a-f0-9]{24})$

프로젝트 한 개에서 할당을 취소하려는 이 조직 API 키를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 조직 API 키의 역할을 1개의 프로젝트로 업데이트

지정한 프로젝트에 대해 지정하는 조직 API 키의 역할을 업데이트합니다. 프로젝트에 유효한 역할을 한 개 이상 지정해야 합니다. 프로젝트에 대해 지정한 조직 API 키에 이전에 설정된 역할이 있는 경우 이 요청에 포함하지 않은 역할은 애플리케이션에서 제거됩니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

apiUserId
필수
문자열 = 24자 ^([a-f0-9]{24})$

프로젝트 한 개에서 할당을 취소하려는 이 조직 API 키를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

업데이트할 조직 API 키입니다. 이 요청에는 본문 매개변수 두 개 중 최소 한 개가 필요합니다.

desc
문자열 [1 ... 250 ]자

누군가 이 프로젝트 API 키를 생성할 때 제공한 목적 또는 설명입니다.

roles
의 배열 strings
항목 열거형: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN" "GROUP_ATLAS_ADMIN" "GROUP_AUTOMATION_ADMIN" "GROUP_BACKUP_ADMIN" "GROUP_MONITORING_ADMIN" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_USER_ADMIN" "GROUP_BILLING_ADMIN" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_CHARTS_ADMIN" "GROUP_CLUSTER_MANAGER" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER"

이 API 키를 부여할 역할 목록입니다. 이 목록을 제공하는 경우 역할을 최소 한 개 제공하고 각 역할이 이 프로젝트에 적용되는지 확인합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "roles": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

1개의 프로젝트에 조직 API 키 1개 할당

지정한 조직 API 키를 지정한 프로젝트에 할당합니다. 그런 다음 API 키와 연결된 프로젝트에서 프로젝트 소유자 역할이 있는 사용자는 조직 API 키를 사용하여 리소스에 액세스할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

apiUserId
필수
문자열 = 24자 ^([a-f0-9]{24})$

프로젝트 한 개에서 할당하려는 이 조직 API 키를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 할당할 조직 API 키입니다.

배열
roles
의 배열 strings
항목 열거형: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER" "GROUP_OWNER" "GROUP_READ_ONLY"

이 API 키를 부여할 역할 목록입니다. 이 목록을 제공하는 경우 역할을 최소 한 개 제공하고 각 역할이 이 프로젝트에 적용되는지 확인합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

모든 조직 API 키 반환

지정된 조직에 대한 모든 조직 API 키를 반환합니다. 조직 API 키는 조직에 프로그래밍 방식의 액세스 권한을 부여합니다. API 키를 사용하여 콘솔을 통해 MongoDB Cloud에 로그인할 수 없습니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

프로그래밍 방식 API 키
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 조직 API 키 만들기

지정된 조직에 대해 API 키 한 개를 생성합니다. 조직 API 키는 조직에 프로그래밍 방식의 액세스 권한을 부여합니다. API 키를 사용하여 콘솔에 로그인할 수 없습니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

프로그래밍 방식 API 키
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

생성할 조직 API 키입니다.

desc
필수
문자열 [1 ... 250 ]자

누군가가 이 조직 API 키를 생성했을 때 제공한 목적 또는 설명입니다.

roles
필수
의 배열 strings 비어 있지 않음
항목 열거형: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN"

이 API 키를 부여할 역할 목록입니다. 이 목록을 제공하는 경우 역할을 최소 한 개 제공하고 각 역할이 이 조직에 적용되는지 확인합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "roles": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

1개의 조직 API 키 제거

지정된 조직에서 조직 API 키 한 개를 제거합니다. 조직에서 API 키를 제거하면 MongoDB Cloud는 해당 키를 사용하는 모든 프로젝트에서도 해당 키를 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

Atlas API 액세스 구성
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

apiUserId
필수
문자열 = 24자 ^([a-f0-9]{24})$

이 조직 API 키를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 조직 API 키 반환

조직 API 키 한 개를 반환합니다. 조직 API 키는 조직에 프로그래밍 방식의 액세스 권한을 부여합니다. API 키를 사용하여 사용자 인터페이스를 통해 MongoDB Cloud에 로그인할 수 없습니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

프로그래밍 방식 API 키
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

apiUserId
필수
문자열 = 24자 ^([a-f0-9]{24})$

업데이트하려는 이 조직 API 키를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

1개의 조직 API 키 업데이트

지정된 조직에서 조직 API 키 한 개를 업데이트합니다. 조직 API 키는 조직에 프로그래밍 방식의 액세스 권한을 부여합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

프로그래밍 방식 API 키
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

apiUserId
필수
문자열 = 24자 ^([a-f0-9]{24})$

업데이트하려는 이 조직 API 키를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

업데이트할 조직 API 키입니다. 이 요청에는 본문 매개변수 두 개 중 최소 한 개가 필요합니다.

desc
문자열 [1 ... 250 ]자

누군가가 이 조직 API 키를 생성할 때 제공한 목적 또는 설명입니다.

roles
의 배열 strings
항목 열거형: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY" "ORG_TEAM_MEMBERS_ADMIN"

이 API 키를 부여할 역할 목록입니다. 이 목록을 제공하는 경우 역할을 최소 한 개 제공하고 각 역할이 이 조직에 적용되는지 확인합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "roles": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "desc": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  • "publicKey": "zmmrboas",
  • "roles": [
    ]
}

1개의 조직 API 키에 대해 모든 액세스 목록 항목 반환

지정된 조직 API 키에 대해 구성한 모든 액세스 목록 항목을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

프로그래밍 방식 API 키
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

apiUserId
필수
문자열 = 24자 ^([a-f0-9]{24})$

액세스 목록 항목을 반환하려는 이 조직 API 키를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 조직 API 키에 대해 액세스 목록 항목 만들기

지정된 조직 API 키에 대한 액세스 목록 항목을 생성합니다. 리소스를 사용하려면 모든 API 요청이 API 액세스 목록의 IP 주소에서 시작되어야 합니다. 이 리소스를 사용하려면 요청하는 API 키에 읽기 쓰기 (write) 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

apiUserId
필수
문자열 = 24자 ^([a-f0-9]{24})$

새 액세스 목록 항목을 생성하려는 이 조직 API 키를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 조직 API 키에 대해 생성될 액세스 목록 항목입니다.

배열
cidrBlock
문자열^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a...

API 키에 대한 액세스 목록에 추가하려는 네트워크 주소 범위입니다. 이 매개변수를 사용하려면 범위를 인터넷 프로토콜 버전 4 또는 버전 6 주소의 클래스 없는 도메인 간 라우팅(Classless Inter-Domain Routing, CIDR) 표기법으로 표현해야 합니다. 동일한 요청에서 이 매개변수 또는 ipAddress의 값을 설정할 수 있지만 둘 다 설정할 수는 없습니다.

ipAddress
문자열^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

API 키에 대한 액세스 목록에 추가하려는 네트워크 주소입니다. 이 매개변수를 사용하려면 주소가 하나의 인터넷 프로토콜 버전 4 또는 버전 6 주소로 표현되어야 합니다. 동일한 요청에서 이 매개변수 또는 cidrBlock의 값을 설정할 수 있지만 둘 다 설정할 수는 없습니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 조직 API 키에 대해 1개의 액세스 목록 항목 제거

지정된 조직 API 키에서 지정된 액세스 목록 항목을 제거합니다. 리소스를 사용하려면 모든 API 요청이 API 액세스 목록의 IP 주소에서 시작되어야 합니다. 이 리소스를 사용하려면 요청하는 API 키에 읽기 쓰기 (write) 역할이 있어야 합니다. 또한 요청하는 조직 API 키에서 요청 IP 주소를 제거할 수 없습니다.

Atlas API 액세스 구성
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

apiUserId
필수
문자열 = 24자 ^([a-f0-9]{24})$

액세스 목록 항목을 제거하려는 이 조직 API 키를 식별하는 고유한 24자리 16진수 문자열입니다.

ipAddress
필수
문자열^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
예시: 192.0.2.0%2F24

IP 주소 한 개 또는 여러 개가 CIDR 블록 한 개로 표시되어 지정된 조직의 API 리소스에 대한 요청을 제한합니다. 192.0.2.0/24와 같이 서브넷 마스크가 있는 CIDR 블록을 추가할 때는 슬래시 /에 URL 인코딩 값 %2F를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 조직 API 키에 대해 1개의 액세스 목록 항목 반환

지정된 조직 API 키에 대한 액세스 목록 항목 한 개를 반환합니다. 리소스를 사용하려면 모든 API 요청이 API 액세스 목록의 IP 주소에서 시작되어야 합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

Atlas API 액세스 구성
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

ipAddress
필수
문자열^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
예시: 192.0.2.0%2F24

IP 주소 한 개 또는 여러 개가 CIDR 블록 한 개로 표시되어 지정된 조직의 API 리소스에 대한 요청을 제한합니다. 192.0.2.0/24와 같이 서브넷 마스크가 있는 CIDR 블록을 추가할 때는 슬래시 /에 URL 인코딩 값 %2F를 사용합니다.

apiUserId
필수
문자열 = 24자 ^([a-f0-9]{24})$

액세스 목록 항목을 반환하려는 이 조직 API 키를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "cidrBlock": "203.0.113.0/24",
  • "count": 1,
  • "created": "2019-08-24T14:15:22Z",
  • "ipAddress": "203.0.113.10",
  • "lastUsed": "2019-08-24T14:15:22Z",
  • "lastUsedAddress": "203.0.113.10",
  • "links": []
}

프로젝트 IP 액세스 목록

Atlas의 데이터베이스 배포에 대한 네트워크 액세스 제한 사항을 반환, 추가, 편집 및 제거합니다. 이 리소스는 화이트리스트 리소스를 대체합니다. Atlas는 2021년 7월에 화이트리스트를 제거했습니다. 이 새 리소스를 사용하려면 애플리케이션을 업데이트합니다. 이 리소스는 프로젝트의 IP 액세스 목록을 관리하고 사용자가 구성할 수 있는 7일 기간 내에 자동으로 만료되는 임시 액세스 목록 항목 생성을 지원합니다.

프로젝트 IP 액세스 목록 반환

지정된 프로젝트의 IP 액세스 목록에서 모든 액세스 목록 항목을 반환합니다. 프로젝트 IP 액세스 목록의 각 항목에는 IP 주소 한 개 또는 CIDR로 표기된 IP 주소 블록 한 개가 포함됩니다. MongoDB Cloud는 프로젝트의 IP 액세스 목록에 있는 항목에서만 cluster에 대한 클라이언트 연결을 허용합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 읽기 전용 또는 프로젝트 차트 관리자 역할이 있어야 합니다. 이 리소스는 화이트리스트 리소스를 대체합니다. MongoDB Cloud는 2021년 7월에 화이트리스트를 제거했습니다. 이 새 리소스를 사용하려면 애플리케이션을 업데이트합니다. /groups/{GROUP-ID}/accessList 엔드포인트는 데이터베이스 IP 액세스 목록을 관리합니다. 이 엔드포인트는 MongoDB Cloud 조직의 액세스 목록을 관리하는 orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist 엔드포인트와는 다릅니다.

IP 액세스 목록
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

프로젝트 IP 액세스 목록에 항목 추가

지정된 프로젝트에 액세스 목록 항목을 한 개 이상 추가합니다. MongoDB Cloud는 프로젝트의 IP 액세스 목록에 있는 항목에서만 cluster에 대한 클라이언트 연결을 허용합니다. 각 항목을 IP 주소 한 개 또는 CIDR 표기 IP 주소 블록 한 개로 작성합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 소유자 또는 프로젝트 차트 관리자 역할이 있어야 합니다. 이 리소스는 화이트리스트 리소스를 대체합니다. MongoDB Cloud는 2021년 7월에 화이트리스트를 제거했습니다. 이 새 리소스를 사용하려면 애플리케이션을 업데이트합니다. /groups/{GROUP-ID}/accessList 엔드포인트는 데이터베이스 IP 액세스 목록을 관리합니다. 이 엔드포인트는 MongoDB Cloud 조직의 액세스 목록을 관리하는 orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist 엔드포인트와는 다릅니다. 이 엔드포인트는 동시 POST 요청을 지원하지 않습니다. 여러 POST 요청을 동시에 제출해야 합니다.

IP 액세스 목록
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 추가할 한 개 이상의 액세스 목록 항목입니다.

배열
awsSecurityGroup
문자열^([0-9]*/)?sg-([0-9]*)

프로젝트의 IP 액세스 목록에 추가하려는 Amazon Web Services(AWS) 보안 그룹의 고유 문자열입니다. IP 액세스 목록 항목은 awsSecurityGroup 한 개, cidrBlock 한 개 또는 ipAddress 한 개일 수 있습니다. AWS 보안 그룹을 IP 액세스 목록에 추가하려면 먼저 프로젝트에 가상 비공개 연결(Virtual Private Connection, VPC) 피어링을 구성해야 합니다. AWS 보안 그룹을 임시 액세스 목록 항목으로 설정할 수 없습니다. cidrBlock 또는 ipAddress를 설정한 경우에는 이 매개변수를 설정하지 마세요.

cidrBlock
문자열^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...

프로젝트의 IP 액세스 목록에 추가하려는 클래스 없는 도메인 간 라우팅(Classless Inter-Domain Routing, CIDR) 표기법의 IP 주소 범위입니다. IP 액세스 목록 항목은 awsSecurityGroup 한 개, cidrBlock 한 개 또는 ipAddress 한 개일 수 있습니다. awsSecurityGroup 또는 ipAddress를 설정하는 경우 이 매개변수를 설정하지 마세요.

comment
문자열 <= 80자

이 IP 액세스 목록 항목의 목적이나 범위를 설명하는 비고입니다.

deleteAfterDate
문자열 <date-time>

MongoDB Cloud가 임시 액세스 목록 항목을 삭제하는 날짜 및 시간입니다. 이 매개변수는 값을 ISO 8601 타임스탬프 형식으로 UTC로 표현하며 시간대 지정을 포함할 수 있습니다. 날짜는 현재 날짜 이후여야 하며 이 요청을 제출한 후 1주일 이내여야 합니다. 이 IP 액세스 목록 항목을 생성할 때 만료 날짜를 지정한 경우 리소스는 이 매개변수를 반환합니다.

ipAddress
문자열^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

프로젝트의 IP 액세스 목록에 추가하려는 IP 주소입니다. IP 액세스 목록 항목은 awsSecurityGroup 한 개, cidrBlock 한 개 또는 ipAddress 한 개일 수 있습니다. awsSecurityGroup 또는 cidrBlock을 설정한 경우에는 이 매개변수를 설정하지 마세요.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 프로젝트 IP 액세스 목록에서 1개의 항목 제거

지정된 프로젝트의 IP 액세스 목록에서 액세스 목록 항목 한 개를 제거합니다. 프로젝트의 IP 액세스 목록에 있는 각 항목에는 IP 주소 한 개, CIDR로 표기된 IP 주소 블록 한 개 또는 AWS 보안 그룹 ID 한 개가 포함됩니다. MongoDB Cloud는 프로젝트의 IP 액세스 목록에 있는 항목에서만 cluster에 대한 클라이언트 연결을 허용합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 이 리소스는 화이트리스트 리소스를 대체합니다. MongoDB Cloud는 2021년 7월에 화이트리스트를 제거했습니다. 이 새 리소스를 사용하려면 애플리케이션을 업데이트합니다. /groups/{GROUP-ID}/accessList 엔드포인트는 데이터베이스 IP 액세스 목록을 관리합니다. 이 엔드포인트는 MongoDB Cloud 조직의 액세스 목록을 관리하는 orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist 엔드포인트와는 다릅니다.

IP 액세스 목록
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

entryValue
필수
문자열^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
예시: IPv4: 192.0.2.0%2F24 또는 IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 또는 IPv4 CIDR: 198.51.100.0%2f24 또는 IPv6 CIDR: 2001:db8::%2f58 또는 AWS SG: sg-903004f8

프로젝트의 IP 액세스 목록에서 제거하려는 액세스 목록 항목입니다. 이 값은 AWS 보안 그룹 ID 한 개, IP 주소 한 개 또는 CIDR 주소 블록 한 개 중 하나를 사용할 수 있습니다. 서브넷 마스크를 사용하는 CIDR 블록의 경우 슬래시(/)를 URL 인코딩 값(%2F)으로 바꿉니다. IP 액세스 목록에서 엔트리를 제거하면 제거된 주소의 기존 연결이 다양한 시간 동안 열려 있을 수 있습니다. MongoDB Cloud가 연결을 종료하는 데 걸리는 시간은 다음을 비롯한 여러 요인에 따라 달라집니다.

  • 애플리케이션의 연결 설정 방법
  • 주소를 사용하는 MongoDB Cloud 또는 드라이버가 어떻게 작동하는지, 그리고
  • 연결에서 사용하는 프로토콜(예: TCP 또는 UDP)
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 프로젝트 IP 액세스 목록 항목 반환

지정된 프로젝트의 IP 액세스 목록에서 액세스 목록 항목 한 개를 반환합니다. 프로젝트 IP 액세스 목록의 각 항목에는 IP 주소 한 개 또는 CIDR로 표기된 IP 주소 블록 한 개가 포함됩니다. MongoDB Cloud는 프로젝트의 IP 액세스 목록에 있는 항목에서만 cluster에 대한 클라이언트 연결을 허용합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 읽기 전용 또는 프로젝트 차트 관리자 역할이 있어야 합니다. 이 리소스는 화이트리스트 리소스를 대체합니다. MongoDB Cloud는 2021년 7월에 화이트리스트를 제거했습니다. 이 새 리소스를 사용하려면 애플리케이션을 업데이트합니다. 이 엔드포인트(/groups/{GROUP-ID}/accessList)는 프로젝트 IP 액세스 목록을 관리합니다. MongoDB Cloud 조직의 액세스 목록은 관리하지 않습니다. 프로그래밍 방식 API 키 엔드포인트(/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist)는 이러한 액세스 목록을 관리합니다.

IP 액세스 목록
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

entryValue
필수
문자열^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
예시: IPv4: 192.0.2.0%2F24 또는 IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 또는 IPv4 CIDR: 198.51.100.0%2f24 또는 IPv6 CIDR: 2001:db8::%2f58 또는 AWS SG: sg-903004f8

프로젝트의 IP 액세스 목록에서 반환하려는 액세스 목록 항목입니다. 이 값은 AWS 보안 그룹 ID 한 개, IP 주소 한 개 또는 CIDR 주소 블록 한 개 중 하나를 사용할 수 있습니다. 서브넷 마스크를 사용하는 CIDR 블록의 경우 슬래시(/)를 URL 인코딩 값(%2F)으로 바꿉니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "awsSecurityGroup": "string",
  • "cidrBlock": "string",
  • "comment": "string",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "ipAddress": "string",
  • "links": []
}

1개의 프로젝트 IP 액세스 목록 항목 상태 반환

프로젝트 IP 액세스 목록 항목 한 개의 상태를 반환합니다. 이 리소스는 제공된 프로젝트 IP 액세스 목록 항목이 지정된 프로젝트의 cluster를 제공하는 모든 cloud 제공자에 적용되는지 확인합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

entryValue
필수
문자열^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
예시: IPv4: 192.0.2.0%2F24 또는 IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 또는 IPv4 CIDR: 198.51.100.0%2f24 또는 IPv6 CIDR: 2001:db8::%2f58 또는 AWS SG: sg-903004f8

확인할 프로젝트 액세스 목록 항목을 식별하는 네트워크 주소 또는 cloud 제공자 보안 구성입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "STATUS": "PENDING"
}

프로젝트

MongoDB Cloud에서 cluster 및 사용자 컬렉션을 반환, 추가 및 편집합니다.

모든 프로젝트 반환

모든 프로젝트에 대한 세부 정보를 반환합니다. 프로젝트는 클러스터를 애플리케이션 환경, 워크로드 또는 둘 다를 지원하는 논리적 컬렉션으로 그룹화합니다. 각 프로젝트에는 고유한 사용자, 팀, 보안, 태그, 경고 설정을 둘 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 읽기 쓰기 역할이 있어야 합니다.

권한 부여
DigestAuth
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

프로젝트 1개 만들기

프로젝트 한 개를 생성합니다. 프로젝트는 클러스터를 애플리케이션 환경, 워크로드 또는 둘 다를 지원하는 논리적 컬렉션으로 그룹화합니다. 각 프로젝트에는 고유한 사용자, 팀, 보안, 태그, 경고 설정을 둘 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 읽기 쓰기 역할이 있어야 합니다.

권한 부여
DigestAuth
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

projectOwnerId
문자열 = 24자 ^([a-f0-9]{24})$

지정된 프로젝트에서 프로젝트 소유자 역할을 부여할 MongoDB Cloud 사용자를 식별하는 고유한 24자리 16진수 문자열입니다. 이 매개변수를 설정하면 가장 오래된 조직 소유자의 기본값이 재정의됩니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

프로젝트 한 개를 생성합니다.

이름
필수
문자열 [ 1 ... 64 ] 문자 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

MongoDB Cloud 조직에 포함된 프로젝트를 식별하는 사람이 읽을 수 있는 레이블입니다.

orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$

프로젝트가 속한 MongoDB Cloud 조직을 식별하는 고유한 24자리 16진수 문자열입니다.

regionUsageRestrictions
문자열
기본값입니다: "COMMERCIAL_FEDRAMP_REGIONS_ONLY"
열거형: "COMMERCIAL_FEDRAMP_REGIONS_ONLY" "GOV_REGIONS_ONLY"

Atlas for Government에만 적용됩니다.

Commercial Atlas에서는 이 필드가 요청 시 거부되고 응답 시 누락됩니다.

이 필드는 프로젝트에서 사용 가능한 리전에 대한 제한을 설정합니다.

값 사용 가능한 리전
COMMERCIAL_FEDRAMP_REGIONS_ONLY FedRAMP 보통 리전에서만 배포할 수 있습니다.
GOV_REGIONS_ONLY GovCloud 리전에서만 배포할 수 있습니다.
https://www.mongodb.com/ko-kr/docs/atlas/govenment/overview/supported-regions/#supported-cloud-providers-and-regions
의 배열 개체 (Resource Tag)

프로젝트에 태그를 지정하고 분류하기 위한 1~255자 길이의 키-값 쌍이 포함된 목록입니다.

리소스 태그
withDefaultAlertsSettings
부울

기본값 경고 설정으로 프로젝트를 생성할지 여부를 나타내는 플래그입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ],
  • "withDefaultAlertsSettings": true
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

이름을 사용하여 1개의 프로젝트 반환

지정된 프로젝트에 대한 세부 정보를 반환합니다. 프로젝트는 클러스터를 애플리케이션 환경, 워크로드 또는 둘 다를 지원하는 논리적 컬렉션으로 그룹화합니다. 각 프로젝트에는 고유한 사용자, 팀, 보안, 태그, 경고 설정을 둘 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupName
필수
문자열 [ 1 ... 64 ] 문자

이 프로젝트를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

1개의 프로젝트 제거

지정된 프로젝트를 제거합니다. 프로젝트는 클러스터를 애플리케이션 환경, 워크로드 또는 둘 다를 지원하는 논리적 컬렉션으로 그룹화합니다. 각 프로젝트에는 고유한 사용자, 팀, 보안, 태그, 경고 설정을 둘 수 있습니다. 프로젝트에 cluster에 대한 온라인 아카이브가 없는 경우에만 프로젝트를 삭제할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 프로젝트 반환

지정된 프로젝트에 대한 세부 정보를 반환합니다. 프로젝트는 클러스터를 애플리케이션 환경, 워크로드 또는 둘 다를 지원하는 논리적 컬렉션으로 그룹화합니다. 각 프로젝트에는 고유한 사용자, 팀, 보안, 태그, 경고 설정을 둘 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

1개의 프로젝트 업데이트

지정된 프로젝트를 식별하는 사람이 읽을 수 있는 레이블 또는 프로젝트와 연결된 태그를 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

업데이트할 프로젝트입니다.

이름
문자열

MongoDB Cloud 조직에 포함된 프로젝트를 식별하는 사람이 읽을 수 있는 레이블입니다.

의 배열 개체 (Resource Tag)

프로젝트에 태그를 지정하고 분류하기 위한 1~255자 길이의 키-값 쌍이 포함된 목록입니다.

리소스 태그

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "name": "string",
  • "tags": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterCount": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "name": "string",
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
  • "tags": [
    ]
}

1개의 프로젝트에 1명의 MongoDB 클라우드 사용자 추가

지정된 프로젝트에 MongoDB Cloud 사용자 한 명을 추가합니다. MongoDB Cloud 사용자가 프로젝트 조직의 구성원이 아닌 경우, 지정된 프로젝트 내의 정보에 액세스하려면 사용자가 조직 초대를 수락해야 합니다. MongoDB 클라우드 사용자가 이미 프로젝트 조직의 구성원인 경우, 해당 사용자는 즉시 프로젝트에 추가되며 이 리소스에서 초대를 반환하지 않습니다. 이 리소스를 사용하려면 요청하는 API 키에 그룹 사용자 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-02-01+json

지정된 프로젝트에 MongoDB Cloud 사용자 한 명을 추가합니다.

roles
의 배열 strings unique
항목 열거형: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

MongoDB Cloud 사용자에게 할당할 한 개 이상의 프로젝트 수준 역할입니다.

사용자 이름
문자열 <email>

지정된 프로젝트에 초대된 MongoDB Cloud 사용자의 이메일 주소입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupRoleAssignments": [
    ],
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "orgId": "32b6e34b3d91647abb20e7b8",
  • "orgName": "string",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

모든 프로젝트 초대 반환 더 이상 사용되지 않음

지정된 프로젝트에 대기 중인 모든 초대를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

사용자 이름
문자열 <email>

이 프로젝트에 초대된 사용자 계정의 이메일 주소입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

프로젝트 초대 한 개 업데이트가 더 이상 사용되지 않음

지정된 프로젝트에 대기 중인 초대 한 개의 세부 정보를 업데이트합니다. 업데이트할 초대를 지정하려면 초대된 사용자의 사용자 이름을 제공합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 대기 중인 초대 한 개의 세부 정보를 업데이트합니다.

roles
의 배열 strings unique
항목 열거형: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

MongoDB Cloud 사용자에게 할당할 한 개 이상의 프로젝트 수준 역할입니다.

사용자 이름
문자열 <email>

지정된 프로젝트에 초대된 MongoDB Cloud 사용자의 이메일 주소입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

MongoDB Cloud 사용자 한 명을 프로젝트 한 개에 조인하도록 초대하기가 더 이상 사용되지 않음

지정된 프로젝트에 조인하도록 MongoDB Cloud 사용자 한 명을 초대합니다. MongoDB Cloud 사용자는 지정된 프로젝트 내의 정보에 액세스하려면 초대를 수락해야 합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 조인하도록 MongoDB Cloud 사용자 한 명을 초대합니다.

roles
의 배열 strings unique
항목 열거형: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

MongoDB Cloud 사용자에게 할당할 한 개 이상의 프로젝트 수준 역할입니다.

사용자 이름
문자열 <email>

지정된 프로젝트에 초대된 MongoDB Cloud 사용자의 이메일 주소입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

프로젝트 초대 한 개 취소 더 이상 사용되지 않음

프로젝트에 조인하도록 지정된 MongoDB Cloud 사용자에게 보낸 대기 중인 초대 한 개를 취소합니다. 사용자가 수락한 초대는 취소할 수 없습니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

invitationId
필수
문자열 = 24자 ^([a-f0-9]{24})$

초대를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

프로젝트 초대 한 개 반환 더 이상 사용되지 않음

지정된 프로젝트에 대기 중인 초대 한 개의 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

invitationId
필수
문자열 = 24자 ^([a-f0-9]{24})$

초대를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

초대 ID로 프로젝트 초대 한 개 업데이트가 더 이상 사용되지 않음

지정된 프로젝트에 대기 중인 초대 한 개의 세부 정보를 업데이트합니다. 업데이트할 초대를 지정하려면 해당 초대에 대한 고유 ID 문자열을 제공합니다. 모든 프로젝트 초대 반환 엔드포인트를 사용하여 대기 중인 모든 프로젝트 초대의 ID를 조회합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

invitationId
필수
문자열 = 24자 ^([a-f0-9]{24})$

초대를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 대기 중인 초대 한 개의 세부 정보를 업데이트합니다.

roles
의 배열 strings unique
항목 열거형: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

MongoDB Cloud 사용자에게 할당할 한 개 이상의 조직 또는 프로젝트 수준 역할입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "roles": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "groupName": "string",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "inviterUsername": "user@example.com",
  • "links": [],
  • "roles": [
    ],
  • "username": "user@example.com"
}

1개의 프로젝트에 대해 모든 IP 주소 반환

이 프로젝트의 모든 IP 주소를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "services": {
    }
}

1개의 프로젝트의 모든 제한 반환

지정된 프로젝트의 모든 제한 사항을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1개의 프로젝트 제한 제거

지정된 프로젝트 제한을 제거합니다. 제한에 따라 Atlas는 제한을 기본값으로 재설정하거나 제한을 완전히 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
limitName
필수
문자열
열거형: "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.deployment.serverlessMTMs" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion" "dataFederation.bytesProcessed.query" "dataFederation.bytesProcessed.daily" "dataFederation.bytesProcessed.weekly" "dataFederation.bytesProcessed.monthly" "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" "atlas.project.deployment.privateServiceConnectionsSubnetMask"

이 프로젝트 제한을 식별하는 사람이 읽을 수 있는 레이블입니다.

제한 이름 설명 기본값 API 재정의 제한
atlas.project.deployment.clusters 이 프로젝트의 cluster 수 제한 25 90
atlas.project.deployment.nodesPerPrivateLinkRegion 이 프로젝트의 Private Link 리전당 노드 수 제한 50 90
atlas.project.security.databaseAccess.customRoles 이 프로젝트의 사용자 지정 역할 수 제한 100 1400
atlas.project.security.databaseAccess.users 이 프로젝트의 데이터베이스 사용자 수 제한 100 900
atlas.project.security.networkAccess.crossRegionEntries 이 프로젝트의 리전 간 네트워크 액세스 항목 수 제한 40 220
atlas.project.security.networkAccess.entries 이 프로젝트의 네트워크 액세스 항목 수 제한 200 20
dataFederation.bytesProcessed.query 단일 Data Federation 쿼리 중 처리되는 바이트 수 제한 N/A N/A
dataFederation.bytesProcessed.daily 현재 날짜의 모든 Data Federation 테넌트에서 처리되는 바이트 수 제한 N/A N/A
dataFederation.bytesProcessed.weekly 이번 주의 모든 Data Federation 테넌트에서 처리되는 바이트 수 제한 N/A N/A
dataFederation.bytesProcessed.monthly 이번 달의 모든 Data Federation 테넌트에서 처리되는 바이트 수 제한 N/A N/A
atlas.project.deployment.privateServiceConnectionsPerRegionGroup 리전 그룹당 비공개 서비스 연결 수 50 100
atlas.project.deployment.privateServiceConnectionsSubnetMask GCP PSC 네트워크용 서브넷 마스크입니다. 하한은 20입니다. 27 27
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 프로젝트에 1개의 제한 반환

지정된 프로젝트의 지정된 제한 사항을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
limitName
필수
문자열
열거형: "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.deployment.serverlessMTMs" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion" "dataFederation.bytesProcessed.query" "dataFederation.bytesProcessed.daily" "dataFederation.bytesProcessed.weekly" "dataFederation.bytesProcessed.monthly" "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" "atlas.project.deployment.privateServiceConnectionsSubnetMask"

이 프로젝트 제한을 식별하는 사람이 읽을 수 있는 레이블입니다.

제한 이름 설명 기본값 API 재정의 제한
atlas.project.deployment.clusters 이 프로젝트의 cluster 수 제한 25 90
atlas.project.deployment.nodesPerPrivateLinkRegion 이 프로젝트의 Private Link 리전당 노드 수 제한 50 90
atlas.project.security.databaseAccess.customRoles 이 프로젝트의 사용자 지정 역할 수 제한 100 1400
atlas.project.security.databaseAccess.users 이 프로젝트의 데이터베이스 사용자 수 제한 100 900
atlas.project.security.networkAccess.crossRegionEntries 이 프로젝트의 리전 간 네트워크 액세스 항목 수 제한 40 220
atlas.project.security.networkAccess.entries 이 프로젝트의 네트워크 액세스 항목 수 제한 200 20
dataFederation.bytesProcessed.query 단일 Data Federation 쿼리 중 처리되는 바이트 수 제한 N/A N/A
dataFederation.bytesProcessed.daily 현재 날짜의 모든 Data Federation 테넌트에서 처리되는 바이트 수 제한 N/A N/A
dataFederation.bytesProcessed.weekly 이번 주의 모든 Data Federation 테넌트에서 처리되는 바이트 수 제한 N/A N/A
dataFederation.bytesProcessed.monthly 이번 달의 모든 Data Federation 테넌트에서 처리되는 바이트 수 제한 N/A N/A
atlas.project.deployment.privateServiceConnectionsPerRegionGroup 리전 그룹당 비공개 서비스 연결 수 50 100
atlas.project.deployment.privateServiceConnectionsSubnetMask GCP PSC 네트워크용 서브넷 마스크입니다. 하한은 20입니다. 27 27
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "maximumLimit": 0,
  • "name": "atlas.project.deployment.clusters",
  • "value": 0
}

1개의 프로젝트 제한 설정

지정된 프로젝트 제한을 설정합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

참고: 다음 구성 제한 사항을 늘리면 MongoDB Cloud UI의 응답 시간이 느려지거나 사용자 관리 오버헤드가 증가하여 인증 또는 권한 부여 아키텍처가 재설계될 수 있습니다. 가능하면 프로젝트를 추가로 생성해 더 많은 리소스에 액세스하여 더 지속 가능한 성장 패턴을 만드는 것이 좋습니다.

권한 부여
DigestAuth
경로 매개변수
limitName
필수
문자열
열거형: "atlas.project.security.databaseAccess.users" "atlas.project.deployment.clusters" "atlas.project.deployment.serverlessMTMs" "atlas.project.security.databaseAccess.customRoles" "atlas.project.security.networkAccess.entries" "atlas.project.security.networkAccess.crossRegionEntries" "atlas.project.deployment.nodesPerPrivateLinkRegion" "dataFederation.bytesProcessed.query" "dataFederation.bytesProcessed.daily" "dataFederation.bytesProcessed.weekly" "dataFederation.bytesProcessed.monthly" "atlas.project.deployment.privateServiceConnectionsPerRegionGroup" "atlas.project.deployment.privateServiceConnectionsSubnetMask"

이 프로젝트 제한을 식별하는 사람이 읽을 수 있는 레이블입니다.

제한 이름 설명 기본값 API 재정의 제한
atlas.project.deployment.clusters 이 프로젝트의 cluster 수 제한 25 90
atlas.project.deployment.nodesPerPrivateLinkRegion 이 프로젝트의 Private Link 리전당 노드 수 제한 50 90
atlas.project.security.databaseAccess.customRoles 이 프로젝트의 사용자 지정 역할 수 제한 100 1400
atlas.project.security.databaseAccess.users 이 프로젝트의 데이터베이스 사용자 수 제한 100 900
atlas.project.security.networkAccess.crossRegionEntries 이 프로젝트의 리전 간 네트워크 액세스 항목 수 제한 40 220
atlas.project.security.networkAccess.entries 이 프로젝트의 네트워크 액세스 항목 수 제한 200 20
dataFederation.bytesProcessed.query 단일 Data Federation 쿼리 중 처리되는 바이트 수 제한 N/A N/A
dataFederation.bytesProcessed.daily 현재 날짜의 모든 Data Federation 테넌트에서 처리되는 바이트 수 제한 N/A N/A
dataFederation.bytesProcessed.weekly 이번 주의 모든 Data Federation 테넌트에서 처리되는 바이트 수 제한 N/A N/A
dataFederation.bytesProcessed.monthly 이번 달의 모든 Data Federation 테넌트에서 처리되는 바이트 수 제한 N/A N/A
atlas.project.deployment.privateServiceConnectionsPerRegionGroup 리전 그룹당 비공개 서비스 연결 수 50 100
atlas.project.deployment.privateServiceConnectionsSubnetMask GCP PSC 네트워크용 서브넷 마스크입니다. 하한은 20입니다. 27 27
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

업데이트를 제한합니다.

value
필수
integer <int64>

한도의 크기.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "value": 0,
  • "name": "atlas.project.deployment.clusters"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "currentUsage": 0,
  • "defaultLimit": 0,
  • "maximumLimit": 0,
  • "name": "atlas.project.deployment.clusters",
  • "value": 0
}

1개의 프로젝트 설정 반환

지정된 프로젝트의 설정에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

1개의 프로젝트 설정 업데이트

지정된 프로젝트의 설정을 업데이트합니다. 사용 가능한 모든 옵션을 업데이트할 수 있습니다. MongoDB cloud는 요청에 제공된 옵션만 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

업데이트할 설정입니다.

isCollectDatabaseSpecificsStatisticsEnabled
부울

지정된 프로젝트의 데이터베이스별 지표를 수집할지 여부를 나타내는 플래그입니다.

isDataExplorerEnabled
부울

지정된 프로젝트의 데이터 탐색기를 활성화할지 여부를 나타내는 플래그입니다.

isExtendedStorageSizesEnabled
부울

지정된 프로젝트의 확장 저장소 크기를 활성화할지 여부를 나타내는 플래그입니다.

isPerformanceAdvisorEnabled
부울

지정된 프로젝트의 Performance Advisor 및 Profiler를 활성화할지 여부를 나타내는 플래그입니다.

isRealtimePerformancePanelEnabled
부울

지정된 프로젝트의 실시간 성능 패널을 활성화할지 여부를 나타내는 플래그입니다.

isSchemaAdvisorEnabled
부울

지정된 프로젝트의 스키마 관리자를 활성화할지 여부를 나타내는 플래그입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isExtendedStorageSizesEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

1개의 프로젝트에서 모든 사용자 반환

지정된 프로젝트의 모든 사용자에 대한 세부 정보를 반환합니다. 사용자는 조직에 속합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

flattenTeams
부울
기본값입니다: 거짓

반환된 목록에 이 프로젝트에서 역할이 있는 팀에 속한 사용자를 포함할지 여부를 나타내는 플래그입니다. 이 프로젝트에서는 개별 사용자에게 역할을 할당하지 않았을 수 있습니다. "flattenTeams" : false인 경우 이 리소스는 프로젝트에서 역할이 있는 사용자만 반환합니다. "flattenTeams" : true인 경우 이 리소스는 프로젝트에서 역할이 있는 사용자와 프로젝트에서 역할이 있는 팀에 속한 사용자를 모두 반환합니다.

includeOrgUsers
부울
기본값입니다: 거짓

반환된 목록에 프로젝트에 대한 암시적 액세스 권한이 있는 사용자, 조직 소유자 또는 조직 읽기 전용 역할이 있는 사용자를 포함할지 여부를 나타내는 플래그입니다. 이 프로젝트에서는 개별 사용자에게 역할을 할당하지 않았을 수 있습니다. "includeOrgUsers": false인 경우 이 리소스는 프로젝트에서 역할이 있는 사용자만 반환합니다. "includeOrgUsers": true인 경우 이 리소스는 프로젝트에서 역할이 있는 사용자와 조직 역할을 통해 프로젝트에 암시적으로 액세스할 수 있는 사용자를 모두 반환합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 프로젝트에서 사용자 1명 제거

지정된 프로젝트에서 지정된 사용자를 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

userId
필수
문자열 = 24자 ^([a-f0-9]{24})$

지정된 프로젝트에서 제거하려는 MongoDB Cloud 사용자를 식별하는 고유한 24자리 16진수 문자열입니다. 애플리케이션 사용자 이름을 사용하여 애플리케이션 사용자의 ID를 반환하려면 Get All application users in One Project 엔드포인트를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1명의 MongoDB 클라우드 사용자에 대해 프로젝트 역할 업데이트

지정된 프로젝트에서 지정된 사용자의 역할을 업데이트합니다. 업데이트할 사용자를 지정하려면 지정된 프로젝트의 사용자를 식별하는 고유한 24자리 16진수 문자열을 제공합니다. 이 리소스를 사용하려면 요청하는 API 키에 그룹 사용자 관리자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

userId
필수
문자열 = 24자 ^([a-f0-9]{24})$

수정할 사용자를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 사용자에 대해 업데이트할 역할입니다.

groupRoles
의 배열 strings unique
항목 열거형: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_STREAM_PROCESSING_OWNER"

MongoDB Cloud 사용자에게 할당할 한 개 이상의 프로젝트 수준 역할입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "groupRoles": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

푸시 기반 로그 내보내기

mongod, mongos 및 감사 로그의 로그를 AWS S3 버킷으로 지속적으로 푸시할 수 있습니다. Atlas는 5 분마다 로그를 내보냅니다.

프로젝트의 푸시 기반 로그 내보내기 기능 비활성화

프로젝트 수준 설정을 기본값 구성으로 재설정하여 푸시 기반 로그 내보내기 기능을 비활성화합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

프로젝트에 대해 푸시 기반 로그 내보내기 구성 가져오기

푸시 기반 로그 내보내기 기능의 현재 프로젝트 수준 설정을 가져옵니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "bucketName": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "iamRoleId": "string",
  • "links": [],
  • "prefixPath": "string",
  • "state": "UNCONFIGURED"
}

프로젝트의 푸시 기반 로그 내보내기 기능 업데이트

푸시 기반 로그 내보내기 기능에 대한 프로젝트 수준 설정을 업데이트합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

프로젝트 구성 세부 정보입니다. S3 버킷 이름, IAM 역할 ID 및 접두사 경로 필드는 지정할 수 있는 유일한 필드입니다. 지정하지 않은 필드는 수정되지 않습니다.

bucketName
문자열

에이전트가 로그를 보낼 버킷의 이름입니다.

iamRoleId
문자열

S3 버킷에 쓰는 데 사용될 AWS IAM 역할의 ID입니다.

prefixPath
문자열

S3 로그를 저장하기 위해 벡터가 쓸 디렉토리입니다. 빈 문자열은 루트 디렉토리를 나타냅니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "bucketName": "string",
  • "iamRoleId": "string",
  • "prefixPath": "string"
}

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

프로젝트에 대해 푸시 기반 로그 내보내기 기능 활성화

푸시 기반 로그 내보내기 기능에 대한 프로젝트 수준 설정을 구성합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

프로젝트 구성 세부 정보입니다. S3 버킷 이름, IAM 역할 ID 및 접두사 경로 필드는 필수입니다.

bucketName
필수
문자열

에이전트가 로그를 보낼 버킷의 이름입니다.

iamRoleId
필수
문자열

S3 버킷에 쓰는 데 사용될 AWS IAM 역할의 ID입니다.

prefixPath
필수
문자열

S3 로그를 저장하기 위해 벡터가 쓸 디렉토리입니다. 빈 문자열은 루트 디렉토리를 나타냅니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "bucketName": "string",
  • "iamRoleId": "string",
  • "prefixPath": "string"
}

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

롤링 인덱스

롤링 방식으로 데이터베이스 배포에 인덱스 한 개를 생성합니다. M0 무료 cluster 또는 M2/M5 공유 클러스터에서는 롤링 인덱스를 생성할 수 없습니다.

1개의 롤링 인덱스 만들기

롤링 방식으로 이름으로 식별되는 cluster에 인덱스를 생성합니다. 이러한 방식으로 인덱스를 생성하면 세컨더리 멤버부터 시작하여 한 번에 복제본 세트 멤버 한 개에 대해 독립형으로 인덱스를 빌드할 수 있습니다. 이 방식으로 인덱스를 생성하려면 적어도 한 번의 복제본 세트 투표가 필요합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 데이터 액세스 관리자 역할이 있어야 합니다.

복제본 세트에 대한 롤링 인덱스 빌드
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

MongoDB Cloud가 인덱스를 생성하는 cluster를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 cluster에 생성할 롤링 인덱스입니다.

객체 (데이터 정렬)

이 인덱스 내에서 문자열을 비교하기 위한 언어별 규칙을 지정하는 하나 이상의 설정입니다.

데이터 정렬 옵션
컬렉션
필수
문자열

MongoDB Cloud가 인덱스를 생성하는 컬렉션의 사람이 읽을 수 있는 레이블입니다.

db
필수
문자열

MongoDB Cloud가 인덱스를 생성하는 컬렉션을 보유하는 데이터베이스의 사람이 읽을 수 있는 레이블입니다.

의 배열 개체[ 항목 = 속성 한 개 ]

인덱싱하려는 매개변수를 설명하는 객체가 한 개 이상 포함된 목록입니다.

객체 (IndexOptions)

MongoDB Cloud가 이 MongoDB 인덱스를 생성하는 방법을 결정하는 하나 이상의 설정입니다.

인덱스 옵션

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제

2dpere 인덱스

{
  • "collation": {
    },
  • "collection": "accounts",
  • "db": "sample_airbnb",
  • "keys": [
    ],
  • "options": {
    }
}

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

루트

MongoDB Cloud 빌드와 이 리소스를 요청하는 액세스 토큰을 설명하는 세부 정보를 반환합니다. 그러면 MongoDB Cloud API가 시작됩니다.

이 MongoDB 애플리케이션의 상태 반환

이 리소스는 API 키 메타 데이터와 함께 MongoDB 애플리케이션에 대한 정보를 반환합니다.

권한 부여
DigestAuth
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "apiKey": {
    },
  • "appName": "MongoDB Atlas",
  • "build": "83be55e140f493c88e7f578aae96548dd881587b",
  • "links": [],
  • "throttling": true
}

모든 제어 영역 IP 주소 반환

모든 제어 영역 IP 주소를 반환합니다.

권한 부여
none
쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-11-15+json
{
  • "inbound": {
    },
  • "outbound": {
    }
}

Serverless Instances

서버리스 인스턴스를 반환, 추가, 편집, 제거합니다.

1개의 프로젝트에서 모든 서버리스 인스턴스 반환

지정된 프로젝트의 모든 서버리스 인스턴스에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 프로젝트에 1개의 서버리스 인스턴스 생성

지정된 프로젝트에 서버리스 인스턴스 한 개를 생성합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

프로젝트 한 개에 서버리스 인스턴스 한 개를 생성합니다.

이름
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

필수
객체 (서버리스 인스턴스에 대한 클라우드 서비스 공급자 설정)

프로비저닝된 MongoDB 서버리스 인스턴스를 구성하는 클라우드 공급자 설정 그룹.

객체 (서버리스 백업 옵션)

서버리스 백업을 구성하는 설정 그룹.

의 배열 개체 (Resource Tag)

서버리스 인스턴스에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍이 포함된 목록.

terminationProtectionEnabled
부울
기본값입니다: 거짓

서버리스 인스턴스에서 종료 방지 기능 활성화 여부를 나타내는 플래그. true로 설정하면 MongoDB Cloud가는 서버리스 인스턴스를 삭제하지 않습니다. false로 설정하면 MongoDB Cloud가 서버리스 인스턴스를 삭제합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

1개의 프로젝트에서 1개의 서버리스 인스턴스 제거

지정된 프로젝트의 서버리스 인스턴스 한 개를 제거합니다. 서버리스 인스턴스를 삭제하려면 종료 방지 기능이 비활성화되어 있어야 합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

이름
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 프로젝트에서 1개의 서버리스 인스턴스 반환

지정된 프로젝트의 서버리스 인스턴스 한 개에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

이름
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

1개의 프로젝트에서 1개의 서버리스 인스턴스 업데이트

지정된 프로젝트의 서버리스 인스턴스 한 개를 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

이름
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

프로젝트 한 개에서 서버리스 인스턴스 한 개를 업데이트합니다.

객체 (서버리스 백업 옵션)

서버리스 백업을 구성하는 설정 그룹.

의 배열 개체 (Resource Tag)

서버리스 인스턴스에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍이 포함된 목록.

terminationProtectionEnabled
부울
기본값입니다: 거짓

서버리스 인스턴스에서 종료 방지 기능 활성화 여부를 나타내는 플래그. true로 설정하면 MongoDB Cloud가는 서버리스 인스턴스를 삭제하지 않습니다. false로 설정하면 MongoDB Cloud가 서버리스 인스턴스를 삭제합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "serverlessBackupOptions": {
    },
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "serverlessBackupOptions": {
    },
  • "stateName": "IDLE",
  • "tags": [
    ],
  • "terminationProtectionEnabled": false
}

서버리스 비공개 엔드포인트

서버리스 인스턴스의 비공개 엔드포인트를 반환, 추가, 편집 및 제거합니다. 자세히 알아보려면 다음 튜토리얼의 Atlas 관리 API 탭을 참조하세요.

서버리스 인스턴스를 위한 비공개 엔드포인트 설정 튜토리얼

1개의 서버리스 인스턴스에 대해 모든 비공개 엔드포인트 반환

서버리스 인스턴스 한 개에 대한 모든 비공개 엔드포인트를 반환합니다. 프로젝트에서 이 리소스를 성공적으로 호출하려면 최소한 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

instanceName
필수
문자열 <= 64자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

테넌트 엔드포인트와 연결된 서버리스 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

1개의 서버리스 인스턴스에 대해 1개의 비공개 엔드포인트 만들기

서버리스 인스턴스 한 개에 대한 비공개 엔드포인트 한 개를 생성합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

새 엔드포인트는 생성 후 즉시 사용할 수 없습니다. 자세한 지침은 링크된 튜토리얼의 단계를 참조하세요.

서버리스 인스턴스를 위한 비공개 엔드포인트 설정 튜토리얼
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

instanceName
필수
문자열 <= 64자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

테넌트 엔드포인트가 생성될 서버리스 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

서버리스 인스턴스에 대해 생성할 비공개 엔드포인트에 대한 정보입니다.

comment
문자열 <= 80자

비공개 엔드포인트와 관련된 사람이 읽을 수 있는 댓글입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "comment": "string"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "providerName": "AWS",
  • "status": "RESERVATION_REQUESTED"
}

1개의 서버리스 인스턴스에 대해 1개의 비공개 엔드포인트 제거

서버리스 인스턴스 한 개에서 비공개 엔드포인트 한 개를 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

instanceName
필수
문자열 <= 64자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

테넌트 엔드포인트가 제거될 서버리스 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

endpointId
필수
문자열 = 24자 ^([a-f0-9]{24})$

제거될 테넌트 엔드포인트를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 서버리스 인스턴스에 대해 1개의 비공개 엔드포인트 반환

서버리스 인스턴스 한 개에 대한 비공개 엔드포인트 한 개를 반환합니다. 고유 ID를 사용하여 이 엔드포인트를 식별합니다. 프로젝트에서 이 리소스를 성공적으로 호출하려면 최소한 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

instanceName
필수
문자열 <= 64자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

테넌트 엔드포인트와 연결된 서버리스 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

endpointId
필수
문자열 = 24자 ^([a-f0-9]{24})$

테넌트 엔드포인트를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "providerName": "AWS",
  • "status": "RESERVATION_REQUESTED"
}

1개의 서버리스 인스턴스에 대해 1개의 비공개 엔드포인트 업데이트

서버리스 인스턴스 한 개에 대한 비공개 엔드포인트 한 개를 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

instanceName
필수
문자열 <= 64자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

업데이트될 테넌트 엔드포인트와 연결된 서버리스 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

endpointId
필수
문자열 = 24자 ^([a-f0-9]{24})$

업데이트될 테넌트 엔드포인트를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

업데이트에 사용되는 객체입니다.

comment
문자열 <= 80자

비공개 엔드포인트와 관련된 사람이 읽을 수 있는 댓글입니다.

providerName
필수
문자열

테넌트 엔드포인트의 cloud 제공자를 식별하는 사람이 읽을 수 있는 레이블입니다.

cloudProviderEndpointId
문자열^vpce-[0-9a-f]{17}$

비공개 엔드포인트의 네트워크 인터페이스를 식별하는 고유 문자열입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "comment": "string",
  • "providerName": "AWS",
  • "cloudProviderEndpointId": "string"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "_id": "32b6e34b3d91647abb20e7b8",
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "providerName": "AWS",
  • "status": "RESERVATION_REQUESTED"
}

공유 계층 복원 작업

공유 계층 데이터베이스 배포를 위한 복원 작업을 반환하고 추가합니다.

1개의 M2 또는 M5 클러스터에서 1개의 복원 작업 만들기

지정된 cluster를 복원합니다. MongoDB Cloud는 복원의 대상 cluster가 될 수 있는 cluster를 제한합니다. 대상 cluster는 미사용 데이터 암호화를 사용하거나, 스냅샷과 다른 주요 출시 MongoDB 버전을 실행하거나, 복원 중에 클라이언트 요청을 수신할 수 없습니다. MongoDB Cloud는 복원 작업 전에 대상 cluster의 모든 기존 데이터를 삭제합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

복원 작업 세부 정보입니다.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

복원할 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

targetDeploymentItemName
필수
문자열 [ 1 ... 64 ] 문자 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

스냅샷을 복원하려는 대상 프로젝트의 cluster를 식별하는 사람이 읽을 수 있는 레이블입니다. 스냅샷을 클러스터 계층 M2 이상으로 복원할 수 있습니다.

targetProjectId
문자열 = 24자 ^([a-f0-9]{24})$

스냅샷을 복원하려는 cluster가 포함된 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "deliveryType": "RESTORE",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreFinishedDate": "2019-08-24T14:15:22Z",
  • "restoreScheduledDate": "2019-08-24T14:15:22Z",
  • "snapshotFinishedDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "snapshotUrl": "string",
  • "status": "PENDING",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

1개의 M2 또는 M5 클러스터에 대해 모든 복원 작업 반환

지정된 M2 또는 M5 cluster에 대한 모든 복원 작업을 반환합니다. 복원 작업은 스냅샷을 사용하여 cluster를 복원합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 M2 또는 M5 클러스터에 대해 1개의 복원 작업 반환

지정된 복원 작업을 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

restoreId
필수
문자열 = 24자 ^([a-f0-9]{24})$

반환할 복원 작업을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "deliveryType": "RESTORE",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreFinishedDate": "2019-08-24T14:15:22Z",
  • "restoreScheduledDate": "2019-08-24T14:15:22Z",
  • "snapshotFinishedDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "snapshotUrl": "string",
  • "status": "PENDING",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

공유 계층 스냅샷

공유 계층 데이터베이스 배포 스냅샷을 반환하고 다운로드를 요청합니다.

1개의 M2 또는 M5 클러스터 스냅샷 다운로드

지정된 공유 클러스터의 스냅샷 한 개를 요청합니다. 이 리소스는 스냅샷을 다운로드하는 데 사용할 수 있는 snapshotURL을(를) 반환합니다. 이 snapshotURL은(는) 요청한 후 4시간 동안 활성 상태로 유지됩니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

다운로드할 스냅샷입니다.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

복원할 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

targetDeploymentItemName
필수
문자열 [ 1 ... 64 ] 문자 ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

스냅샷을 복원하려는 대상 프로젝트의 cluster를 식별하는 사람이 읽을 수 있는 레이블입니다. 스냅샷을 클러스터 계층 M2 이상으로 복원할 수 있습니다.

targetProjectId
문자열 = 24자 ^([a-f0-9]{24})$

스냅샷을 복원하려는 cluster가 포함된 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "clusterName": "string",
  • "deliveryType": "RESTORE",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreFinishedDate": "2019-08-24T14:15:22Z",
  • "restoreScheduledDate": "2019-08-24T14:15:22Z",
  • "snapshotFinishedDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "32b6e34b3d91647abb20e7b8",
  • "snapshotUrl": "string",
  • "status": "PENDING",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

1개의 M2 또는 M5 클러스터에 대해 모든 스냅샷 반환

지정된 공유 클러스터의 모든 스냅샷에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 M2 또는 M5 클러스터에 대해 1개의 스냅샷 반환

지정된 공유 클러스터의 스냅샷 한 개에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

clusterName
필수
문자열 [ 1 ... 64 ] 문자 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ ]

클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

snapshotId
필수
문자열 = 24자 ^([a-f0-9]{24})$

원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "expiration": "2019-08-24T14:15:22Z",
  • "finishTime": "2019-08-24T14:15:22Z",
  • "id": "32b6e34b3d91647abb20e7b8",
  • "links": [],
  • "mongoDBVersion": "string",
  • "scheduledTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "PENDING"
}

스트림

스트림 인스턴스를 반환, 추가, 편집 및 제거합니다. 이 리소스를 사용하려면 프로젝트 ID가 필요합니다.

모든 프로젝트 스트림 인스턴스 반환

지정된 프로젝트의 모든 스트림 인스턴스를 반환합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{}

1개의 스트림 인스턴스 만들기

지정된 프로젝트에 스트림 인스턴스 한 개를 생성합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 데이터 액세스 관리자 역할, 프로젝트 소유자 역할 또는 프로젝트 스트림 처리 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-02-01+json

지정된 프로젝트에 스트림 인스턴스 한 개를 생성하는 세부 정보입니다.

객체 (StreamsDataProcessRegion)

MongoDB Cloud가 스트림을 처리하는 cloud 제공자 리전에 대한 정보입니다.

이름
문자열

스트림 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

객체 또는 null (StreamConfig)

Atlas Stream Processing 인스턴스에 대한 구성 옵션입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "streamConfig": {
    }
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{}

1개의 스트림 인스턴스 삭제

지정된 프로젝트에서 스트림 인스턴스 한 개를 삭제합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 데이터 액세스 관리자 역할, 프로젝트 소유자 역할 또는 프로젝트 스트림 처리 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

삭제할 스트림 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{ }

1개의 스트림 인스턴스 반환

지정된 프로젝트 내 스트림 인스턴스 한 개에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 데이터 액세스 역할, 프로젝트 소유자 역할 또는 프로젝트 스트림 처리 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

반환할 스트림 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeConnections
부울

스트림 인스턴스에 연결 정보를 포함할지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{}

1개의 스트림 인스턴스 업데이트

지정된 프로젝트에서 스트림 인스턴스 한 개를 업데이트합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 데이터 액세스 관리자 역할, 프로젝트 소유자 역할 또는 프로젝트 스트림 처리 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

업데이트할 스트림 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-02-01+json

스트림 인스턴스에서 업데이트할 새 데이터 프로세스 리전의 세부 정보입니다.

cloudProviders
필수
문자열
열거형: "A" "GCP" "AZURE" "TENANT" "SERVERLESS"

MongoDB Cloud가 스트림 처리를 수행하는 cloud 서비스 제공자를 식별하는 레이블입니다. 현재 이 매개변수는 AWS만 지원합니다.

필수
ApiStreamsAWSRegionView(객체) (BaseStreamsRegion)

Atlas Stream Processing을 호스팅하는 cloud 제공자 리전의 이름입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{
  • "cloudProvider": "AWS",
  • "region": "VIRGINIA_USA"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{}

1개의 Atlas Stream Processing 인스턴스에 대한 감사 로그 다운로드

지정된 Atlas Streams Processing 인스턴스에 대한 감사 로그를 다운로드합니다. 기본적으로 로그는 30 일의 기간을 포함합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 데이터 액세스 역할, 프로젝트 소유자 역할 또는 프로젝트 스트림 처리 소유자 역할이 있어야 합니다. API는 json 응답 스키마를 사용한 직접 호출을 지원하지 않습니다. 'Accept: application/vnd.atlas.YYYY-MM-DD+gzip' 형식의 수락 헤더를 사용하여 gzip 응답 스키마를 요청해야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

스트림 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

endDate
integer <int64> 1199145600
예시: endDate=1636481348

다운로드할 로그 메시지 범위의 종료 지점을 지정하는 타임스탬프. MongoDB Cloud는 유닉스 시간 이후 경과된 시간(초)으로 이 타임스탬프를 표현합니다.

startDate
integer <int64> 1199145600
예시: startDate=1636466948

다운로드할 로그 메시지 범위의 시작 지점을 지정하는 타임스탬프. MongoDB Cloud는 유닉스 시간 이후 경과된 시간(초)으로 이 타임스탬프를 표현합니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

스트림 인스턴스의 모든 연결 반환

지정된 프로젝트에 대한 스트림 인스턴스의 모든 연결을 반환합니다. 이 리소스를 사용하려면 요청 API 키에 프로젝트 데이터 액세스 역할, 프로젝트 소유자 역할 또는 프로젝트 스트림 처리 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

스트림 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{}

1개의 연결 만들기

지정된 프로젝트의 스트림 인스턴스에 대한 연결 한 개를 생성합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 또는 프로젝트 스트림 처리 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

스트림 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-02-01+json

지정된 프로젝트의 스트림 인스턴스에 대한 연결 한 개를 생성하는 세부 정보입니다.

이름
문자열

스트림 연결을 식별하는 사람이 읽을 수 있는 레이블입니다. 샘플 유형의 경우 샘플 소스의 이름입니다.

유형
문자열

연결 유형입니다. Cluster 또는 Kafka 중 하나가 될 수 있습니다.

clusterName
문자열

이 연결에 대해 구성된 cluster의 이름입니다.

객체 (DBRoleToExecute)

Atlas cluster에 연결할 내장 또는 사용자 지정 DB 역할의 이름입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
예제
{
  • "name": "string",
  • "type": "Cluster",
  • "clusterName": "string",
  • "dbRoleToExecute": {
    }
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
예제
{}

1개의 스트림 연결 삭제

지정된 스트림 인스턴스의 연결 한 개를 삭제합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할 또는 프로젝트 스트림 처리 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

스트림 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

connectionName
필수
문자열

스트림 연결을 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
{ }

1개의 스트림 연결 반환

지정된 스트림 인스턴스 내 스트림 연결 한 개에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

반환할 스트림 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

connectionName
필수
문자열

반환할 스트림 연결을 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
예제
{}

1개의 스트림 연결 업데이트

지정된 프로젝트의 지정된 스트림 인스턴스에 대한 연결 한 개를 업데이트합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할 또는 프로젝트 스트림 처리 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

tenantName
필수
문자열

스트림 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.

connectionName
필수
문자열

스트림 연결을 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-02-01+json

지정된 프로젝트의 스트림 인스턴스에 대한 연결 한 개를 업데이트하는 세부 정보입니다.

이름
문자열

스트림 연결을 식별하는 사람이 읽을 수 있는 레이블입니다. 샘플 유형의 경우 샘플 소스의 이름입니다.

유형
문자열

연결 유형입니다. Cluster 또는 Kafka 중 하나가 될 수 있습니다.

clusterName
문자열

이 연결에 대해 구성된 cluster의 이름입니다.

객체 (DBRoleToExecute)

Atlas cluster에 연결할 내장 또는 사용자 지정 DB 역할의 이름입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
예제
{
  • "name": "string",
  • "type": "Cluster",
  • "clusterName": "string",
  • "dbRoleToExecute": {
    }
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-02-01+json
예제
{}

팀

팀을 반환, 추가, 수정 또는 제거합니다.

1개의 프로젝트에서 모든 팀 반환

고유한 24자리 16진수 식별자를 사용하여 지정된 프로젝트에서 인증된 사용자가 액세스할 수 있는 모든 팀을 반환합니다. 팀의 모든 구성원은 동일한 프로젝트 액세스 권한을 공유합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 프로젝트에 1개 이상의 팀 추가

지정된 프로젝트에 팀 한 개를 추가합니다. 팀의 모든 구성원은 동일한 프로젝트 액세스 권한을 공유합니다. MongoDB Cloud는 사용자 수를 프로젝트당 최대 100개 팀, 조직당 최대 250개 팀으로 제한합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

조직 팀 관리
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 프로젝트에 추가할 팀입니다.

배열
roleNames
의 배열 strings unique
항목 열거형: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

MongoDB Cloud 사용자에게 할당할 한 개 이상의 조직 또는 프로젝트 수준 역할입니다.

teamId
문자열 = 24자 ^([a-f0-9]{24})$

팀을 식별하는 고유한 24자리 16진수 문자열입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 프로젝트에서 1개의 팀 제거

고유한 24자리 16진수 식별자를 사용하여 지정된 프로젝트에서 고유한 24자리 16진수 식별자를 사용하여 지정된 팀 한 개를 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

조직 팀 관리
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

teamId
필수
문자열 = 24자 ^([a-f0-9]{24})$

지정된 프로젝트에서 제거하려는 팀을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

1개의 프로젝트에서 팀 역할 업데이트

지정된 팀에 할당된 프로젝트 역할을 업데이트합니다. 특정 프로젝트에 대한 팀 역할을 부여하고 팀 사용자에게 프로젝트 액세스 역할을 부여할 수 있습니다. 팀의 모든 구성원은 동일한 프로젝트 액세스 권한을 공유합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

조직 팀 관리
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

teamId
필수
문자열 = 24자 ^([a-f0-9]{24})$

역할을 업데이트하려는 팀을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 팀에 할당된 프로젝트 역할입니다.

roleNames
의 배열 strings unique
항목 열거형: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

MongoDB Cloud 사용자에게 할당할 한 개 이상의 조직 또는 프로젝트 수준 역할입니다.

teamId
문자열 = 24자 ^([a-f0-9]{24})$

팀을 식별하는 고유한 24자리 16진수 문자열입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "roleNames": [
    ],
  • "teamId": "32b6e34b3d91647abb20e7b8"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 조직에서 모든 팀 반환

지정된 조직에 속한 모든 팀을 반환합니다. Teams를 활성화하면 MongoDB Cloud 사용자에게 프로젝트 액세스 역할을 부여할 수 있습니다. MongoDB Cloud는 액세스 권한이 있는 팀만 반환합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

조직 팀 관리
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 조직에 1개의 팀 만들기

지정된 조직에 팀 한 개를 생성합니다. Teams를 활성화하면 MongoDB Cloud 사용자에게 프로젝트 액세스 역할을 부여할 수 있습니다. MongoDB Cloud는 조직당 팀 수를 최대 250개로 제한합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

조직 팀 관리
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 조직에 생성하려는 팀입니다.

이름
필수
문자열

팀을 식별하는 사람이 읽을 수 있는 레이블입니다.

사용자 이름
의 배열 strings <email> unique

이 팀의 MongoDB Cloud 사용자가 포함된 목록입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "name": "string",
  • "usernames": [
    ]
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

이름을 사용하여 1개의 팀 반환

사람이 읽을 수 있는 이름을 사용하여 식별한 팀 한 개를 반환합니다. 이 팀은 조직 한 개에 속해 있습니다. Teams를 활성화하면 MongoDB Cloud 사용자에게 프로젝트 액세스 역할을 부여할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

조직 팀 관리
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

teamName
필수
문자열

정보를 반환하려는 팀의 이름입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 조직에서 1개의 팀 제거

고유한 24자리 16진수 식별자를 사용하여 지정된 조직에서 고유한 24자리 16진수 식별자를 사용하여 지정된 팀 한 개를 제거합니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

조직 팀 관리
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

teamId
필수
문자열 = 24자 ^([a-f0-9]{24})$

삭제하려는 팀을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

ID를 사용하여 1개의 팀 반환

고유한 24자리 16진수 ID를 사용하여 식별한 팀 한 개를 반환합니다. 이 팀은 조직 한 개에 속해 있습니다. Teams를 활성화하면 MongoDB Cloud 사용자에게 프로젝트 액세스 역할을 부여할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

조직 팀 관리
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

teamId
필수
문자열 = 24자 ^([a-f0-9]{24})$

반환하려는 정보가 있는 팀을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 팀 이름 변경

지정된 조직에서 팀 한 개의 이름을 변경합니다. Teams를 활성화하면 MongoDB Cloud 사용자에게 프로젝트 액세스 역할을 부여할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

조직 팀 관리
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

teamId
필수
문자열 = 24자 ^([a-f0-9]{24})$

이름을 바꾸려는 팀을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 팀에서 업데이트할 세부 정보입니다.

이름
필수
문자열

팀을 식별하는 사람이 읽을 수 있는 레이블입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "name": "string"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 팀에 할당된 모든 MongoDB 클라우드 사용자 반환

고유한 24자리 16진수 식별자를 사용하여 지정된 팀에 할당된 모든 MongoDB Cloud 사용자를 반환합니다. 이 팀은 조직 한 개에 속해 있습니다. Teams를 활성화하면 MongoDB Cloud 사용자에게 프로젝트 액세스 역할을 부여할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.

조직 팀 관리
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

teamId
필수
문자열 = 24자 ^([a-f0-9]{24})$

반환하려는 애플리케이션 사용자가 속한 팀을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 조직에서 1개의 팀으로 MongoDB 클라우드 사용자 할당

지정된 조직에서 지정된 팀에 MongoDB Cloud 사용자를 한 명 이상 추가합니다. Teams를 활성화하면 MongoDB Cloud 사용자에게 프로젝트 액세스 역할을 부여할 수 있습니다. 조직 한 개에서 팀 한 개에 MongoDB Cloud 사용자를 최대 250명까지 할당할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

조직 팀 관리
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

teamId
필수
문자열 = 24자 ^([a-f0-9]{24})$

MongoDB Cloud 사용자를 추가하려는 팀을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 팀에 추가할 한 명 이상의 MongoDB Cloud 사용자입니다.

배열
id
필수
문자열 = 24자 ^([a-f0-9]{24})$

MongoDB Cloud 사용자를 식별하는 고유한 24자리 16진수 문자열입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
[
  • {
    }
]

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1개의 팀에서 1명의 MongoDB 클라우드 사용자 제거

지정된 팀에서 MongoDB Cloud 사용자 한 명을 제거합니다. 이 팀은 조직 한 개에 속해 있습니다. Teams를 활성화하면 MongoDB Cloud 사용자에게 프로젝트 액세스 역할을 부여할 수 있습니다. 이 리소스를 사용하려면 요청하는 API 키에 조직 소유자 역할이 있어야 합니다.

조직 팀 관리
권한 부여
DigestAuth
경로 매개변수
orgId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

teamId
필수
문자열 = 24자 ^([a-f0-9]{24})$

데이터베이스 애플리케이션 사용자 한 명을 제거하려는 팀을 식별하는 고유한 24자리 16진수 문자열입니다.

userId
필수
문자열 = 24자 ^([a-f0-9]{24})$

지정된 팀에서 제거하려는 MongoDB Cloud 사용자를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "VALIDATION_ERROR",
  • "reason": "Bad Request"
}

타사 통합

타사 서비스 통합 구성을 반환, 추가, 편집 및 제거합니다. MongoDB Cloud는 사용자가 구성한 각 타사 서비스에 경고를 전송합니다.

중요: 각 프로젝트에는 통합 유형당 구성이 한 개만 있을 수 있습니다.

모든 활성 타사 서비스 통합 반환

구성된 모든 타사 서비스와의 통합을 허용하는 설정을 반환합니다. 이러한 설정은 MongoDB Cloud 프로젝트 한 개에서 관리되는 모든 데이터베이스에 적용됩니다. 이 리소스를 사용하려면 요청 API 키에 조직 소유자 또는 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 타사 서비스 통합 제거

타사 서비스 통합 한 개의 구성을 허용하는 설정을 제거합니다. 이러한 설정은 MongoDB Cloud 프로젝트 한 개에서 관리되는 모든 데이터베이스에 적용됩니다. 프로젝트에서 통합을 삭제하면 해당 프로젝트에 대한 통합 구성만 제거됩니다. 이 조치는 다른 프로젝트나 조직에서 구성된 {INTEGRATION-TYPE} 통합에 영향을 미치지 않습니다. 이 리소스를 사용하려면 요청 API 키에 조직 소유자 또는 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
integrationType
필수
문자열 (통합 유형)
열거형: "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

MongoDB Cloud와 통합하려는 서비스를 식별하는 사람이 읽을 수 있는 레이블입니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{ }

1개의 타사 서비스 통합 반환

타사 서비스 한 개와의 통합을 구성하기 위한 설정을 반환합니다. 이러한 설정은 MongoDB Cloud 프로젝트 한 개에서 관리되는 모든 데이터베이스에 적용됩니다. 이 리소스를 사용하려면 요청 API 키에 조직 소유자 또는 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

integrationType
필수
문자열 (통합 유형)
열거형: "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

MongoDB Cloud와 통합하려는 서비스를 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "apiKey": "****************************a23c",
  • "id": "string",
  • "region": "US",
  • "type": "DATADOG"
}

1개의 타사 서비스 통합 구성

타사 서비스 통합 한 개를 구성하기 위해 설정을 추가합니다. 이러한 설정은 지정된 MongoDB Cloud 프로젝트에서 관리되는 모든 데이터베이스에 적용됩니다. 각 프로젝트에는 {INTEGRATION-TYPE}당 구성이 한 개만 있을 수 있습니다. 이 리소스를 사용하려면 요청 API 키에 조직 소유자 또는 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
integrationType
필수
문자열 (통합 유형)
열거형: "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

MongoDB Cloud와 통합하려는 서비스를 식별하는 사람이 읽을 수 있는 레이블입니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

프로젝트에 대해 구성하려는 타사 통합입니다.

apiKey
필수
문자열

MongoDB Cloud가 Datadog 계정에 액세스할 수 있도록 허용하는 키입니다.

참고: API 또는 통합 키가 필요한 알림을 생성한 후 다음과 같은 경우 키가 부분적으로 수정된 것으로 표시됩니다.

  • Atlas UI를 통해 경고를 보거나 편집합니다.

  • Atlas 관리 API를 통해 알림에 대한 경고를 쿼리합니다.

id
문자열 또는 null

통합 ID입니다.

region
문자열
열거형: "US" "EU" "US3" "US5" "AP1"

데이터독 API에 액세스하는 데 사용하는 리전 URL MongoDB를 나타내는 두 글자 코드입니다.

Datadog의 리전에 대해 자세히 알아보려면 Datadog 사이트를 참조하세요.

유형
문자열

MongoDB Cloud와 통합하려는 서비스를 식별하는 사람이 읽을 수 있는 레이블입니다. 이 값은 타사 서비스 통합 유형과 일치해야 합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "apiKey": "****************************a23c",
  • "id": "string",
  • "region": "US",
  • "type": "DATADOG"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

1개의 타사 서비스 통합 업데이트

타사 서비스 한 개와의 통합을 구성하기 위한 설정을 업데이트합니다. 이러한 설정은 MongoDB Cloud 프로젝트 한 개에서 관리되는 모든 데이터베이스에 적용됩니다. 이 리소스를 사용하려면 요청 API 키에 조직 소유자 또는 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
integrationType
필수
문자열 (통합 유형)
열거형: "PAGER_DUTY" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "HIP_CHAT" "PROMETHEUS" "MICROSOFT_TEAMS"

MongoDB Cloud와 통합하려는 서비스를 식별하는 사람이 읽을 수 있는 레이블입니다.

groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

프로젝트에 대해 구성하려는 타사 통합입니다.

apiKey
필수
문자열

MongoDB Cloud가 Datadog 계정에 액세스할 수 있도록 허용하는 키입니다.

참고: API 또는 통합 키가 필요한 알림을 생성한 후 다음과 같은 경우 키가 부분적으로 수정된 것으로 표시됩니다.

  • Atlas UI를 통해 경고를 보거나 편집합니다.

  • Atlas 관리 API를 통해 알림에 대한 경고를 쿼리합니다.

id
문자열 또는 null

통합 ID입니다.

region
문자열
열거형: "US" "EU" "US3" "US5" "AP1"

데이터독 API에 액세스하는 데 사용하는 리전 URL MongoDB를 나타내는 두 글자 코드입니다.

Datadog의 리전에 대해 자세히 알아보려면 Datadog 사이트를 참조하세요.

유형
문자열

MongoDB Cloud와 통합하려는 서비스를 식별하는 사람이 읽을 수 있는 레이블입니다. 이 값은 타사 서비스 통합 유형과 일치해야 합니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
예제
{
  • "apiKey": "****************************a23c",
  • "id": "string",
  • "region": "US",
  • "type": "DATADOG"
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{}

X.509 인증

사용자 관리형 X.509 구성을 반환, 편집 및 제거합니다. 또한 데이터베이스 사용자를 위한 MongoDB Cloud 관리형 X.509 인증서를 반환하고 생성합니다. 다음 리소스는 X.509 인증서를 사용하여 인증하는 데이터베이스 사용자를 관리하는 데 도움이 됩니다. 이러한 X.509 인증서를 관리하거나 MongoDB Cloud에서 대신 관리하도록 할 수 있습니다. MongoDB Cloud가 인증서를 관리하는 경우 인증 기관도 관리하고 데이터베이스 사용자를 위한 인증서를 생성할 수 있습니다. 추가 X.509 구성이 필요하지 않습니다. 인증서를 관리하는 경우 인증 기관을 제공하고 데이터베이스 사용자를 위한 인증서를 생성해야 합니다.

자체 관리형 X.509 인증서

1명의 MongoDB 사용자에게 할당된 모든 X.509 인증서 반환

지정된 MongoDB 사용자에 대한 만료되지 않은 모든 X.509 인증서를 반환합니다. 이 MongoDB 사용자는 프로젝트 한 개에 속합니다. Atlas는 이러한 인증서와 MongoDB 사용자를 관리합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

사용자 이름
필수
문자열

반환하려는 인증서가 있는 MongoDB database 사용자 계정을 나타내는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

includeCount
부울
기본값입니다: true
예시: includeCount=true

응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.

itemsPerPage
integer [ 1 .. 500 ]
기본값입니다: 100
예시: itemsPerPage=100

페이지당 응답이 반환하는 항목 수입니다.

pageNum
integer >= 1
기본값입니다: 1
예시: pageNum=1

응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "links": [],
  • "results": [
    ],
  • "totalCount": 0
}

1명의 MongoDB 사용자에 대해 1개의 X.509 인증서 만들기

지정된 MongoDB 사용자에 대한 X.509 인증서 한 개를 생성합니다. Atlas는 프로젝트 한 개에 속한 인증서와 MongoDB 사용자를 관리합니다. 이 리소스를 사용하려면 요청하는 API 키에 프로젝트 소유자 역할이 있어야 합니다.

데이터베이스 사용자에 대한 관리형 인증서를 생성하도록 MongoDB Cloud를 사용하려면 원하는 MongoDB 데이터베이스 사용자에 "x509Type" : "MANAGED"을(를) 설정합니다.

자체 관리형 X.509 모드에서 자체 인증 기관(Certificate Authority, CA)을 관리하는 경우 자체 CA를 사용하여 데이터베이스 사용자를 위한 인증서를 생성해야 합니다.

자체 관리형 X.509
권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

사용자 이름
필수
문자열

인증서를 생성할 MongoDB database 사용자 계정을 나타내는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

pretty
부울
기본값입니다: 거짓
예시: pretty=false

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

요청 본문 스키마: application/vnd.atlas.2023-01-01+json

지정된 MongoDB 사용자에 대한 X.509 인증서 한 개를 생성합니다.

monthsUntilExpiration
integer <int32> <= 24
기본값입니다: 3

인증서가 만료될 때까지 유효하게 유지되는 개월 수입니다.

응답

샘플 요청

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "monthsUntilExpiration": 3
}

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
"string"

고객 관리형 X.509 비활성화

업로드된 인증 기관을 포함하여 프로젝트에서 고객 관리형 X.509 설정을 지우고 자체 관리형 X.509를 비활성화합니다.

이 구성을 업데이트하면 데이터베이스의 롤링 재시작이 트리거됩니다. 이 엔드포인트를 사용하려면 프로젝트 소유자 역할이 있어야 합니다.

권한 부여
DigestAuth
경로 매개변수
groupId
필수
문자열 = 24자 ^([a-f0-9]{24})$
예시: 32b6e34b3d91647abb20e7b8

프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

쿼리 매개변수
envelope
부울
기본값입니다: 거짓
예시: envelope=false

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

응답

응답 샘플

콘텐츠 유형
application/vnd.atlas.2023-01-01+json
{
  • "customerX509": {},
  • "ldap": {
    },
  • "links": []
}