MongoDB Atlas 관리자 API (2.0)

리소스 버전 2025-03-12

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

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

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

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

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

MongoDB의 Postman 작업 공간에서 Atlas Administration API를 통해 사용할 수 있는 다양한 엔드포인트를 탐색할 수도 있습니다.

액세스 추적

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

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

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

데이터베이스 액세스 기록

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint
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": [{"authResult": true,
"authSource": "string",
"failureReason": "string",
"groupId": "string",
"hostname": "string",
"ipAddress": "string",
"logLine": "string",
"timestamp": "string",
"username": "string"
}
]
}

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

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

데이터베이스 액세스 기록

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

호스트 이름

필수

문자열

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint
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 클라우드가 데이터베이스 기록을 조회하기 시작하는 날짜 및 시간입니다. 시작을 지정하는 경우 끝도 지정해야 합니다. 이 매개변수는 유닉스 시간(밀리초)을 사용합니다.

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"accessLogs": [{"authResult": true,
"authSource": "string",
"failureReason": "string",
"groupId": "string",
"hostname": "string",
"ipAddress": "string",
"logLine": "string",
"timestamp": "string",
"username": "string"
}
]
}

알림 구성

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

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

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

권한 부여

서비스 계정DigestAuth

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

["APPLICATION_ID"
]

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

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"created": "2019-08-24T14:15:22Z",
"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"updated": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

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

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

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

다음 중 하나

활성화됨	부울 기본값입니다: 거짓 누군가가 지정된 프로젝트에 대해 이 경고 구성을 활성화했는지 여부를 나타내는 플래그입니다.
필수	청구 이벤트 유형(객체) 또는 Cps 백업 이벤트 유형(객체) 또는 데이터 보호 이벤트 유형(객체) 또는 FTS 인덱스 감사 유형(객체) 또는 그룹 이벤트 유형(객체) 또는 NDS 감사 유형(객체) 또는 NDS 유지 관리 기간 감사 유형 (객체) 또는 온라인 보관 이벤트 유형 (객체) 또는 사용자 이벤트 유형 (객체) 또는 리소스 이벤트 유형 (객체) 또는 스트림 프로세서 이벤트 유형 (객체) 또는 NDS 자동 확장 감사 유형 (객체) 또는 Atlas 리소스 정책 감사 유형 (객체 )) 이 경고를 트리거한 인시던트입니다.
	의 배열 객체 (일치기) 대상 리소스에 대한 일치 조건입니다.
필수	의 배열 Datadog 알림(객체) 또는 이메일 알림(객체) 또는 그룹 알림(객체) 또는 HipChat 알림(객체) 또는 Microsoft Teams 알림(객체) 또는 OpsGenie 알림(객체) 또는 조직 알림(객체) 또는 PagerDuty 알림(객체) 또는 Slack 알림(객체) 또는 SMS 알림(객체) 또는 팀 알림(객체) 또는 사용자 알림(객체) 또는 VictorOps 알림(객체) 또는 웹훅 알림(객체) (AlertsNotificationRootForGroup) MongoDB 클라우드가 알림을 보내는 대상이 포함된 목록입니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

기타 경고 구성

{"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
]
}

응답 샘플

콘텐츠 유형

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": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"updated": "2019-08-24T14:15:22Z"
}

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

지정된 프로젝트 에서 하나의 경고 구성을 제거합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 조직 소유자 또는 프로젝트 소유자 역할 있어야 합니다. 하나의 프로젝트에 대한 모든 경고 구성 반환 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 경고 구성을 조회 .

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

alertConfigId

필수

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

예시: 32b6e34b3d91647abb20e7b8

경고 구성을 식별하는 고유한 24-16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

401
403
404
500

콘텐츠 유형

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 키에 프로젝트 읽기 전용 역할 있어야 합니다. 하나의 프로젝트에 대한 모든 경고 구성 반환 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 경고 구성을 조회 .

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

alertConfigId

필수

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

예시: 32b6e34b3d91647abb20e7b8

경고 구성을 식별하는 고유한 24-16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

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": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"updated": "2019-08-24T14:15:22Z"
}

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

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

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

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

1개의 경고 구성 업데이트

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

alertConfigId

필수

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

예시: 32b6e34b3d91647abb20e7b8

이 경고 트리거한 경고 구성을 식별하는 고유한 24-16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

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

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

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"enabled": true
}

응답 샘플

200
401
403
404
500

콘텐츠 유형

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": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"updated": "2019-08-24T14:15:22Z"
}

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

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

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

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

alertConfigId

필수

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

예시: 32b6e34b3d91647abb20e7b8

경고 구성을 식별하는 고유한 24-16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

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

다음 중 하나

활성화됨	부울 기본값입니다: 거짓 누군가가 지정된 프로젝트에 대해 이 경고 구성을 활성화했는지 여부를 나타내는 플래그입니다.
필수	청구 이벤트 유형(객체) 또는 Cps 백업 이벤트 유형(객체) 또는 데이터 보호 이벤트 유형(객체) 또는 FTS 인덱스 감사 유형(객체) 또는 그룹 이벤트 유형(객체) 또는 NDS 감사 유형(객체) 또는 NDS 유지 관리 기간 감사 유형 (객체) 또는 온라인 보관 이벤트 유형 (객체) 또는 사용자 이벤트 유형 (객체) 또는 리소스 이벤트 유형 (객체) 또는 스트림 프로세서 이벤트 유형 (객체) 또는 NDS 자동 확장 감사 유형 (객체) 또는 Atlas 리소스 정책 감사 유형 (객체 )) 이 경고를 트리거한 인시던트입니다.
	의 배열 객체 (일치기) 대상 리소스에 대한 일치 조건입니다.
필수	의 배열 Datadog 알림(객체) 또는 이메일 알림(객체) 또는 그룹 알림(객체) 또는 HipChat 알림(객체) 또는 Microsoft Teams 알림(객체) 또는 OpsGenie 알림(객체) 또는 조직 알림(객체) 또는 PagerDuty 알림(객체) 또는 Slack 알림(객체) 또는 SMS 알림(객체) 또는 팀 알림(객체) 또는 사용자 알림(객체) 또는 VictorOps 알림(객체) 또는 웹훅 알림(객체) (AlertsNotificationRootForGroup) MongoDB 클라우드가 알림을 보내는 대상이 포함된 목록입니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

기타 경고 구성

{"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
]
}

응답 샘플

콘텐츠 유형

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": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"updated": "2019-08-24T14:15:22Z"
}

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

지정된 경고 에 대해 설정하다 모든 경고 구성을 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다. 하나의 프로젝트에서 모든 경고 반환 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 경고를 조회 .

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

alertId

필수

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

경고 를 식별하는 고유한 24-16진수 문자열입니다.

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"created": "2019-08-24T14:15:22Z",
"enabled": false,
"eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"matchers": [{"fieldName": "string",
"operator": "EQUALS",
"value": "event-replica-set"
}
],
"notifications": [{"datadogApiKey": "****************************a23c",
"datadogRegion": "US",
"delayMin": 0,
"integrationId": "32b6e34b3d91647abb20e7b8",
"intervalMin": 5,
"notifierId": "32b6e34b3d91647abb20e7b8",
"typeName": "DATADOG"
}
],
"updated": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

알림

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

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

지정된 경고 구성이 트리거하는 모든 열린 경고를 반환합니다. 이러한 경고 구성은 지정된 프로젝트 에만 적용 . 경고 구성은 경고에 대한 트리거 및 알림 메서드를 정의합니다. 열린 경고가 트리거되었지만 승인되지 않은 상태로 유지됩니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다. 하나의 프로젝트에 대한 모든 경고 구성 반환 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 경고 구성을 조회 .

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

alertConfigId

필수

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

예시: 32b6e34b3d91647abb20e7b8

경고 구성을 식별하는 고유한 24-16진수 문자열입니다.

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"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": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"resolved": "2019-08-24T14:15:22Z",
"status": "OPEN",
"updated": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

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

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint
상태	문자열 열거형: "OPEN" "TRACKING" "CLOSED" 반환할 경고의 상태입니다. 모든 상태의 모든 경고를 반환하려면 생략합니다.

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"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": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"resolved": "2019-08-24T14:15:22Z",
"status": "OPEN",
"updated": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

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

하나의 경고 반환합니다. 이 경고 한 프로젝트 의 모든 구성 요소에 적용됩니다. 모니터링되는 구성 요소가 설정하다 한 값을 충족하거나 초과하면 경고 받습니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다. 하나의 프로젝트에서 모든 경고 반환 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 경고를 조회 .

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

alertId

필수

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

경고 를 식별하는 고유한 24-16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

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": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"resolved": "2019-08-24T14:15:22Z",
"status": "OPEN",
"updated": "2019-08-24T14:15:22Z"
}

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

하나의 기존 경고 수신을 확인합니다. 이 경고 한 프로젝트 의 모든 구성 요소에 적용됩니다. 경고 승인하면 연속적인 알림 방지할 수 있습니다. 모니터링되는 구성 요소가 설정하다 값을 충족하거나 초과하면 경고 확인할 때까지 경고 받게 됩니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 조직 소유자 또는 프로젝트 소유자 역할 있어야 합니다. 하나의 프로젝트에서 모든 경고 반환 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 경고를 조회 .

이 리소스는 계속 수정되며 변경될 수 있습니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

alertId

필수

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

경고 를 식별하는 고유한 24-16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-05-30+json

1개의 알림을 승인하거나 승인 취소합니다.

acknowledgedUntil	문자열 <date-time> 이 경고가 승인될 때까지의 날짜 및 시간. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. MongoDB 사용자가 이전에 이 경고를 확인한 경우 리소스는 이 매개변수를 반환합니다. ISO 8601
acknowledgementComment	문자열 <= 200 characters MongoDB 클라우드 사용자가 경고를 승인할 때 제출한 코멘트입니다.
unacknowledgeAlert	부울 이전에 승인한 알림을 승인하지 않음을 나타내는 플래그입니다. 기본적으로 이 값은 false로 설정되어 있습니다. true로 설정하면 acknowledgedUntil 매개변수를 재정의합니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"acknowledgedUntil": "2019-08-24T14:15:22Z",
"acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
"unacknowledgeAlert": true
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+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": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"resolved": "2019-08-24T14:15:22Z",
"status": "OPEN",
"updated": "2019-08-24T14:15:22Z"
}

Atlas Search

지정된 클러스터에 대해 Atlas Search 인덱스를 반환, 추가, 편집 및 제거합니다. 또한 지정된 클러스터에 대해 사용자 정의 분석기를 반환하고 업데이트합니다.

1개의 Atlas Search 인덱스 생성 더 이상 사용되지 않음

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

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

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

collectionName 필수	문자열 1개 이상의 Atlas Search 인덱스가 포함된 컬렉션을 식별하는 사람이 읽을 수 있는 라벨입니다.
database 필수	문자열 1개 이상의 Atlas Search 인덱스가 포함된 데이터베이스를 식별하는 사람이 읽을 수 있는 라벨입니다.
이름 필수	문자열 이 인덱스를 식별하는 사람이 읽을 수 있는 라벨입니다. 각 네임스페이스 내에서 네임스페이스에 있는 모든 인덱스의 이름은 고유해야 합니다.
numPartitions	integer <int32> 기본값입니다: 1 인덱스 파티션 수입니다. 허용되는 값은 [1, 2, 4]입니다.
유형	문자열 인덱스의 유형입니다. 기본 유형은 검색입니다. 검색
분석기	문자열 기본값입니다: "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" 이 인덱스를 검색할 때 단어를 식별하는 데 적용되는 메서드입니다.
저장된 소스	객체 Atlas Search에 모든 필드를 저장할지(참) 여부를 나타내는 플래그입니다. 기본적으로 Atlas는 Atlas Search에 필드를 저장하지 않습니다(거짓). 또는 Atlas Search에 저장(포함)하거나 저장하지 않을(제외) 필드 목록만 포함하는 객체를 지정할 수 있습니다. 자세한 내용은 설명서를 참조하세요. 저장된 소스 필드
	의 배열 객체 (동의어 매핑 정의) 이 인덱스에서 단어를 동의어에 매핑하는 규칙 집합입니다. 동의어 매핑

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

검색

{"collectionName": "string",
"database": "string",
"name": "string",
"numPartitions": 1,
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
],
"mappings": {"dynamic": false,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

검색

{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"name": "string",
"numPartitions": 1,
"status": "IN_PROGRESS",
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
],
"mappings": {"dynamic": false,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}

1개의 컬렉션에 대해 모든 Atlas Search 인덱스 반환 더 이상 사용되지 않음

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

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 하나 이상의 Atlas Search 인덱스가 있는 컬렉션을 포함하는 클러스터의 이름입니다.
collectionName 필수	문자열 하나 이상의 Atlas Search 인덱스가 포함된 컬렉션의 이름입니다.
databaseName 필수	문자열 1개 이상의 Atlas Search 인덱스가 포함된 데이터베이스를 식별하는 사람이 읽을 수 있는 라벨입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

[{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"name": "string",
"numPartitions": 1,
"status": "IN_PROGRESS",
"type": "search"
}
]

1개의 Atlas Search 인덱스 제거 더 이상 사용되지 않음

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

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 하나 이상의 애플리케이션 검색 인덱스가 있는 데이터베이스 및 컬렉션을 포함하는 클러스터의 이름입니다.
indexId 필수	문자열^([a-f0-9]{24})$ Atlas cluster를 식별하는 고유한 24자리 16진수 문자열입니다. 컬렉션에 대한 모든 Atlas Search 인덱스 가져오기 API 엔드포인트를 사용하여 모든 Atlas Search 인덱스의 ID를 찾을 수 있습니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

400
401
403
404
500

콘텐츠 유형

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 인덱스 반환합니다. 고유 ID 사용하여 이 인덱스 식별합니다. Atlas Search 인덱스 에는 인덱싱된 필드와 인덱스 생성하는 데 사용된 분석기가 포함되어 있습니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 데이터 액세스 읽기 쓰기 역할 있어야 합니다.

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 하나 이상의 Atlas Search 인덱스가 있는 컬렉션을 포함하는 클러스터의 이름입니다.
indexId 필수	문자열^([a-f0-9]{24})$ Application Search 인덱스를 식별하는 고유한 24진수 문자열입니다. 컬렉션에 대한 모든 애플리케이션 검색 인덱스 가져오기 API 엔드포인트를 사용하여 모든 애플리케이션 검색 인덱스의 ID를 찾을 수 있습니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

검색

{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"name": "string",
"numPartitions": 1,
"status": "IN_PROGRESS",
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
],
"mappings": {"dynamic": false,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}

1개의 Atlas Search 인덱스 업데이트 더 이상 사용되지 않음

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

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ Atlas Search 인덱스를 업데이트할 컬렉션이 포함된 클러스터의 이름입니다.
indexId 필수	문자열^([a-f0-9]{24})$ 아틀라스 검색 인덱스를 식별하는 고유한 24자리 16진수 문자열입니다. 컬렉션에 대한 모든 Atlas Search 인덱스 가져오기 API 엔드포인트를 사용하여 모든 Atlas Search 인덱스의 ID를 찾을 수 있습니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

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

collectionName 필수	문자열 1개 이상의 Atlas Search 인덱스가 포함된 컬렉션을 식별하는 사람이 읽을 수 있는 라벨입니다.
database 필수	문자열 1개 이상의 Atlas Search 인덱스가 포함된 데이터베이스를 식별하는 사람이 읽을 수 있는 라벨입니다.
이름 필수	문자열 이 인덱스를 식별하는 사람이 읽을 수 있는 라벨입니다. 각 네임스페이스 내에서 네임스페이스에 있는 모든 인덱스의 이름은 고유해야 합니다.
numPartitions	integer <int32> 기본값입니다: 1 인덱스 파티션 수입니다. 허용되는 값은 [1, 2, 4]입니다.
유형	문자열 인덱스의 유형입니다. 기본 유형은 검색입니다. 검색
분석기	문자열 기본값입니다: "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" 이 인덱스를 검색할 때 단어를 식별하는 데 적용되는 메서드입니다.
저장된 소스	객체 Atlas Search에 모든 필드를 저장할지(참) 여부를 나타내는 플래그입니다. 기본적으로 Atlas는 Atlas Search에 필드를 저장하지 않습니다(거짓). 또는 Atlas Search에 저장(포함)하거나 저장하지 않을(제외) 필드 목록만 포함하는 객체를 지정할 수 있습니다. 자세한 내용은 설명서를 참조하세요. 저장된 소스 필드
	의 배열 객체 (동의어 매핑 정의) 이 인덱스에서 단어를 동의어에 매핑하는 규칙 집합입니다. 동의어 매핑

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

검색

{"collectionName": "string",
"database": "string",
"name": "string",
"numPartitions": 1,
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
],
"mappings": {"dynamic": false,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

검색

{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"name": "string",
"numPartitions": 1,
"status": "IN_PROGRESS",
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"ignoredTags": ["string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [{"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {"maxGram": 0,
"minGram": 0,
"type": "edgeGram"
}
}
],
"mappings": {"dynamic": false,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}

검색 노드 삭제

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

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"
}

검색 노드 반환

지정된 클러스터에 대한 검색 노드를 반환합니다. 사용 중단된 버전: v2-{2024-05-30}, v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2025-03-12+json

{"encryptionAtRestProvider": "NONE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"specs": [{"instanceSize": "S20_HIGHCPU_NVME",
"nodeCount": 2
}
],
"stateName": "IDLE"
}

검색 노드 업데이트

지정된 클러스터에 대한 검색 노드를 업데이트합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-05-30+json

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

필수	의 배열 객체 (ApiSearchDeploymentSpecView) = 1개 항목 클러스터에 대한 검색 노드를 구성하는 설정 목록입니다. 참고: 현재 모든 노드에 대해 단일 구성만 허용됩니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"specs": [{"instanceSize": "S20_HIGHCPU_NVME",
"nodeCount": 2
}
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"encryptionAtRestProvider": "NONE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"specs": [{"instanceSize": "S20_HIGHCPU_NVME",
"nodeCount": 2
}
],
"stateName": "IDLE"
}

검색 노드 만들기

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-05-30+json

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

필수	의 배열 객체 (ApiSearchDeploymentSpecView) = 1개 항목 클러스터에 대한 검색 노드를 구성하는 설정 목록입니다. 참고: 현재 모든 노드에 대해 단일 구성만 허용됩니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"specs": [{"instanceSize": "S20_HIGHCPU_NVME",
"nodeCount": 2
}
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"encryptionAtRestProvider": "NONE",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"specs": [{"instanceSize": "S20_HIGHCPU_NVME",
"nodeCount": 2
}
],
"stateName": "IDLE"
}

1개의 클러스터에 대한 모든 Atlas Search 인덱스 반환

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

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

[{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"latestDefinition": {"numPartitions": 1
},
"latestDefinitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"name": "string",
"queryable": true,
"status": "DELETING",
"statusDetail": [{"hostname": "string",
"mainIndex": {"definition": {"numPartitions": 1
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING"
},
"queryable": true,
"stagedIndex": {"definition": {"numPartitions": 1
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING"
},
"status": "DELETING"
}
],
"type": "search"
}
]

1개의 Atlas Search 인덱스 만들기

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

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-05-30+json

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

collectionName 필수	문자열 Atlas Search 검색 인덱스를 생성하기 위한 컬렉션을 식별하는 레이블입니다.
database 필수	문자열 Atlas Search 인덱스를 생성하기 위한 컬렉션이 포함된 데이터베이스를 식별하는 레이블입니다.
이름 필수	문자열 이 인덱스를 식별하는 레이블입니다. 각 네임스페이스 내에서 네임스페이스에 있는 모든 인덱스의 이름은 고유해야 합니다.
유형	문자열 인덱스의 유형입니다. 기본 유형은 검색입니다. 검색
필수	객체 (텍스트 검색 인덱스 정의) 사용자가 설정한 텍스트 검색 인덱스 정의입니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

예시

검색

{"collectionName": "string",
"database": "string",
"name": "string",
"type": "search",
"definition": {"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"numPartitions": 1,
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

예시

검색

{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"latestDefinition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"latestDefinitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"name": "string",
"queryable": true,
"status": "DELETING",
"statusDetail": [{"hostname": "string",
"mainIndex": {"definition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
},
"queryable": true,
"stagedIndex": {"definition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
},
"status": "DELETING"
}
],
"type": "search",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
}

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

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

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 하나 이상의 Atlas Search 인덱스가 있는 컬렉션을 포함하는 클러스터의 이름입니다.
collectionName 필수	문자열 하나 이상의 Atlas Search 인덱스가 포함된 컬렉션의 이름입니다.
databaseName 필수	문자열 1개 이상의 Atlas Search 인덱스가 있는 컬렉션이 포함된 데이터베이스를 식별하는 레이블입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

[{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"latestDefinition": {"numPartitions": 1
},
"latestDefinitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"name": "string",
"queryable": true,
"status": "DELETING",
"statusDetail": [{"hostname": "string",
"mainIndex": {"definition": {"numPartitions": 1
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING"
},
"queryable": true,
"stagedIndex": {"definition": {"numPartitions": 1
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING"
},
"status": "DELETING"
}
],
"type": "search"
}
]

이름으로 1개의 Atlas Search 인덱스 제거

데이터베이스, 컬렉션 및 name 으로 식별한 하나의 Atlas Search 인덱스 제거합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 데이터 액세스 관리자 역할 있어야 합니다. 이 삭제는 궁극적으로 일관적인 됩니다.

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 하나 이상의 애플리케이션 검색 인덱스가 있는 데이터베이스 및 컬렉션을 포함하는 클러스터의 이름입니다.
collectionName 필수	문자열 하나 이상의 Atlas Search 인덱스가 포함된 컬렉션의 이름입니다.
databaseName 필수	문자열 1개 이상의 Atlas Search 인덱스가 있는 컬렉션이 포함된 데이터베이스를 식별하는 레이블입니다.
indexName 필수	문자열 삭제할 Atlas Search 인덱스의 이름입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

400
401
403
404
500

콘텐츠 유형

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 인덱스 에는 인덱싱된 필드와 인덱스 생성하는 데 사용된 분석기가 포함되어 있습니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 데이터 액세스 읽기 쓰기 역할 있어야 합니다.

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 하나 이상의 Atlas Search 인덱스가 있는 컬렉션을 포함하는 클러스터의 이름입니다.
collectionName 필수	문자열 하나 이상의 Atlas Search 인덱스가 포함된 컬렉션의 이름입니다.
databaseName 필수	문자열 1개 이상의 Atlas Search 인덱스가 있는 컬렉션이 포함된 데이터베이스를 식별하는 레이블입니다.
indexName 필수	문자열 반환할 Atlas Search 인덱스의 이름입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

예시

검색

{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"latestDefinition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"latestDefinitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"name": "string",
"queryable": true,
"status": "DELETING",
"statusDetail": [{"hostname": "string",
"mainIndex": {"definition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
},
"queryable": true,
"stagedIndex": {"definition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
},
"status": "DELETING"
}
],
"type": "search",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
}

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

데이터베이스, 컬렉션 이름, 인덱스 이름으로 식별한 하나의 Atlas Search 인덱스 업데이트합니다. Atlas Search 인덱스는 인덱스 생성할 필드와 인덱스 생성할 때 사용할 분석기를 정의합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 데이터 액세스 관리자 역할 있어야 합니다.

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ Atlas Search 인덱스를 업데이트할 컬렉션이 포함된 클러스터의 이름입니다.
collectionName 필수	문자열 하나 이상의 Atlas Search 인덱스가 포함된 컬렉션의 이름입니다.
databaseName 필수	문자열 1개 이상의 Atlas Search 인덱스가 있는 컬렉션이 포함된 데이터베이스를 식별하는 레이블입니다.
indexName 필수	문자열 업데이트할 Atlas Search 인덱스의 이름입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-05-30+json

Atlas Search 인덱스를 업데이트할 세부 정보입니다.

필수	텍스트 검색 인덱스 정의(객체) 또는 벡터 검색 인덱스 정의(객체) 검색 인덱스를 업데이트할 인덱스 정의입니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"definition": {"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"numPartitions": 1,
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

예시

검색

{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"latestDefinition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"latestDefinitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"name": "string",
"queryable": true,
"status": "DELETING",
"statusDetail": [{"hostname": "string",
"mainIndex": {"definition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
},
"queryable": true,
"stagedIndex": {"definition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
},
"status": "DELETING"
}
],
"type": "search",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
}

ID로 1개의 Atlas Search 인덱스 제거

고유 ID 로 식별한 하나의 Atlas Search 인덱스 제거합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 데이터 액세스 관리자 역할 있어야 합니다. 이 삭제는 궁극적으로 일관적인 됩니다.

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 하나 이상의 애플리케이션 검색 인덱스가 있는 데이터베이스 및 컬렉션을 포함하는 클러스터의 이름입니다.
indexId 필수	문자열^([a-f0-9]{24})$ Atlas cluster를 식별하는 고유한 24자리 16진수 문자열입니다. 컬렉션에 대한 모든 Atlas Search 인덱스 가져오기 API 엔드포인트를 사용하여 모든 Atlas Search 인덱스의 ID를 찾을 수 있습니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

400
401
403
404
500

콘텐츠 유형

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개의 Atlas Search 인덱스 반환

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

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 하나 이상의 Atlas Search 인덱스가 있는 컬렉션을 포함하는 클러스터의 이름입니다.
indexId 필수	문자열^([a-f0-9]{24})$ Application Search 인덱스를 식별하는 고유한 24진수 문자열입니다. 컬렉션에 대한 모든 애플리케이션 검색 인덱스 가져오기 API 엔드포인트를 사용하여 모든 애플리케이션 검색 인덱스의 ID를 찾을 수 있습니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

예시

검색

{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"latestDefinition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"latestDefinitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"name": "string",
"queryable": true,
"status": "DELETING",
"statusDetail": [{"hostname": "string",
"mainIndex": {"definition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
},
"queryable": true,
"stagedIndex": {"definition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
},
"status": "DELETING"
}
],
"type": "search",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
}

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

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

Atlas search 인덱스

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ Atlas Search 인덱스를 업데이트할 컬렉션이 포함된 클러스터의 이름입니다.
indexId 필수	문자열^([a-f0-9]{24})$ 아틀라스 검색 인덱스를 식별하는 고유한 24자리 16진수 문자열입니다. 컬렉션에 대한 모든 Atlas Search 인덱스 가져오기 API 엔드포인트를 사용하여 모든 Atlas Search 인덱스의 ID를 찾을 수 있습니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-05-30+json

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

필수	텍스트 검색 인덱스 정의(객체) 또는 벡터 검색 인덱스 정의(객체) 검색 인덱스를 업데이트할 인덱스 정의입니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"definition": {"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"numPartitions": 1,
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
}
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

예시

검색

{"collectionName": "string",
"database": "string",
"indexID": "32b6e34b3d91647abb20e7b8",
"latestDefinition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"latestDefinitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"name": "string",
"queryable": true,
"status": "DELETING",
"statusDetail": [{"hostname": "string",
"mainIndex": {"definition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
},
"queryable": true,
"stagedIndex": {"definition": {"numPartitions": 1,
"analyzer": "lucene.standard",
"analyzers": [{"charFilters": [{"property1": { },
"property2": { }
}
],
"name": "string",
"tokenFilters": [{"property1": { },
"property2": { }
}
],
"tokenizer": {"property1": { },
"property2": { }
}
}
],
"mappings": {"dynamic": true,
"fields": {"property1": { },
"property2": { }
}
},
"searchAnalyzer": "lucene.standard",
"storedSource": {"include | exclude": ["field1",
"field2"
]
},
"synonyms": [{"analyzer": "lucene.standard",
"name": "string",
"source": {"collection": "string"
}
}
]
},
"definitionVersion": {"createdAt": "2019-08-24T14:15:22Z",
"version": 0
},
"message": "string",
"queryable": true,
"status": "DELETING",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
},
"status": "DELETING"
}
],
"type": "search",
"synonymMappingStatus": "FAILED",
"synonymMappingStatusDetail": [{"property1": {"message": "string",
"queryable": true,
"status": "FAILED"
},
"property2": {"message": "string",
"queryable": true,
"status": "FAILED"
}
}
]
}

Auditing

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

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"auditAuthorizationSuccess": false,
"auditFilter": "string",
"configurationType": "NONE",
"enabled": false
}

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

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

auditAuthorizationSuccess	부울 기본값입니다: 거짓 성공적인 인증을 추적하기 위해 누군가 감사를 설정했는지 여부를 나타내는 플래그입니다. 이는 `"atype" : "authCheck"` 감사 필터에만 적용됩니다. 이 매개 변수를 `true` 로 설정하면 클러스터 성능이 저하됩니다. 시스템 감사 메시지
auditFilter	문자열 기록할 이벤트를 지정하는 JSON 문서입니다. 작은 따옴표나 큰 따옴표와 같이 구문 분석을 방해할 수 있는 모든 문자는 백슬래시 (`\`) 를 사용하여 이스케이프 처리합니다. 사용자 지정 감사 필터
활성화됨	부울 기본값입니다: 거짓 누군가가 지정된 프로젝트에 대해 데이터베이스 감사를 활성화했는지 여부를 나타내는 플래그입니다.

응답

샘플 요청

Payload

콘텐츠 유형

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

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"enabled": true
}

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

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

활성화됨

필수

부울

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

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

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"enabled": true
}

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"enabled": true
}

클라우드 백업

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

모든 스냅샷 내보내기 버킷 반환

지정된 프로젝트와 연결된 모든 내보내기 버킷을 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"_id": "32b6e34b3d91647abb20e7b8",
"bucketName": "export-bucket",
"cloudProvider": "AWS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}
],
"totalCount": 0
}

1개의 스냅샷 내보내기 버킷 만들기

AWS S3 버킷, Azure Blob Storage 컨테이너 또는 Google Cloud Storage 버킷에 대한 스냅샷 내보내기 버킷을 만듭니다. 생성된 스냅샷은 내보내기 버킷 및 참조된 AWS S3 버킷, Azure Blob Storage 컨테이너 또는 Google Cloud Storage 버킷으로 내보낼 수 있습니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-05-30+json

내보내기 버킷이 참조해야 하는 역할 과 AWS S3 버킷, Azure Blob Storage 컨테이너 또는 Google Cloud Storage 버킷을 지정합니다.

cloudProvider 필수	문자열 스냅샷 을 내보내는 cloud 제공자 를 식별하는 사람이 읽을 수 있는 레이블입니다. AWS
bucketName 필수	문자열 [3 ... 63 ] 문자 역할 에 내보내기 권한이 부여된 AWS S3 버킷을 식별하는 사람이 읽을 수 있는 레이블입니다.
iamRoleId 필수	문자열^([a-f0-9]{24})$ MongoDB Cloud가 AWS S3 버킷에 액세스하는 데 사용하는 통합 AWS 액세스 역할 ID를 식별하는 고유한 24자리 16진수 문자열입니다. 통합 AWS 액세스 역할 ID

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

예시

AWS

{"bucketName": "export-bucket",
"cloudProvider": "AWS",
"iamRoleId": "668c5f0ed436263134491592"
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

예시

AWS

{"_id": "32b6e34b3d91647abb20e7b8",
"bucketName": "export-bucket",
"cloudProvider": "AWS",
"iamRoleId": "668c5f0ed436263134491592",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}

1개의 스냅샷 내보내기 버킷 삭제

내보내기 버킷을 삭제합니다. 액세스 취소하기 전에 이 내보내기 버킷으로 내보내는 이 프로젝트의 모든 클러스터에서 자동 내보내기를 비활성화해야 합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 백업 관리자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

exportBucketId

필수

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

예시: 32b6e34b3d91647abb20e7b8

고유한 24자리 16진수 문자열로 내보내기 버킷을 식별합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

응답

응답 샘플

400
401
403
404
500

콘텐츠 유형

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 키에 프로젝트 읽기 전용 역할 있어야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

exportBucketId

필수

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

예시: 32b6e34b3d91647abb20e7b8

고유한 24자리 16진수 문자열로 내보내기 버킷을 식별합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

예시

AWS

{"_id": "32b6e34b3d91647abb20e7b8",
"bucketName": "export-bucket",
"cloudProvider": "AWS",
"iamRoleId": "668c5f0ed436263134491592",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}

백업 컴플라이언스 정책 설정 비활성화

지정된 프로젝트 의 백업 컴플라이언스 정책 설정을 비활성화합니다. 전제 조건으로 https://www.mongodb.com/ko-kr/docs/atlas/백업/cloud-backup/backup-compliance-policy/ 의 지침에 따라 지원 티켓 먼저 파일 해야 합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

400
401
403
404
500

콘텐츠 유형

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 키에 프로젝트 소유자 역할 있어야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-10-01+json

{"authorizedEmail": "user@example.com",
"authorizedUserFirstName": "string",
"authorizedUserLastName": "string",
"copyProtectionEnabled": false,
"deletable": false,
"encryptionAtRestEnabled": false,
"onDemandPolicyItem": {"frequencyInterval": 0,
"frequencyType": "ondemand",
"id": "32b6e34b3d91647abb20e7b8",
"retentionUnit": "days",
"retentionValue": 0
},
"pitEnabled": false,
"projectId": "32b6e34b3d91647abb20e7b8",
"restoreWindowDays": 0,
"scheduledPolicyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"id": "32b6e34b3d91647abb20e7b8",
"retentionUnit": "days",
"retentionValue": 0
}
],
"state": "ACTIVE",
"updatedDate": "2019-08-24T14:15:22Z",
"updatedUser": "user@example.com"
}

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

지정된 프로젝트 에 대한 백업 컴플라이언스 정책 설정을 업데이트합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
overwriteBackupPolicies	부울 기본값입니다: true 비준수 백업 정책을 새 데이터 보호 설정으로 덮어쓸지 여부를 나타내는 플래그입니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint

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

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

authorizedEmail 필수	문자열 <email> 백업 컴플라이언스 정책 설정 업데이트 권한을 부여한 사용자의 이메일 주소.
authorizedUserFirstName 필수	문자열 백업 컴플라이언스 정책 설정 업데이트 권한을 부여한 사용자의 이름.
authorizedUserLastName 필수	문자열 백업 컴플라이언스 정책 설정 업데이트 권한을 부여한 사용자의 성.
copyProtectionEnabled	부울 기본값입니다: 거짓 추가 스냅샷 리전이 제거되더라도 클러스터 사용자가 다른 리전으로 복사된 백업을 삭제할 수 없도록 할지 여부를 나타내는 플래그. 지정하지 않으면 이 값에는 기본값 false가 사용됩니다.
encryptionAtRestEnabled	부울 기본값입니다: 거짓 백업 컴플라이언스 정책이 있는 모든 클러스터에 고객 키 관리를 사용한 저장 시 암호화가 필요한지 여부를 나타내는 플래그. 지정하지 않으면 이 값에는 기본값 false가 사용됩니다. 고객 키 관리를 사용한 미사용 암호화
	객체 (BackupComplianceOnDemandPolicyItem) 온디맨드 정책에 대한 사양.
pitEnabled	부울 기본값입니다: 거짓 클러스터가 백업 컴플라이언스 정책과 함께 지속적 클라우드 백업을 사용하는지 여부를 나타내는 플래그. 지정하지 않으면 이 값에는 기본값 false가 사용됩니다. 지속적인 클라우드 백업
projectId	문자열^([a-f0-9]{24})$ 백업 컴플라이언스 정책에 대한 프로젝트를 식별하는 고유한 24자리 16진수 문자열.
restoreWindowDays	integer <int32> 백업 컴플라이언스 정책이 적용된 지속적 클라우드 백업으로 복원할 수 있는 이전 날짜 수. 0이 아닌 양의 정수를 지정해야 하며 최대 보존 기간은 시간당 보존 시간을 초과할 수 없습니다. 이 매개 변수는 백업 컴플라이언스 정책이 적용되는 지속적 클라우드 백업에만 적용됩니다.
	의 배열 객체 (BackupComplianceScheduledPolicyItem) 예약된 하나의 정책에 대한 사양이 포함된 목록.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-10-01+json

{"authorizedEmail": "user@example.com",
"authorizedUserFirstName": "string",
"authorizedUserLastName": "string",
"copyProtectionEnabled": false,
"encryptionAtRestEnabled": false,
"onDemandPolicyItem": {"frequencyInterval": 0,
"frequencyType": "ondemand",
"retentionUnit": "days",
"retentionValue": 0
},
"pitEnabled": false,
"projectId": "32b6e34b3d91647abb20e7b8",
"restoreWindowDays": 0,
"scheduledPolicyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"retentionUnit": "days",
"retentionValue": 0
}
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-10-01+json

{"authorizedEmail": "user@example.com",
"authorizedUserFirstName": "string",
"authorizedUserLastName": "string",
"copyProtectionEnabled": false,
"deletable": false,
"encryptionAtRestEnabled": false,
"onDemandPolicyItem": {"frequencyInterval": 0,
"frequencyType": "ondemand",
"id": "32b6e34b3d91647abb20e7b8",
"retentionUnit": "days",
"retentionValue": 0
},
"pitEnabled": false,
"projectId": "32b6e34b3d91647abb20e7b8",
"restoreWindowDays": 0,
"scheduledPolicyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"id": "32b6e34b3d91647abb20e7b8",
"retentionUnit": "days",
"retentionValue": 0
}
],
"state": "ACTIVE",
"updatedDate": "2019-08-24T14:15:22Z",
"updatedUser": "user@example.com"
}

모든 스냅샷 내보내기 작업 반환

지정된 Atlas cluster 와 연결된 모든 클라우드 백업 스냅샷 내보내기 작업을 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 Atlas 관리자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"components": [{"exportId": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"customData": [{"key": "string",
"value": "string"
}
],
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"exportStatus": {"exportedCollections": 0,
"totalCollections": 0
},
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"prefix": "string",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"state": "Cancelled",
"stateReason": {"errorCode": "string",
"message": "string"
}
}
],
"totalCount": 0
}

1개의 스냅샷 내보내기 작업 만들기

클라우드 백업을 사용하여 전용 Atlas cluster 의 백업 스냅샷 하나를 내보내기 버킷으로 내보냅니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 Atlas 관리자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

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

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

	의 배열 객체 (BackupLabel) 내보내기 작업이 완료되면 MongoDB Cloud가 버킷에 업로드하는 메타데이터 파일에 추가할 사용자 지정 데이터를 나타내는 키-값 쌍 컬렉션.
exportBucketId 필수	문자열^([a-f0-9]{24})$ 고유한 24자리 16진수 문자열로 내보내기 버킷을 식별합니다.
snapshotId 필수	문자열^([a-f0-9]{24})$ 내보낼 내보내기 버킷 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"customData": [{"key": "string",
"value": "string"
}
],
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"snapshotId": "32b6e34b3d91647abb20e7b8"
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"components": [{"exportId": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"customData": [{"key": "string",
"value": "string"
}
],
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"exportStatus": {"exportedCollections": 0,
"totalCollections": 0
},
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"prefix": "string",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"state": "Cancelled",
"stateReason": {"errorCode": "string",
"message": "string"
}
}

1개의 스냅샷 내보내기 작업 반환

지정된 Atlas cluster 와 연결된 클라우드 백업 스냅샷 내보내기 작업 한 개를 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 Atlas 관리자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
exportId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 24고유한 -내보내기 string 작업을 식별하는 16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"components": [{"exportId": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"customData": [{"key": "string",
"value": "string"
}
],
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"exportStatus": {"exportedCollections": 0,
"totalCollections": 0
},
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"prefix": "string",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"state": "Cancelled",
"stateReason": {"errorCode": "string",
"message": "string"
}
}

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"cancelled": true,
"components": [{"downloadUrl": "string",
"privateDownloadDeliveryUrls": [{"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"replicaSetName": "string"
}
],
"deliveryType": "automated",
"deliveryUrl": ["string"
],
"desiredTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"failed": true,
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"privateDownloadDeliveryUrls": [{"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

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

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

이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 백업 관리자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: 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	문자열^([a-f0-9]{24})$ 스냅샷을 식별하는 고유한 24자리 16진수 문자열.
targetClusterName	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 복원 작업이 스냅샷을 복원하는 대상 클러스터를 식별하는 인간 판독 가능 레이블. 리소스는 `"deliveryType":` `"automated"`일 때 이 매개 변수를 반환합니다. `automated` 및 `pointInTime` 복원 유형에 필요합니다.
targetGroupId	문자열^([a-f0-9]{24})$ 지정된 targetClusterName에 대한 대상 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. `automated` 및 `pointInTime` 복원 유형에 필요합니다.

응답

샘플 요청

Payload

콘텐츠 유형

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": [{"downloadUrl": "string",
"privateDownloadDeliveryUrls": [{"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"replicaSetName": "string"
}
],
"deliveryType": "automated",
"deliveryUrl": ["string"
],
"desiredTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"failed": true,
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"privateDownloadDeliveryUrls": [{"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2019-08-24T14:15:22Z"
}

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

지정된 프로젝트 에서 한 클러스터 의 cloud 백업 복원 작업 한 개를 취소합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 백업 관리자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
restoreJobId 필수	문자열^([a-f0-9]{24})$ 제거할 복원 작업을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

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개의 복원 작업 반환

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 반환하려는 복원 작업이 포함된 클러스터를 식별하는 인간 판독 가능 레이블.
restoreJobId 필수	문자열^([a-f0-9]{24})$ 반환할 복원 작업을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"cancelled": true,
"components": [{"downloadUrl": "string",
"privateDownloadDeliveryUrls": [{"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"replicaSetName": "string"
}
],
"deliveryType": "automated",
"deliveryUrl": ["string"
],
"desiredTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"failed": true,
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"privateDownloadDeliveryUrls": [{"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2019-08-24T14:15:22Z"
}

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

지정된 클러스터 에 대한 모든 cloud 백업 일정을 제거합니다. 이 예정 MongoDB Cloud가 예약된 스냅샷을 생성하는 시기와 해당 스냅샷을 저장하는 기간을 정의합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 Atlas 관리자 역할 있어야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-08-05+json

{"autoExportEnabled": true,
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"copySettings": [{"cloudProvider": "AWS",
"frequencies": ["HOURLY"
],
"regionName": "string",
"shouldCopyOplogs": true,
"zoneId": "32b6e34b3d91647abb20e7b8"
}
],
"export": {"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [{"frequencyType": "HOURLY",
"retentionDays": 0
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"nextSnapshot": "2019-08-24T14:15:22Z",
"policies": [{"id": "32b6e34b3d91647abb20e7b8",
"policyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"id": "32b6e34b3d91647abb20e7b8",
"retentionUnit": "days",
"retentionValue": 0
}
]
}
],
"referenceHourOfDay": 0,
"referenceMinuteOfHour": 0,
"restoreWindowDays": 0,
"useOrgAndGroupNamesInExportPrefix": true
}

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

지정된 프로젝트 내에서 지정된 클러스터에 대한 cloud 백업 예정 반환합니다. 이 예정 MongoDB Cloud가 예약된 스냅샷을 생성하는 시기와 해당 스냅샷을 저장하는 기간을 정의합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2024-08-05+json

{"autoExportEnabled": true,
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"copySettings": [{"cloudProvider": "AWS",
"frequencies": ["HOURLY"
],
"regionName": "string",
"shouldCopyOplogs": true,
"zoneId": "32b6e34b3d91647abb20e7b8"
}
],
"export": {"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [{"frequencyType": "HOURLY",
"retentionDays": 0
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"nextSnapshot": "2019-08-24T14:15:22Z",
"policies": [{"id": "32b6e34b3d91647abb20e7b8",
"policyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"id": "32b6e34b3d91647abb20e7b8",
"retentionUnit": "days",
"retentionValue": 0
}
]
}
],
"referenceHourOfDay": 0,
"referenceMinuteOfHour": 0,
"restoreWindowDays": 0,
"useOrgAndGroupNamesInExportPrefix": true
}

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

지정된 프로젝트 내 클러스터 한 개에 대한 cloud 백업 예정 업데이트합니다. 이 예정 MongoDB Cloud가 예약된 스냅샷을 생성하는 시기와 해당 스냅샷을 저장하는 기간을 정의합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-08-05+json

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

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

autoExportEnabled	부울 MongoDB Cloud가 클라우드 백업 스냅샷을 내보내기 버킷으로 자동으로 내보낼지 여부를 나타내는 플래그.
	의 배열 객체 (DiskBackupCopySetting20240805) 원하는 백업 정책의 복사 설정 항목별 문서가 포함된 목록.
	의 배열 객체 (DeleteCopiedBackups20240805) 삭제하려는 백업 복사본의 삭제된 각 복사본 설정에 대한 문서가 포함된 목록.
	객체 (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가 내보내기 버킷에 업로드하는 메타데이터 파일 경로에 조직 및 프로젝트 UUID 대신 조직 및 프로젝트 이름을 사용할지 여부를 나타내는 플래그입니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-08-05+json

{"autoExportEnabled": true,
"copySettings": [{"cloudProvider": "AWS",
"frequencies": ["HOURLY"
],
"regionName": "string",
"shouldCopyOplogs": true,
"zoneId": "32b6e34b3d91647abb20e7b8"
}
],
"deleteCopiedBackups": [{"cloudProvider": "AWS",
"regionName": "string",
"zoneId": "32b6e34b3d91647abb20e7b8"
}
],
"export": {"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [{"frequencyType": "HOURLY",
"retentionDays": 0
}
],
"policies": [{"id": "32b6e34b3d91647abb20e7b8",
"policyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"retentionUnit": "days",
"retentionValue": 0
}
]
}
],
"referenceHourOfDay": 0,
"referenceMinuteOfHour": 0,
"restoreWindowDays": 0,
"updateSnapshots": true,
"useOrgAndGroupNamesInExportPrefix": true
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-08-05+json

{"autoExportEnabled": true,
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"copySettings": [{"cloudProvider": "AWS",
"frequencies": ["HOURLY"
],
"regionName": "string",
"shouldCopyOplogs": true,
"zoneId": "32b6e34b3d91647abb20e7b8"
}
],
"export": {"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [{"frequencyType": "HOURLY",
"retentionDays": 0
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"nextSnapshot": "2019-08-24T14:15:22Z",
"policies": [{"id": "32b6e34b3d91647abb20e7b8",
"policyItems": [{"frequencyInterval": 1,
"frequencyType": "daily",
"id": "32b6e34b3d91647abb20e7b8",
"retentionUnit": "days",
"retentionValue": 0
}
]
}
],
"referenceHourOfDay": 0,
"referenceMinuteOfHour": 0,
"restoreWindowDays": 0,
"useOrgAndGroupNamesInExportPrefix": true
}

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"cloudProvider": "AWS",
"copyRegions": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"replicaSetName": "string",
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}
],
"totalCount": 0
}

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

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

이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 백업 관리자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

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

description	문자열 스냅샷의 목적을 설명하는 인간 판독 가능 문구 또는 문장입니다. 리소스는 `"status" : "onDemand"`일 때 이 매개 변수를 반환합니다.
retentionInDays	integer <int32> >= 1 MongoDB Cloud가 주문형 스냅샷을 보관할 일수입니다. 1 이상이어야 합니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"description": "string",
"retentionInDays": 1
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

복제본 세트

{"cloudProvider": "AWS",
"copyRegions": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"replicaSetName": "string",
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
snapshotId 필수	문자열^([a-f0-9]{24})$ 원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

401
403
404
500

콘텐츠 유형

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개의 샤딩된 클러스터 클라우드 백업 반환

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
snapshotId 필수	문자열^([a-f0-9]{24})$ 원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

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": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"members": [{"cloudProvider": "AWS",
"id": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "string"
}
],
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"snapshotIds": ["32b6e34b3d91647abb20e7b8"
],
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}

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

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

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"configServerType": "EMBEDDED",
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"members": [{"cloudProvider": "AWS",
"id": "32b6e34b3d91647abb20e7b8",
"replicaSetName": "string"
}
],
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"snapshotIds": ["32b6e34b3d91647abb20e7b8"
],
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}
],
"totalCount": 0
}

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

지정된 스냅샷 제거합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 백업 관리자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
snapshotId 필수	문자열^([a-f0-9]{24})$ 원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

400
401
403
404
500

콘텐츠 유형

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 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
snapshotId 필수	문자열^([a-f0-9]{24})$ 원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"cloudProvider": "AWS",
"copyRegions": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"replicaSetName": "string",
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}

1개의 클라우드 백업에 대해 만료일 변경

지정된 프로젝트 의 한 클러스터 에 대한 cloud 백업 스냅샷 하나의 만료 날짜를 변경합니다. 요청하는 서비스 계정 또는 API 키에는 프로젝트 백업 관리자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
snapshotId 필수	문자열^([a-f0-9]{24})$ 원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

지정된 프로젝트의 한 클러스터에 대한 클라우드 백업 스냅샷 하나의 만료 날짜를 변경합니다.

retentionUnit

필수

문자열

열거형: "DAYS" "WEEKS" "MONTHS" "YEARS"

MongoDB Cloud가 스냅샷 보존을 측정하는 시간입니다.

retentionValue

필수

integer <int32>

MongoDB Cloud가 스냅샷을 보존하는 일, 주 월, 또는 년의 수를 나타내는 숫자. 사용 빈도가 낮은 정책 항목의 경우, MongoDB Cloud에서는 사용 빈도가 높은 정책 항목에 지정된 값 이상의 값을 지정해야 합니다. 시간별 정책 항목에서 2일간 보존하도록 지정한 경우 주간 정책 항목의 보존에 2일 이상을 지정하세요.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"retentionUnit": "DAYS",
"retentionValue": 5
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"cloudProvider": "AWS",
"copyRegions": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
"mongodVersion": "string",
"policyItems": ["32b6e34b3d91647abb20e7b8"
],
"replicaSetName": "string",
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0,
"type": "replicaSet"
}

1개의 서버리스 인스턴스에 대해 모든 복원 작업 반환

지정된 프로젝트 에서 하나의 서버리스 인스턴스 에 대한 모든 복원 작업을 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다.

이 API는 createServerlessInstance 엔드포인트로 생성된 Flex 클러스터 또는 서버리스 인스턴스에서 마이그레이션된 Flex 클러스터에서도 사용할 수 있습니다. 이 엔드포인트는 2026년 1월에 종료될 예정입니다. 대신 listFlexBackupRestoreJobs 엔드포인트를 사용하세요.

listFlexBackupRestoreJobs

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"cancelled": true,
"deliveryType": "automated",
"deliveryUrl": ["string"
],
"desiredTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"failed": true,
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"totalCount": 0
}

1개의 서버리스 인스턴스에서 1개의 스냅샷 복원

지정된 프로젝트 에서 하나의 서버리스 인스턴스 의 스냅샷 하나를 복원합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다.

이 API는 createServerlessInstance 엔드포인트로 생성된 Flex 클러스터 또는 서버리스 인스턴스에서 마이그레이션된 Flex 클러스터에서도 사용할 수 있습니다. 이 엔드포인트는 2026년 1월에 종료될 예정입니다. 대신 createFlexBackupRestoreJob 엔드포인트를 사용하세요.

createFlexBackupRestoreJob

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

복원하려는 스냅샷이 있는 서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: 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	문자열^([a-f0-9]{24})$ 스냅샷을 식별하는 고유한 24자리 16진수 문자열.
targetClusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 복원 작업이 스냅샷을 복원하는 대상 클러스터를 식별하는 인간 판독 가능 레이블. 리소스는 `"deliveryType":` `"automated"`일 때 이 매개 변수를 반환합니다.
targetGroupId 필수	문자열^([a-f0-9]{24})$ 지정된 targetClusterName에 대한 대상 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다.

응답

샘플 요청

Payload

콘텐츠 유형

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": ["string"
],
"desiredTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"failed": true,
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2019-08-24T14:15:22Z"
}

1개의 서버리스 인스턴스에 대해 1개의 복원 작업 반환

지정된 프로젝트 에서 하나의 서버리스 인스턴스 에 대한 복원 작업 하나를 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다.

이 API는 createServerlessInstance 엔드포인트로 생성된 Flex 클러스터 또는 서버리스 인스턴스에서 마이그레이션된 Flex 클러스터에서도 사용할 수 있습니다. 이 엔드포인트는 2026년 1월에 종료될 예정입니다. 대신 getFlexBackupRestoreJob 엔드포인트를 사용하세요.

getFlexBackupRestoreJob

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.
restoreJobId 필수	문자열^([a-f0-9]{24})$ 반환할 복원 작업을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"cancelled": true,
"deliveryType": "automated",
"deliveryUrl": ["string"
],
"desiredTimestamp": {"date": "2019-08-24T14:15:22Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"failed": true,
"finishedAt": "2019-08-24T14:15:22Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 1199145600,
"pointInTimeUTCSeconds": 1199145600,
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2019-08-24T14:15:22Z"
}

1개의 서버리스 인스턴스의 모든 스냅샷 반환

지정된 프로젝트 에서 하나의 서버리스 인스턴스 의 모든 스냅샷을 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다.

이 API는 createServerlessInstance 엔드포인트로 생성된 Flex 클러스터 또는 서버리스 인스턴스에서 마이그레이션된 Flex 클러스터에서도 사용할 수 있습니다. 이 엔드포인트는 2026년 1월에 종료될 예정입니다. 대신 listFlexBackups 엔드포인트를 사용하세요.

listFlexBackups

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"frequencyType": "hourly",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongodVersion": "string",
"serverlessInstanceName": "string",
"snapshotType": "onDemand",
"status": "queued",
"storageSizeBytes": 0
}
],
"totalCount": 0
}

1개의 서버리스 인스턴스에서 1개의 스냅샷 반환

지정된 프로젝트 에서 하나의 서버리스 인스턴스 의 스냅샷 하나를 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다.

이 엔드포인트는 createServerlessInstance API로 생성된 Flex 클러스터 또는 서버리스 인스턴스에서 마이그레이션된 Flex 클러스터에서도 사용할 수 있습니다. 이 엔드포인트는 2026년 1월에 종료될 예정입니다. 대신 getFlexBackup 엔드포인트를 사용하세요.

getFlexBackup

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.
snapshotId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

애플리케이션이 응답을 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": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"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 컬렉션을 건너뜁니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

마이그레이션 유효성 검사

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-05-30+json

생성되는 마이그레이션 하나.

필수	객체 (Destination) 마이그레이션 대상을 설명하는 문서.
dropDestinationData	부울 기본값입니다: 거짓 마이그레이션이 시작되기 전에 마이그레이션 프로세스가 대상 클러스터에서 모든 컬렉션을 제거하는지 여부를 나타내는 플래그.
migrationHosts	의 배열 strings = 1개 항목 이 마이그레이션에 사용된 마이그레이션 호스트 목록.
	객체 (ShardingRequest) MongoDB 6.0 이상에서 복제본 세트 소스에서 샤딩된 클러스터 대상으로 마이그레이션할 때 대상 클러스터에서 수행하는 샤딩을 구성하는 문서. 대상 클러스터의 컬렉션을 샤딩하지 않으려면 이 항목을 비워 두세요.
필수	객체 (Source) 마이그레이션의 출처를 설명하는 문서.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"destination": {"clusterName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnameSchemaType": "PUBLIC",
"privateLinkId": "string"
},
"dropDestinationData": false,
"migrationHosts": ["vm001.example.com"
],
"sharding": {"createSupportingIndexes": true,
"shardingEntries": [{"collection": "string",
"database": "string",
"shardCollection": {"key": [{"property1": { },
"property2": { }
}
]
}
}
]
},
"source": {"caCertificatePath": "string",
"clusterName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"managedAuthentication": true,
"password": "string",
"ssl": true,
"username": "string"
}
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"_id": "32b6e34b3d91647abb20e7b8",
"lagTimeSeconds": 0,
"migrationHosts": ["vm001.example.com"
],
"readyForCutover": true,
"status": "NEW"
}

1개의 마이그레이션 요청 확인

제공된 자격 증명, 사용 가능한 디스크 공간, MongoDB 버전 등이 마이그레이션 요청의 요구 사항을 충족하는지 확인합니다. 검사를 통과하면 마이그레이션을 수행할 수 있습니다. 이 리소스를 성공적으로 호출하려면 API 키에 조직 소유자 역할이 있어야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-05-30+json

검증되는 마이그레이션 하나.

필수	객체 (Destination) 마이그레이션 대상을 설명하는 문서.
dropDestinationData	부울 기본값입니다: 거짓 마이그레이션이 시작되기 전에 마이그레이션 프로세스가 대상 클러스터에서 모든 컬렉션을 제거하는지 여부를 나타내는 플래그.
migrationHosts	의 배열 strings = 1개 항목 이 마이그레이션에 사용된 마이그레이션 호스트 목록.
	객체 (ShardingRequest) MongoDB 6.0 이상에서 복제본 세트 소스에서 샤딩된 클러스터 대상으로 마이그레이션할 때 대상 클러스터에서 수행하는 샤딩을 구성하는 문서. 대상 클러스터의 컬렉션을 샤딩하지 않으려면 이 항목을 비워 두세요.
필수	객체 (Source) 마이그레이션의 출처를 설명하는 문서.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"destination": {"clusterName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnameSchemaType": "PUBLIC",
"privateLinkId": "string"
},
"dropDestinationData": false,
"migrationHosts": ["vm001.example.com"
],
"sharding": {"createSupportingIndexes": true,
"shardingEntries": [{"collection": "string",
"database": "string",
"shardCollection": {"key": [{"property1": { },
"property2": { }
}
]
}
}
]
},
"source": {"caCertificatePath": "string",
"clusterName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"managedAuthentication": true,
"password": "string",
"ssl": true,
"username": "string"
}
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"_id": "32b6e34b3d91647abb20e7b8",
"errorMessage": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"sourceGroupId": "32b6e34b3d91647abb20e7b8",
"status": "PENDING"
}

1개의 마이그레이션 유효성 검사 작업 반환

마이그레이션 유효성 검사 작업 하나의 상태를 반환합니다. 이 리소스를 성공적으로 호출하려면 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

validationId

필수

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

예시: 507f1f77bcf86cd799439011

유효성 검사 작업을 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

애플리케이션이 응답을 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

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

liveMigrationId

필수

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

예시: 6296fb4c7c7aa997cf94e9a8

마이그레이션을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"_id": "32b6e34b3d91647abb20e7b8",
"lagTimeSeconds": 0,
"migrationHosts": ["vm001.example.com"
],
"readyForCutover": true,
"status": "NEW"
}

마이그레이션된 클러스터 전환

마이그레이션된 클러스터를 MongoDB Atlas로 전환합니다. 전환이 완료되면 확인합니다. 전환이 완료되면 MongoDB Atlas가 실시간 마이그레이션 프로세스를 완료하고 소스 클러스터와의 동기화를 중지합니다. 이 리소스를 성공적으로 호출하려면 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

liveMigrationId

필수

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

예시: 6296fb4c7c7aa997cf94e9a8

마이그레이션을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

400
401
403
404
500

콘텐츠 유형

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

필수

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

예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

[{"deployments": [{"agentVersion": "string",
"clusterId": "32b6e34b3d91647abb20e7b8",
"dbSizeBytes": 8192,
"featureCompatibilityVersion": "string",
"managed": true,
"mongoDBVersion": "string",
"name": "Project X sharded cluster",
"oplogSizeMB": 3,
"sharded": true,
"shardsSize": 3,
"tlsEnabled": true
}
],
"migrationHosts": ["string"
],
"name": "string",
"projectId": "32b6e34b3d91647abb20e7b8"
}
]

1개의 링크 토큰 제거

하나의 조직 링크와 조직과 관련된 공개 API 키를 제거합니다. MongoDB Atlas는 푸시 실시간 마이그레이션에만 링크 토큰을 사용합니다. 실시간 마이그레이션(푸시)으로 Cloud Manager 또는 Ops Manager에서 MongoDB Atlas로 데이터를 안전하게 푸시할 수 있습니다. 이 리소스를 성공적으로 호출하려면 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

orgId

필수

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

예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

응답

응답 샘플

400
401
403
404
500

콘텐츠 유형

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 Atlas는 푸시 실시간 마이그레이션에만 링크 토큰을 사용합니다. 실시간 마이그레이션(푸시)으로 Cloud Manager 또는 Ops Manager에서 MongoDB Atlas로 데이터를 안전하게 푸시할 수 있습니다. 이 리소스를 성공적으로 호출하려면 API 키에 조직 소유자 역할이 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

orgId

필수

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

예시: 4888442a3354817a7320eb61

프로젝트가 포함된 조직을 식별하는 고유한 24자리 16진수 문자열입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 검색합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

마이그레이션과 관련된 IP 주소 액세스 목록 항목.

accessListIps

의 배열 strings

API 키와 연결된 IP 주소 액세스 목록 항목.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"accessListIps": ["string"
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"linkToken": "string"
}

클라우드 제공자 액세스

Atlas에서 AWS IAM 역할을 반환, 추가, 권한 부여 및 제거합니다.

모든 클라우드 제공자 액세스 역할 반환

지정된 프로젝트 에 대한 액세스 있는 모든 cloud 제공자 액세스 역할을 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"awsIamRoles": [{"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": [{"featureType": "ATLAS_DATA_LAKE"
}
],
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
"roleId": "32b6e34b3d91647abb20e7b8"
}
],
"azureServicePrincipals": [{"providerName": "AWS",
"_id": "32b6e34b3d91647abb20e7b8",
"atlasAzureAppId": "fa987465-057e-40db-aba0-9f2d4cc5853c",
"createdDate": "2019-08-24T14:15:22Z",
"featureUsages": [{"featureType": "ATLAS_DATA_LAKE"
}
],
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"servicePrincipalId": "f25408bf-fda4-449e-87e7-67cf2d3e5615",
"tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
}
]
}

1개의 클라우드 제공자 액세스 역할 만들기

지정된 cloud 제공자 에 대해 하나의 액세스 역할 만듭니다. 일부 MongoDB Cloud 기능은 인증 에 이러한 cloud 제공자 액세스 역할을 사용합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다.

클라우드 공급자에 대한 액세스 설정

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

지정된 클라우드 공급자에 대해 하나의 역할을 생성합니다.

providerName

필수

문자열

역할의 클라우드 공급자를 식별하는 인간 판독 가능 레이블.

AWS

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

AWS

{"providerName": "AWS"
}

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

AWS

{"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": [{"featureType": "ATLAS_DATA_LAKE"
}
],
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
"roleId": "32b6e34b3d91647abb20e7b8"
}

1개의 클라우드 제공자 액세스 역할 인증 해제

지정된 액세스 역할 에 지정된 프로젝트 에 대한 액세스 취소합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
cloudProvider 필수	문자열 열거형: "A" "AZURE" "GCP" 인증 해제할 역할의 클라우드 공급자를 식별하는 인간 판독 가능 레이블.
roleId 필수	문자열^([a-f0-9]{24})$ 역할을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

400
401
403
404
500

콘텐츠 유형

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

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

roleId

필수

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

역할을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

AWS

{"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": [{"featureType": "ATLAS_DATA_LAKE"
}
],
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
"roleId": "32b6e34b3d91647abb20e7b8"
}

1개의 클라우드 제공자 액세스 역할에 권한 부여

지정된 액세스 역할 에 지정된 프로젝트 에 대한 액세스 부여합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다. 이 API 엔드포인트는 MongoDB Cloud 서비스에 대한 통합 액세스 생성하는 절차의 한 단계입니다. GCP 서비스 계정 액세스 에는 필요하지 않습니다.

클라우드 공급자에 대한 액세스 설정

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

roleId

필수

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

역할을 식별하는 고유한 24자리 16진수 문자열.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

지정된 액세스 역할에 지정된 프로젝트에 대한 액세스 권한을 부여합니다.

providerName 필수	문자열 역할의 클라우드 공급자를 식별하는 인간 판독 가능 레이블. AWS
iamAssumedRoleArn	문자열 [20 ... 2048 ]자 MongoDB Cloud가 AWS 계정의 리소스에 액세스할 때 가정하는 AWS(Amazon Web Services) IAM(ID 및 액세스 관리) 역할을 식별하는 ARN(Amazon 리소스 이름).

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

AWS

{"providerName": "AWS",
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

예시

AWS

{"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": [{"featureType": "ATLAS_DATA_LAKE"
}
],
"iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
"roleId": "32b6e34b3d91647abb20e7b8"
}

클러스터 장애 시뮬레이션

클러스터 장애 시뮬레이션을 반환, 시작 또는 종료합니다.

장애 시뮬레이션 종료

클러스터 장애 시뮬레이션을 종료합니다.

클러스터 장애 시뮬레이션

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

장애 시뮬레이션이 진행 중인 클러스터를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"clusterName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"outageFilters": [{"cloudProvider": "AWS",
"regionName": "string",
"type": "REGION"
}
],
"startRequestDate": "2019-08-24T14:15:22Z",
"state": "START_REQUESTED"
}

1개의 장애 시뮬레이션 반환

하나의 클러스터에 대한 장애 시뮬레이션을 하나 반환합니다.

클러스터 장애 시뮬레이션

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

장애 시뮬레이션이 진행 중인 클러스터를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"clusterName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"outageFilters": [{"cloudProvider": "AWS",
"regionName": "string",
"type": "REGION"
}
],
"startRequestDate": "2019-08-24T14:15:22Z",
"state": "START_REQUESTED"
}

장애 시뮬레이션 시작

클러스터 장애 시뮬레이션을 시작합니다.

클러스터 장애 시뮬레이션

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

장애 시뮬레이션을 진행할 클러스터를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

장애 시뮬레이션을 설명합니다.

의 배열 객체 (AtlasClusterOutageSimulationOutageFilter) non-empty

클러스터 장애 시뮬레이션의 유형을 지정하는 설정 목록.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"outageFilters": [{"cloudProvider": "AWS",
"regionName": "string",
"type": "REGION"
}
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"clusterName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"outageFilters": [{"cloudProvider": "AWS",
"regionName": "string",
"type": "REGION"
}
],
"startRequestDate": "2019-08-24T14:15:22Z",
"state": "START_REQUESTED"
}

클러스터

데이터베이스 배포를 반환, 추가, 편집 및 제거합니다. 클러스터 구성을 변경하면 비용에 영향을 미칠 수 있습니다. 이 리소스를 사용하려면 프로젝트 ID가 필요합니다.

모든 프로젝트에서 모든 승인된 클러스터 반환

액세스 있는 모든 프로젝트의 모든 클러스터에 대한 세부 정보를 반환합니다. 클러스터에는 동일한 데이터 세트 유지하는 호스트 그룹 포함되어 있습니다. 응답에는 멀티클라우드 클러스터가 포함되지 않습니다. 이 리소스 사용하기 위해 요청하는 서비스 계정 또는 API 키는 클러스터 수준 역할 가질 수 있습니다.

권한 부여

서비스 계정DigestAuth

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint

응답

응답 샘플

200
401
403
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"clusters": [{"alertCount": 0,
"authEnabled": true,
"availability": "available",
"backupEnabled": true,
"clusterId": "string",
"dataSizeBytes": 0,
"name": "string",
"nodeCount": 0,
"sslEnabled": true,
"type": "REPLICA_SET",
"versions": ["string"
]
}
],
"groupId": "string",
"groupName": "string",
"orgId": "string",
"orgName": "string",
"planType": "string",
"tags": ["string"
]
}
],
"totalCount": 0
}

1개의 프로젝트에서 모든 클러스터 반환

액세스 있는 특정 프로젝트 의 모든 클러스터에 대한 세부 정보를 반환합니다. 클러스터에는 동일한 데이터 세트 유지하는 호스트 그룹 포함되어 있습니다. 응답에는 비대칭 크기의 샤드가 있는 클러스터가 포함됩니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다. 이 기능 서버리스 클러스터에서는 사용할 수 없습니다.

이 엔드포인트는 createCluster 엔드포인트를 사용하여 생성된 Flex 클러스터 또는 Flex 클러스터로 마이그레이션된 이전의 M2/M5 클러스터에서도 2026년 1월까지 사용할 수 있습니다. Flex 클러스터에는 대신 listFlexClusters 엔드포인트를 사용하세요. 지원 중단된 버전: v2-{2023-02-01}, v2-{2023-01-01}

listFlexClusters

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint
includeDeletedWithRetainedBackups	부울 기본값입니다: 거짓 백업을 유지하면서 클러스터를 반환할지 여부를 나타내는 플래그.

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2024-08-05+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"advancedConfiguration": {"customOpensslCipherConfigTls12": ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"backupEnabled": false,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "string",
"mongoDBVersion": "string",
"name": "string",
"paused": true,
"pitEnabled": true,
"redactClientLogData": true,
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"regionConfigs": [{"electableSpecs": {"diskSizeGB": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10",
"nodeCount": 0
},
"priority": 7,
"providerName": "AWS",
"regionName": "US_GOV_WEST_1",
"analyticsAutoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"predictiveEnabled": true,
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"diskSizeGB": 0,
"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
},
"autoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"predictiveEnabled": true,
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"readOnlySpecs": {"diskSizeGB": 0,
"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
}
}
],
"zoneId": "32b6e34b3d91647abb20e7b8",
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}
],
"totalCount": 0
}

단일 프로젝트에서 단일 클러스터 생성

지정된 프로젝트 에 클러스터 한 개를 만듭니다. 클러스터에는 동일한 데이터 세트 유지하는 호스트 그룹 포함되어 있습니다. 이 리소스 비대칭 크기의 샤드로 클러스터를 생성할 수 있습니다. 각 프로젝트 최대 25 개의 데이터베이스 배포를 지원합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다. 이 기능 서버리스 클러스터에서는 사용할 수 없습니다.

M2 또는 M5의 instanceSize를 사용하면 대신 Flex 클러스터가 생성됩니다. M2 또는 M5의 instanceSize에 대한 지원은 2026년 1월에 중단됩니다. 앞으로 이러한 구성에는 createFlexCluster API를 사용하는 것을 권장합니다. 지원 중단된 버전: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}

createFlexCluster

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

이 프로젝트에서 생성할 클러스터입니다.

acceptDataRisksAndForceReplicaSetReconfig	문자열 <date-time> 리전 중단으로 인해 프라이머리 프라이머리 복구하기 위해 재구성이 필요한 경우 토폴로지 재구성과 함께 이 필드 제출 새로운 리전 중단 방지 토폴로지 요청. 투표 선택 가능 노드 대부분이 중단된 상태에서 강제로 재구성하면 복제된 쓰기(대부분의 커밋된 쓰기 포함)가 새 프라이머리 노드에 복제되지 않은 경우 데이터가 손실될 위험이 있습니다. MongoDB Atlas 문서에 자세한 내용이 포함되어 있습니다. 이러한 위험을 수반하는 작업을 계속 진행하려면 acceptDataRisksAndForceReplicaSetReconfig 를 현재 날짜로 설정하다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 리전 장애 시 복제본 세트 재구성하기
	객체 (ApiAtlasClusterAdvancedConfigurationView) 고급 구성 세부 사항의 하위 집합을 구성하는 설정 그룹입니다.
backupEnabled	부울 기본값입니다: 거짓 클러스터 백업을 수행할 수 있는지 여부를 `true` 나타내는 플래그입니다. 로 설정하다 클러스터 백업을 수행할 수 있습니다.`true` NVMe 클러스터의 경우 이 값을 로 설정하다 해야 합니다. 백업은 전용 클러스터에는 클라우드 백업을 사용하고 테넌트 클러스터에는 공유 클러스터 백업을 사용합니다. 로 설정하다 `false` 클러스터 백업을 사용하지 않습니다. 클라우드 백업
	객체 (Business Intelligence 설정을 위한 MongoDB Connector) 이 클러스터에 대한 Business Intelligence용 MongoDB Connector를 구성하는 데 필요한 설정입니다. MongoDB Connector for Business Intelligence
clusterType	문자열 열거형: "REPLICASET" "SHARDED" "GEOSHARDED" 클러스터를 구성하는 노드의 구성.
configServerManagementMode	문자열 기본값입니다: "ATLAS_MANAGED" 열거형: "ATLAS_MANAGED" "FIXED_TO_DEDICATED" 샤딩된 클러스터를 생성하거나 업데이트하기 위한 Config 서버 관리 모드입니다. ATLAS_MANAGED로 구성된 경우, Atlas는 최적의 성능과 비용 절감을 위해 클러스터의 구성 서버 유형을 자동으로 전환할 수 있습니다. FIXED_TO_DEDICATION으로 구성된 클러스터는 항상 전용 config 서버를 사용합니다. MongoDB 샤딩된 클러스터 Config 서버
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 관리 샤딩으로 설정됩니다. 이 모드는 글로벌 클러스터의 샤딩을 완벽하게 관리하며 원활한 배포 환경을 제공하도록 구축되었습니다. true로 설정하면 관리 모드가 자체 관리 샤딩으로 설정됩니다. 이 모드는 샤드 관리를 사용자에게 맡기며 유연한 고급 배포 환경을 제공하도록 설계되었습니다. 클러스터가 배포된 후에는 이 설정을 변경할 수 없습니다. 글로벌 클러스터 만들기
	의 배열 객체 (컴포넌트 레이블) 더 이상 사용되지 않습니다. 클러스터에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍 컬렉션. MongoDB Cloud 콘솔에는 레이블이 표시되지 않습니다. 클러스터 레이블은 더 이상 사용되지 않으며 향후 출시하다 에서 제거될 예정입니다. 대신 리소스 태그를 사용하는 것이 좋습니다. Resource Tags
	객체 (EmployeeAccessGrantView) 클러스터에 대한 액세스 수준 및 만료 권한을 MongoDB 직원에게 부여했습니다.
mongoDBMajorVersion	문자열 클러스터 의 MongoDB 주요 버전입니다. 바이너리 메이저 버전으로 설정합니다. 생성 시: 사용 가능한 MongoDB 버전 중에서 선택하거나 현재 권장되는 기본값을 지정하지 않고 그대로 두어 MongoDB 클라우드 플랫폼에서 사용할 수 있습니다. 권장되는 버전은 최신 LTS(장기 지원) 버전입니다. 기본값은 전체 릴리스 주기 동안 가장 최근에 릴리스된 버전으로 보장되지 않습니다. 특정 프로젝트에서 사용할 수 있는 버전을 알아보려면 링크된 문서를 참조하거나 프로젝트 LTS 버전 엔드포인트에 대한 API 엔드포인트를 사용하세요. 업데이트 시: 한 번에 1개의 주요 버전만 버전을 증가시킵니다. 클러스터가 현재 MongoDB 버전보다 정확히 한 주요 버전 낮은 MongoDB 기능 호환성 버전에 고정되어 있는 경우, MongoDB 버전을 이전 주요 버전으로 다운그레이드할 수 있습니다. Atlas에서 사용 가능한 MongoDB 버전
이름	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
paused	부울 클러스터의 일시 중지 여부를 나타내는 플래그.
pitEnabled	부울 클러스터의 지속적인 클라우드 백업 사용 여부를 나타내는 플래그. 지속적인 클라우드 백업
redactClientLogData	부울 로그 편집을 활성화하거나 비활성화합니다. 이 설정은 `mongod` 또는 `mongos`를 구성하여 로깅하기 전에 지정된 로그 이벤트에 수반되는 모든 메시지에서 문서 필드 콘텐츠를 삭제합니다. 이렇게 하면 데이터베이스에 저장된 잠재적으로 민감한 데이터를 진단 로그에 기록하는 것을 방지할 수 있습니다. 오류 또는 작업 코드, 줄 번호, 소스 파일 이름과 같은 메타데이터는 여전히 로그에 표시됩니다. `redactClientLogData`를 미사용 데이터 암호화 및 TLS/SSL(전송 암호화)과 함께 사용하여 규제 요건을 준수할 수 있습니다. 참고: 클러스터에서 이 설정을 변경하면 클러스터가 업데이트되는 즉시 롤링 재시작이 트리거됩니다. 로그 편집
replicaSetScalingStrategy	문자열 기본값입니다: "WORKLOAD_TYPE" 열거형: '순차적' "WORKLOAD_TYPE" "NODE_TYPE" 이 필드를 설정하여 클러스터의 복제본 세트 스케일링 모드를 구성합니다. 기본적으로 Atlas는 WORKLOAD_TYPE에 따라 확장됩니다. 이 모드를 사용하면 Atlas가 운영 노드와 함께 분석 노드를 병렬 확장할 수 있습니다. SEQUENTIAL로 구성된 경우 Atlas는 모든 노드를 순차적으로 확장합니다. 이 모드는 안정된 상태의 워크로드 및 지연 시간에 민감한 세컨더리 읽기를 수행하는 애플리케이션을 대상으로 합니다. NODE_TYPE으로 구성하면 Atlas는 읽기 전용 및 분석 노드와 병렬로 선택 가능한 노드를 확장합니다. 이 모드는 자주 그리고 신속한 클러스터 계층 확장이 필요한 대규모 동적 워크로드에 적합합니다. 이는 가장 빠른 확장 전략이지만 광범위한 세컨더리 읽기 작업을 수행할 때 워크로드 지연에 영향을 미칠 수 있습니다. 복제본 세트 확장 모드 수정
	의 배열 객체 (복제 사양) 클러스터 리전을 구성하는 설정 목록. 이 배열에는 샤드당 객체 1개가 있으며, 각 샤드의 노드 구성을 나타냅니다. 복제본 세트는 노드 구성을 나타내는 객체가 1개만 있습니다.
rootCertType	문자열 기본값입니다: "ISRGROOTX1" 값: "ISRGROOTX1" MongoDB Cloud 클러스터가 사용하는 루트 인증 기관. MongoDB Cloud는 Internet Security Research 그룹을 지원합니다.
	의 배열 객체 (Resource Tag) 클러스터에 태그를 지정하고 분류하기 위한 1~255자 길이의 키-값 쌍이 포함된 목록입니다. Resource Tags
terminationProtectionEnabled	부울 기본값입니다: 거짓 클러스터의 종료 보호 활성화 여부를 나타내는 플래그. `true`로 설정하면 MongoDB Cloud가 클러스터를 삭제하지 않습니다. `false`로 설정하면 MongoDB Cloud가 클러스터를 삭제합니다.
versionReleaseSystem	문자열 기본값입니다: "LTS" 열거형: "LTS" "CONTINUOUS" 클러스터가 MongoDB 버전을 유지 관리하는 방법입니다. 값이 `CONTINUOUS`인 경우 mongoDBMajorVersion을 지정하지 않아야 합니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-10-23+json

클러스터

{"clusterType": "SHARDED",
"name": "myCluster",
"replicationSpecs": [{"regionConfigs": [{"analyticsAutoScaling": {"autoIndexing": {"enabled": false
},
"compute": {"enabled": true,
"maxInstanceSize": "M40",
"minInstanceSize": "M30",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"diskSizeGB": 10,
"instanceSize": "M40",
"nodeCount": 0
},
"autoScaling": {"autoIndexing": {"enabled": false
},
"compute": {"enabled": true,
"maxInstanceSize": "M60",
"minInstanceSize": "M30",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"electableSpecs": {"diskSizeGB": 10,
"instanceSize": "M60",
"nodeCount": 3
},
"priority": 7,
"providerName": "AWS",
"readOnlySpecs": {"diskSizeGB": 10,
"instanceSize": "M60",
"nodeCount": 0
},
"regionName": "US_EAST_1"
}
],
"zoneName": "Zone 1"
},
{"regionConfigs": [{"analyticsAutoScaling": {"autoIndexing": {"enabled": false
},
"compute": {"enabled": true,
"maxInstanceSize": "M40",
"minInstanceSize": "M30",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"diskSizeGB": 10,
"instanceSize": "M30",
"nodeCount": 0
},
"autoScaling": {"autoIndexing": {"enabled": false
},
"compute": {"enabled": true,
"maxInstanceSize": "M60",
"minInstanceSize": "M30",
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"electableSpecs": {"diskSizeGB": 10,
"instanceSize": "M40",
"nodeCount": 3
},
"priority": 7,
"providerName": "AWS",
"readOnlySpecs": {"diskSizeGB": 10,
"instanceSize": "M40",
"nodeCount": 0
},
"regionName": "US_EAST_1"
}
],
"zoneName": "Zone 1"
}
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-10-23+json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"advancedConfiguration": {"customOpensslCipherConfigTls12": ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"backupEnabled": false,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "string",
"mongoDBVersion": "string",
"name": "string",
"paused": true,
"pitEnabled": true,
"redactClientLogData": true,
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"regionConfigs": [{"electableSpecs": {"diskSizeGB": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10",
"nodeCount": 0
},
"priority": 7,
"providerName": "AWS",
"regionName": "US_GOV_WEST_1",
"analyticsAutoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"predictiveEnabled": true,
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"diskSizeGB": 0,
"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
},
"autoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"predictiveEnabled": true,
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"readOnlySpecs": {"diskSizeGB": 0,
"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
}
}
],
"zoneId": "32b6e34b3d91647abb20e7b8",
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

모든 클라우드 제공자 리전 반환

지정된 계층 에서 지정된 cloud 제공자 에 사용할 수 있는 리전 목록을 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint
providers	의 배열 strings 검색할 리전이 있는 클라우드 공급자. 여러 공급자를 지정하면 응답은 멀티 클라우드 클러스터를 지원하는 계층 및 리전만 반환할 수 있습니다.
tier	문자열 리전을 검색할 클러스터 계층.

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"instanceSizes": [{"availableRegions": [{"default": true,
"name": "string"
}
],
"name": "string"
}
],
"provider": "AWS"
}
],
"totalCount": 0
}

1개의 공유 계층 클러스터 업그레이드

지정된 프로젝트 의 공유 계층 클러스터 Flex 또는 전용(M10+) 클러스터 로 업그레이드합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 클러스터 관리자 역할 있어야 합니다. 각 프로젝트 최대 25 개의 클러스터를 지원합니다.

이 엔드포인트는 createCluster API를 사용하여 생성된 Flex 클러스터 또는 Flex 클러스터로 마이그레이션된 이전의 M2/M5 클러스터를 업그레이드하는 데 사용할 수 있으며 2026년 1월까지 instanceSizeName을 “M2” 또는 “M5”로 설정하는 방법이 지원됩니다. 이 기능은 2026년 1월까지 사용할 수 있으며, 그 이후에는 M0 클러스터에서만 사용할 수 있습니다. 대신 upgradeFlexCluster 엔드포인트를 사용하세요.

upgradeFlexCluster

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

지정된 프로젝트의 공유 계층 클러스터 업그레이드에 대한 세부 정보.

acceptDataRisksAndForceReplicaSetReconfig	문자열 <date-time> 리전 중단으로 인해 프라이머리 프라이머리 복구하기 위해 재구성이 필요한 경우 토폴로지 재구성과 함께 이 필드 제출 새로운 리전 중단 방지 토폴로지 요청. 투표 선택 가능 노드 대부분이 중단된 상태에서 강제로 재구성하면 복제된 쓰기(대부분의 커밋된 쓰기 포함)가 새 프라이머리 노드에 복제되지 않은 경우 데이터가 손실될 위험이 있습니다. MongoDB Atlas 문서에 자세한 내용이 포함되어 있습니다. 이러한 위험을 수반하는 작업을 계속 진행하려면 acceptDataRisksAndForceReplicaSetReconfig 를 현재 날짜로 설정하다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 리전 장애 시 복제본 세트 재구성하기
	객체 (ApiAtlasClusterAdvancedConfigurationView) 고급 구성 세부 사항의 하위 집합을 구성하는 설정 그룹입니다.
	객체 (자동 클러스터 확장 설정) 클러스터를 확장할 수 있는 인스턴스 크기의 범위. 클러스터 자동 확장
backupEnabled	부울 클러스터가 백업을 수행할 수 있는지 여부를 나타내는 플래그. `true`로 설정하면 클러스터가 백업을 수행할 수 있습니다. NVMe 클러스터의 경우 이 값을 `true`로 설정해야 합니다. 백업은 전용 클러스터에는 클라우드 백업을, 테넌트 클러스터에는 공유 클러스터 백업을 사용합니다. `false`로 설정하면 클러스터에서 MongoDB Cloud 백업을 사용하지 않습니다.
	객체 (Business Intelligence 설정을 위한 MongoDB Connector) 이 클러스터에 대한 Business Intelligence용 MongoDB Connector를 구성하는 데 필요한 설정입니다. MongoDB Connector for Business Intelligence
clusterType	문자열 열거형: "REPLICASET" "SHARDED" "GEOSHARDED" 클러스터를 구성하는 노드의 구성.
configServerManagementMode	문자열 기본값입니다: "ATLAS_MANAGED" 열거형: "ATLAS_MANAGED" "FIXED_TO_DEDICATED" 샤딩된 클러스터를 생성하거나 업데이트하기 위한 Config 서버 관리 모드입니다. ATLAS_MANAGED로 구성된 경우, Atlas는 최적의 성능과 비용 절감을 위해 클러스터의 구성 서버 유형을 자동으로 전환할 수 있습니다. FIXED_TO_DEDICATION으로 구성된 클러스터는 항상 전용 config 서버를 사용합니다. MongoDB 샤딩된 클러스터 Config 서버
diskSizeGB	숫자 <double> [ 10 .. 4096 ] 인스턴스 데이터 볼륨의 스토리지 용량은 기가바이트 단위로 표현됩니다. 용량을 추가하려면 이 숫자를 늘리세요. 이 값은 M0/M2/M5 클러스터에서 구성할 수 없습니다. 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 관리 샤딩으로 설정됩니다. 이 모드는 글로벌 클러스터의 샤딩을 완벽하게 관리하며 원활한 배포 환경을 제공하도록 구축되었습니다. true로 설정하면 관리 모드가 자체 관리 샤딩으로 설정됩니다. 이 모드는 샤드 관리를 사용자에게 맡기며 유연한 고급 배포 환경을 제공하도록 설계되었습니다. 클러스터가 배포된 후에는 이 설정을 변경할 수 없습니다. 글로벌 클러스터 만들기
	의 배열 객체 (컴포넌트 레이블) 더 이상 사용되지 않습니다. 클러스터에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍 컬렉션. MongoDB Cloud 콘솔에는 레이블이 표시되지 않습니다. 클러스터 레이블은 더 이상 사용되지 않으며 향후 출시하다 에서 제거될 예정입니다. 대신 리소스 태그를 사용하는 것이 좋습니다. Resource Tags
	객체 (EmployeeAccessGrantView) 클러스터에 대한 액세스 수준 및 만료 권한을 MongoDB 직원에게 부여했습니다.
mongoDBMajorVersion	문자열 클러스터의 MongoDB 주요 버전입니다. 생성 시: 사용 가능한 MongoDB 버전 중에서 선택하거나 현재 권장되는 기본값을 지정하지 않고 그대로 두어 MongoDB 클라우드 플랫폼에서 사용할 수 있습니다. 권장되는 버전은 최신 LTS(장기 지원) 버전입니다. 기본값은 전체 릴리스 주기 동안 가장 최근에 릴리스된 버전으로 보장되지 않습니다. 특정 프로젝트에서 사용할 수 있는 버전을 알아보려면 링크된 문서를 참조하거나 프로젝트 LTS 버전 엔드포인트에 대한 API 엔드포인트를 사용하세요. 업데이트 시: 한 번에 1개의 주요 버전만 버전을 증가시킵니다. 클러스터가 현재 MongoDB 버전보다 정확히 한 주요 버전 낮은 MongoDB 기능 호환성 버전에 고정되어 있는 경우, MongoDB 버전을 이전 주요 버전으로 다운그레이드할 수 있습니다. Atlas에서 사용 가능한 MongoDB 버전
mongoDBVersion	문자열([\d]+\.[\d]+\.[\d]+) 클러스터가 실행하는 MongoDB 버전.
이름 필수	문자열^[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 호스트를 구성하는 클라우드 공급자 설정 그룹.
replicaSetScalingStrategy	문자열 기본값입니다: "WORKLOAD_TYPE" 열거형: '순차적' "WORKLOAD_TYPE" "NODE_TYPE" 이 필드를 설정하여 클러스터의 복제본 세트 스케일링 모드를 구성합니다. 기본적으로 Atlas는 WORKLOAD_TYPE에 따라 확장됩니다. 이 모드를 사용하면 Atlas가 운영 노드와 함께 분석 노드를 병렬 확장할 수 있습니다. SEQUENTIAL로 구성된 경우 Atlas는 모든 노드를 순차적으로 확장합니다. 이 모드는 안정된 상태의 워크로드 및 지연 시간에 민감한 세컨더리 읽기를 수행하는 애플리케이션을 대상으로 합니다. NODE_TYPE으로 구성하면 Atlas는 읽기 전용 및 분석 노드와 병렬로 선택 가능한 노드를 확장합니다. 이 모드는 자주 그리고 신속한 클러스터 계층 확장이 필요한 대규모 동적 워크로드에 적합합니다. 이는 가장 빠른 확장 전략이지만 광범위한 세컨더리 읽기 작업을 수행할 때 워크로드 지연에 영향을 미칠 수 있습니다. 복제본 세트 확장 모드 수정
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자 길이의 키-값 쌍이 포함된 목록입니다. Resource Tags
terminationProtectionEnabled	부울 기본값입니다: 거짓 클러스터의 종료 보호 활성화 여부를 나타내는 플래그. `true`로 설정하면 MongoDB Cloud가 클러스터를 삭제하지 않습니다. `false`로 설정하면 MongoDB Cloud가 클러스터를 삭제합니다.
versionReleaseSystem	문자열 기본값입니다: "LTS" 열거형: "LTS" "CONTINUOUS" 클러스터가 MongoDB 버전을 유지 관리하는 방법입니다. 값이 `CONTINUOUS`인 경우 mongoDBMajorVersion을 지정하지 않아야 합니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"advancedConfiguration": {"customOpensslCipherConfigTls12": ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"autoScaling": {"compute": {"enabled": false,
"predictiveEnabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"globalClusterSelfManagedSharding": true,
"labels": [{"key": "string",
"value": "string"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS"
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {"providerName": "string",
"autoScaling": {"compute": {"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 0,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationFactor": 3,
"replicationSpec": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"advancedConfiguration": {"customOpensslCipherConfigTls12": ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"autoScaling": {"compute": {"enabled": false,
"predictiveEnabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskSizeGB": 10,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"mongoURI": "string",
"mongoURIUpdated": "2019-08-24T14:15:22Z",
"mongoURIWithOptions": "string",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {"providerName": "string",
"autoScaling": {"compute": {"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 0,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationFactor": 3,
"replicationSpec": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {"property1": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
},
"property2": {"analyticsNodes": 0,
"electableNodes": 0,
"priority": 7,
"readOnlyNodes": 0
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"srvAddress": "string",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

1개의 공유 계층 클러스터를 서버리스 인스턴스로 업그레이드지원 중단됨

새 서버리스 인스턴스 생성을 더 이상 지원하지 않으므로 이 엔드포인트는 2025년 2월부로 지원 중단되었습니다. Flex 클러스터를 업그레이드하려면 upgradeFlexCluster 엔드포인트를 사용하세요.

지정된 프로젝트 의 공유 계층 클러스터 서버리스 인스턴스 로 업그레이드합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 클러스터 관리자 역할 있어야 합니다.

upgradeFlexCluster

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

지정된 프로젝트의 공유 계층 클러스터 업그레이드에 대한 세부 정보.

이름	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 서버리스 인스턴스를 식별하는 인간 판독 가능 레이블.
필수	객체 (서버리스 인스턴스에 대한 클라우드 서비스 제공자 설정) 프로비저닝된 MongoDB 서버리스 인스턴스를 구성하는 클라우드 공급자 설정 그룹.
	객체 (서버리스 백업 옵션) 서버리스 백업을 구성하는 설정 그룹.
	의 배열 객체 (Resource Tag) 서버리스 인스턴스에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍이 포함된 목록.
terminationProtectionEnabled	부울 기본값입니다: 거짓 서버리스 인스턴스에서 종료 방지 기능 활성화 여부를 나타내는 플래그. `true`로 설정하면 MongoDB Cloud가는 서버리스 인스턴스를 삭제하지 않습니다. `false`로 설정하면 MongoDB Cloud가 서버리스 인스턴스를 삭제합니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"name": "string",
"providerSettings": {"backingProviderName": "AWS",
"providerName": "SERVERLESS",
"regionName": "string"
},
"serverlessBackupOptions": {"serverlessContinuousBackupEnabled": true
},
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"connectionStrings": {"privateEndpoint": [{"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"type": "MONGOS"
}
],
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBVersion": "string",
"name": "string",
"providerSettings": {"backingProviderName": "AWS",
"effectiveDiskSizeGBLimit": 0,
"effectiveInstanceSizeName": "M10",
"effectiveProviderName": "string",
"providerName": "SERVERLESS",
"regionName": "string"
},
"serverlessBackupOptions": {"serverlessContinuousBackupEnabled": true
},
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false
}

하나의 프로젝트에서 하나의 클러스터 제거

지정된 프로젝트 에서 클러스터 한 개를 제거합니다. 클러스터 삭제하려면 종료 방지 기능이 비활성화되어 있어야 합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다. 이 기능 서버리스 클러스터에서는 사용할 수 없습니다.

이 엔드포인트는 createCluster 엔드포인트를 사용하여 생성된 Flex 클러스터 또는 Flex 클러스터로 마이그레이션된 이전의 M2/M5 클러스터에서도 2026년 1월까지 사용할 수 있습니다. Flex 클러스터에는 대신 deleteFlexCluster 엔드포인트를 사용하세요. 지원 중단된 버전: v2-{2023-01-01}

deleteFlexCluster

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint
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 키에 프로젝트 읽기 전용 역할 있어야 합니다. 이 기능 서버리스 클러스터에서는 사용할 수 없습니다.

이 엔드포인트는 createCluster 엔드포인트를 사용하여 생성된 Flex 클러스터 또는 Flex 클러스터로 마이그레이션된 이전의 M2/M5 클러스터에서도 2026년 1월까지 사용할 수 있습니다. Flex 클러스터에는 대신 getFlexCluster 엔드포인트를 사용하세요. 지원 중단된 버전: v2-{2023-02-01}, v2-{2023-01-01}

getFlexCluster

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-08-05+json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"advancedConfiguration": {"customOpensslCipherConfigTls12": ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"backupEnabled": false,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "string",
"mongoDBVersion": "string",
"name": "string",
"paused": true,
"pitEnabled": true,
"redactClientLogData": true,
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"regionConfigs": [{"electableSpecs": {"diskSizeGB": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10",
"nodeCount": 0
},
"priority": 7,
"providerName": "AWS",
"regionName": "US_GOV_WEST_1",
"analyticsAutoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"predictiveEnabled": true,
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"diskSizeGB": 0,
"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
},
"autoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"predictiveEnabled": true,
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"readOnlySpecs": {"diskSizeGB": 0,
"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
}
}
],
"zoneId": "32b6e34b3d91647abb20e7b8",
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

1개의 프로젝트에서 1개의 클러스터 수정

지정된 프로젝트 에 있는 한 클러스터 의 세부 정보를 업데이트합니다. 클러스터에는 동일한 데이터 세트 유지하는 호스트 그룹 포함되어 있습니다. 이 리소스 비대칭 크기의 샤드로 클러스터를 업데이트 할 수 있습니다. 클러스터의 종료 보호 기능을 업데이트 하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다. 다른 모든 업데이트의 경우 요청하는 서비스 계정 또는 API 키에 프로젝트 클러스터 관리자 역할 있어야 합니다. 일시 중지된 클러스터 (paused : true)는 수정할 수 없습니다. paused : false을(를) 설정하다 하려면 이 엔드포인트를 호출해야 합니다. 이 엔드포인트가 paused : false로 응답하면 클러스터 에 적용하려는 변경 사항을 적용하여 다시 호출할 수 있습니다. 이 기능 서버리스 클러스터에서는 사용할 수 없습니다. 사용 중단된 버전: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

지정된 프로젝트에서 업데이트할 클러스터.

acceptDataRisksAndForceReplicaSetReconfig	문자열 <date-time> 리전 중단으로 인해 프라이머리 프라이머리 복구하기 위해 재구성이 필요한 경우 토폴로지 재구성과 함께 이 필드 제출 새로운 리전 중단 방지 토폴로지 요청. 투표 선택 가능 노드 대부분이 중단된 상태에서 강제로 재구성하면 복제된 쓰기(대부분의 커밋된 쓰기 포함)가 새 프라이머리 노드에 복제되지 않은 경우 데이터가 손실될 위험이 있습니다. MongoDB Atlas 문서에 자세한 내용이 포함되어 있습니다. 이러한 위험을 수반하는 작업을 계속 진행하려면 acceptDataRisksAndForceReplicaSetReconfig 를 현재 날짜로 설정하다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 리전 장애 시 복제본 세트 재구성하기
	객체 (ApiAtlasClusterAdvancedConfigurationView) 고급 구성 세부 사항의 하위 집합을 구성하는 설정 그룹입니다.
backupEnabled	부울 기본값입니다: 거짓 클러스터 백업을 수행할 수 있는지 여부를 `true` 나타내는 플래그입니다. 로 설정하다 클러스터 백업을 수행할 수 있습니다.`true` NVMe 클러스터의 경우 이 값을 로 설정하다 해야 합니다. 백업은 전용 클러스터에는 클라우드 백업을 사용하고 테넌트 클러스터에는 공유 클러스터 백업을 사용합니다. 로 설정하다 `false` 클러스터 백업을 사용하지 않습니다. 클라우드 백업
	객체 (Business Intelligence 설정을 위한 MongoDB Connector) 이 클러스터에 대한 Business Intelligence용 MongoDB Connector를 구성하는 데 필요한 설정입니다. MongoDB Connector for Business Intelligence
clusterType	문자열 열거형: "REPLICASET" "SHARDED" "GEOSHARDED" 클러스터를 구성하는 노드의 구성.
configServerManagementMode	문자열 기본값입니다: "ATLAS_MANAGED" 열거형: "ATLAS_MANAGED" "FIXED_TO_DEDICATED" 샤딩된 클러스터를 생성하거나 업데이트하기 위한 Config 서버 관리 모드입니다. ATLAS_MANAGED로 구성된 경우, Atlas는 최적의 성능과 비용 절감을 위해 클러스터의 구성 서버 유형을 자동으로 전환할 수 있습니다. FIXED_TO_DEDICATION으로 구성된 클러스터는 항상 전용 config 서버를 사용합니다. MongoDB 샤딩된 클러스터 Config 서버
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 관리 샤딩으로 설정됩니다. 이 모드는 글로벌 클러스터의 샤딩을 완벽하게 관리하며 원활한 배포 환경을 제공하도록 구축되었습니다. true로 설정하면 관리 모드가 자체 관리 샤딩으로 설정됩니다. 이 모드는 샤드 관리를 사용자에게 맡기며 유연한 고급 배포 환경을 제공하도록 설계되었습니다. 클러스터가 배포된 후에는 이 설정을 변경할 수 없습니다. 글로벌 클러스터 만들기
	의 배열 객체 (컴포넌트 레이블) 더 이상 사용되지 않습니다. 클러스터에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍 컬렉션. MongoDB Cloud 콘솔에는 레이블이 표시되지 않습니다. 클러스터 레이블은 더 이상 사용되지 않으며 향후 출시하다 에서 제거될 예정입니다. 대신 리소스 태그를 사용하는 것이 좋습니다. Resource Tags
	객체 (EmployeeAccessGrantView) 클러스터에 대한 액세스 수준 및 만료 권한을 MongoDB 직원에게 부여했습니다.
mongoDBMajorVersion	문자열 클러스터 의 MongoDB 주요 버전입니다. 바이너리 메이저 버전으로 설정합니다. 생성 시: 사용 가능한 MongoDB 버전 중에서 선택하거나 현재 권장되는 기본값을 지정하지 않고 그대로 두어 MongoDB 클라우드 플랫폼에서 사용할 수 있습니다. 권장되는 버전은 최신 LTS(장기 지원) 버전입니다. 기본값은 전체 릴리스 주기 동안 가장 최근에 릴리스된 버전으로 보장되지 않습니다. 특정 프로젝트에서 사용할 수 있는 버전을 알아보려면 링크된 문서를 참조하거나 프로젝트 LTS 버전 엔드포인트에 대한 API 엔드포인트를 사용하세요. 업데이트 시: 한 번에 1개의 주요 버전만 버전을 증가시킵니다. 클러스터가 현재 MongoDB 버전보다 정확히 한 주요 버전 낮은 MongoDB 기능 호환성 버전에 고정되어 있는 경우, MongoDB 버전을 이전 주요 버전으로 다운그레이드할 수 있습니다. Atlas에서 사용 가능한 MongoDB 버전
이름	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
paused	부울 클러스터의 일시 중지 여부를 나타내는 플래그.
pitEnabled	부울 클러스터의 지속적인 클라우드 백업 사용 여부를 나타내는 플래그. 지속적인 클라우드 백업
redactClientLogData	부울 로그 편집을 활성화하거나 비활성화합니다. 이 설정은 `mongod` 또는 `mongos`를 구성하여 로깅하기 전에 지정된 로그 이벤트에 수반되는 모든 메시지에서 문서 필드 콘텐츠를 삭제합니다. 이렇게 하면 데이터베이스에 저장된 잠재적으로 민감한 데이터를 진단 로그에 기록하는 것을 방지할 수 있습니다. 오류 또는 작업 코드, 줄 번호, 소스 파일 이름과 같은 메타데이터는 여전히 로그에 표시됩니다. `redactClientLogData`를 미사용 데이터 암호화 및 TLS/SSL(전송 암호화)과 함께 사용하여 규제 요건을 준수할 수 있습니다. 참고: 클러스터에서 이 설정을 변경하면 클러스터가 업데이트되는 즉시 롤링 재시작이 트리거됩니다. 로그 편집
replicaSetScalingStrategy	문자열 기본값입니다: "WORKLOAD_TYPE" 열거형: '순차적' "WORKLOAD_TYPE" "NODE_TYPE" 이 필드를 설정하여 클러스터의 복제본 세트 스케일링 모드를 구성합니다. 기본적으로 Atlas는 WORKLOAD_TYPE에 따라 확장됩니다. 이 모드를 사용하면 Atlas가 운영 노드와 함께 분석 노드를 병렬 확장할 수 있습니다. SEQUENTIAL로 구성된 경우 Atlas는 모든 노드를 순차적으로 확장합니다. 이 모드는 안정된 상태의 워크로드 및 지연 시간에 민감한 세컨더리 읽기를 수행하는 애플리케이션을 대상으로 합니다. NODE_TYPE으로 구성하면 Atlas는 읽기 전용 및 분석 노드와 병렬로 선택 가능한 노드를 확장합니다. 이 모드는 자주 그리고 신속한 클러스터 계층 확장이 필요한 대규모 동적 워크로드에 적합합니다. 이는 가장 빠른 확장 전략이지만 광범위한 세컨더리 읽기 작업을 수행할 때 워크로드 지연에 영향을 미칠 수 있습니다. 복제본 세트 확장 모드 수정
	의 배열 객체 (복제 사양) 클러스터 리전을 구성하는 설정 목록. 이 배열에는 샤드당 객체 1개가 있으며, 각 샤드의 노드 구성을 나타냅니다. 복제본 세트는 노드 구성을 나타내는 객체가 1개만 있습니다.
rootCertType	문자열 기본값입니다: "ISRGROOTX1" 값: "ISRGROOTX1" MongoDB Cloud 클러스터가 사용하는 루트 인증 기관. MongoDB Cloud는 Internet Security Research 그룹을 지원합니다.
	의 배열 객체 (Resource Tag) 클러스터에 태그를 지정하고 분류하기 위한 1~255자 길이의 키-값 쌍이 포함된 목록입니다. Resource Tags
terminationProtectionEnabled	부울 기본값입니다: 거짓 클러스터의 종료 보호 활성화 여부를 나타내는 플래그. `true`로 설정하면 MongoDB Cloud가 클러스터를 삭제하지 않습니다. `false`로 설정하면 MongoDB Cloud가 클러스터를 삭제합니다.
versionReleaseSystem	문자열 기본값입니다: "LTS" 열거형: "LTS" "CONTINUOUS" 클러스터가 MongoDB 버전을 유지 관리하는 방법입니다. 값이 `CONTINUOUS`인 경우 mongoDBMajorVersion을 지정하지 않아야 합니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-10-23+json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"advancedConfiguration": {"customOpensslCipherConfigTls12": ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"backupEnabled": false,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"globalClusterSelfManagedSharding": true,
"labels": [{"key": "string",
"value": "string"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS"
},
"mongoDBMajorVersion": "string",
"name": "string",
"paused": true,
"pitEnabled": true,
"redactClientLogData": true,
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationSpecs": [{"regionConfigs": [{"electableSpecs": {"diskSizeGB": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10",
"nodeCount": 0
},
"priority": 7,
"providerName": "AWS",
"regionName": "US_GOV_WEST_1",
"analyticsAutoScaling": {"compute": {"enabled": true,
"predictiveEnabled": true,
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"diskSizeGB": 0,
"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
},
"autoScaling": {"compute": {"enabled": true,
"predictiveEnabled": true,
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"readOnlySpecs": {"diskSizeGB": 0,
"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
}
}
],
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-10-23+json

{"acceptDataRisksAndForceReplicaSetReconfig": "2019-08-24T14:15:22Z",
"advancedConfiguration": {"customOpensslCipherConfigTls12": ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"backupEnabled": false,
"biConnector": {"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {"awsPrivateLink": {"property1": "string",
"property2": "string"
},
"awsPrivateLinkSrv": {"property1": "string",
"property2": "string"
},
"private": "string",
"privateEndpoint": [{"connectionString": "string",
"endpoints": [{"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2019-08-24T14:15:22Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [{"key": "string",
"value": "string"
}
],
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "string",
"mongoDBVersion": "string",
"name": "string",
"paused": true,
"pitEnabled": true,
"redactClientLogData": true,
"replicaSetScalingStrategy": "SEQUENTIAL",
"replicationSpecs": [{"id": "32b6e34b3d91647abb20e7b8",
"regionConfigs": [{"electableSpecs": {"diskSizeGB": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10",
"nodeCount": 0
},
"priority": 7,
"providerName": "AWS",
"regionName": "US_GOV_WEST_1",
"analyticsAutoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"predictiveEnabled": true,
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"analyticsSpecs": {"diskSizeGB": 0,
"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
},
"autoScaling": {"compute": {"enabled": true,
"maxInstanceSize": "M10",
"minInstanceSize": "M10",
"predictiveEnabled": true,
"scaleDownEnabled": true
},
"diskGB": {"enabled": true
}
},
"readOnlySpecs": {"diskSizeGB": 0,
"nodeCount": 0,
"diskIOPS": 0,
"ebsVolumeType": "STANDARD",
"instanceSize": "M10"
}
}
],
"zoneId": "32b6e34b3d91647abb20e7b8",
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"stateName": "IDLE",
"tags": [{"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}

샤딩된 클러스터 자동 확장 작업의 클러스터 내부 구성을 가져옵니다. 사용 중단됨

샤딩된 클러스터의 자동 확장의 내부 구성을 반환합니다. 이 엔드포인트는 구형 API에서 업데이트된 샤딩된 클러스터가 개별 샤드 자동 확장을 지원하는지 진단하는 데 사용됩니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-08-05+json

{"autoScalingMode": "INDEPENDENT_SHARD_SCALING"
}

1개의 클러스터에 대해 1개의 고급 구성 옵션 반환

지정된 프로젝트 의 클러스터 한 개에 대한 고급 구성 세부 정보를 반환합니다. 클러스터에는 동일한 데이터 세트 유지하는 호스트 그룹 포함되어 있습니다. 고급 구성 세부 정보에는 읽기/ 쓰기 고려 (write concern), 인덱스 및 oplog 제한, 기타 데이터베이스 설정이 포함됩니다. 이 기능 M0 무료 클러스터, M2 및 M5 공유 계층 클러스터, flex 클러스터 또는 서버리스 클러스터에서는 사용할 수 없습니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

글로벌 클러스터

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-08-05+json

{"changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
"chunkMigrationConcurrency": 0,
"customOpensslCipherConfigTls12": ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"defaultMaxTimeMS": 0,
"defaultWriteConcern": "string",
"javascriptEnabled": true,
"minimumEnabledTlsProtocol": "TLS1_0",
"noTableScan": true,
"oplogMinRetentionHours": 0,
"oplogSizeMB": 0,
"queryStatsLogVerbosity": 0,
"sampleRefreshIntervalBIConnector": 0,
"sampleSizeBIConnector": 0,
"tlsCipherConfigMode": "CUSTOM",
"transactionLifetimeLimitSeconds": 1
}

1개의 클러스터에 대해 고급 구성 옵션 업데이트

지정된 프로젝트 의 한 클러스터 에 대한 고급 구성 세부 정보를 업데이트합니다. 클러스터에는 동일한 데이터 세트 유지하는 호스트 그룹 포함되어 있습니다. 고급 구성 세부 정보에는 읽기/ 쓰기 고려 (write concern), 인덱스 및 oplog 제한, 기타 데이터베이스 설정이 포함됩니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 클러스터 관리자 역할 있어야 합니다. 이 기능 M0 무료 클러스터, M2 및 M5 공유 계층 클러스터, flex 클러스터 또는 서버리스 클러스터에서는 사용할 수 없습니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

글로벌 클러스터

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-08-05+json

지정된 프로젝트의 클러스터 하나에 추가할 고급 구성 세부정보.

changeStreamOptionsPreAndPostImagesExpireAfterSeconds	integer <int32> 기본값입니다: -1 최소 이미지 사전 및 사후 보존 시간(초)입니다. 이 옵션은 ''changeStreamOptions.preAndPostImages.expireAfterSeconds'' 클러스터 매개변수에 해당합니다. 이 설정은 변경 스트림 사전 및 사후 이미지의 보존 정책을 제어합니다. 사전 이미지와 사후 이미지는 각각 문서 수정 전과 후의 문서 버전입니다. "expireAfterSeconds"는 MongoDB가 사전 및 사후 이미지를 보관하는 기간을 제어합니다. -1(해제)로 설정하면 MongoDB는 기본 보존 정책을 사용합니다. 즉, 해당 변경 스트림 이벤트가 oplog에서 제거될 때까지 사전 및 사후 이미지가 보존됩니다. 사전 및 사후 이미지 보존 시간의 최소 시간을 설정하려면 0보다 큰 정수 값을 지정합니다. 이 값을 너무 낮게 설정하면 Realm 동기화나 트리거 처리가 중단될 위험이 커질 수 있습니다. 기본값은 -1(해제)입니다.
chunkMigrationConcurrency	integer <int32> 청크 마이그레이션을 위한 소스 샤드 및 수신 샤드의 스레드 수. 스레드 수는 샤딩된 클러스터에 있는 총 CPU 코어 수의 절반을 초과할 수 없습니다. 이 옵션은 `chunkMigrationConcurrency` `mongod` 구성 파일 옵션에 해당합니다.
customOpensslCipherConfigTls12	의 배열 strings 항목 열거형: "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" TLS 1.2에 대한 사용자 지정 OpenSSL 암호 제품군 목록입니다. 이 필드 `tlsCipherConfigMode` 가 `CUSTOM`로 설정하다 경우에만 유효합니다. 이 옵션은 구성 파일 옵션 `opensslCipherConfig` ` mongod `에 해당합니다.
defaultMaxTimeMS	integer <int32> 개별 읽기 작업을 완료하는 데 걸리는 기본 시간 제한 (밀리초). 이 옵션은 defaultMaxTimeMS 클러스터 매개변수에 해당합니다.
defaultWriteConcern	문자열 드라이버에서 아무것도 지정하지 않은 경우 쓰기 작업을 위해 MongoDB에 요청하는 기본 승인 수준입니다. 이 옵션은 암시적 기본 쓰기 고려에 해당합니다.
javascriptEnabled	부울 클러스터가 서버 측 JavaScript 실행을 수행하는 작업의 실행을 허용하는지 여부를 나타내는 플래그입니다. 8.0+를 사용하는 경우 서버 측 JavaScript를 비활성화하고 집계 파이프라인의 연산자를 사용하는 것이 더 나은 대안입니다. 이 옵션은 `security.javascriptEnabled` 수정에 해당합니다. 클러스터의 각 `mongod` 및 `mongos`에 대한 구성 파일 옵션입니다.
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 window를 사용함을 나타냅니다. 이 옵션은 구성 파일 옵션 `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` 옵션에 해당합니다.
tlsCipherConfigMode	문자열 열거형: "CUSTOM" "DEFAULT" TLS 암호 제품군 구성 모드. 기본값 모드 기본값 암호 제품군을 사용합니다. 사용자 지정 모드 사용하면 TLS 1.2 및 TLS 1.3 모두에 대한 사용자 지정 암호 제품군을 지정할 수 있습니다.
transactionLifetimeLimitSeconds	integer <int64> >= 1 다중 문서 트랜잭션의 수명, 초 단위. Atlas는 이 한도를 초과하는 트랜잭션을 만료된 것으로 간주하여 주기적인 정리 프로세스를 통해 트랜잭션을 중단합니다. 이 옵션은 구성 파일 옵션 `TransactionLifeTimeLimitsSeconds` `mongod`에 해당합니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-08-05+json

{"changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
"chunkMigrationConcurrency": 0,
"customOpensslCipherConfigTls12": ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"defaultMaxTimeMS": 0,
"defaultWriteConcern": "string",
"javascriptEnabled": true,
"minimumEnabledTlsProtocol": "TLS1_0",
"noTableScan": true,
"oplogMinRetentionHours": 0,
"oplogSizeMB": 0,
"queryStatsLogVerbosity": 0,
"sampleRefreshIntervalBIConnector": 0,
"sampleSizeBIConnector": 0,
"tlsCipherConfigMode": "CUSTOM",
"transactionLifetimeLimitSeconds": 1
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2024-08-05+json

{"changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
"chunkMigrationConcurrency": 0,
"customOpensslCipherConfigTls12": ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"defaultMaxTimeMS": 0,
"defaultWriteConcern": "string",
"javascriptEnabled": true,
"minimumEnabledTlsProtocol": "TLS1_0",
"noTableScan": true,
"oplogMinRetentionHours": 0,
"oplogSizeMB": 0,
"queryStatsLogVerbosity": 0,
"sampleRefreshIntervalBIConnector": 0,
"sampleSizeBIConnector": 0,
"tlsCipherConfigMode": "CUSTOM",
"transactionLifetimeLimitSeconds": 1
}

1개의 클러스터에 대해 페일오버 테스트

지정된 프로젝트 의 지정된 클러스터 에 대한 페일오버 테스트를 시작합니다. 클러스터에는 동일한 데이터 세트 유지하는 호스트 그룹 포함되어 있습니다. 페일오버 테스트는 MongoDB Cloud가 클러스터의 프라이머리 노드 장애를 어떻게 처리하는지 확인합니다. 테스트 중에 MongoDB Cloud는 프라이머리 노드 종료하고 새 프라이머리 선택합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 클러스터 관리자 역할 있어야 합니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

401
403
404
500

콘텐츠 유형

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

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"changeStatus": "PENDING",
"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}

MongoDB 직원 클러스터 액세스를 한 클러스터에 부여합니다.

MongoDB 직원 클러스터에 지정된 기간 동안 그리고 한 클러스터에 대해 지정된 수준으로 액세스 권한을 부여합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-08-05+json

액세스 수준 및 만료일을 부여합니다.

expireTime 필수	문자열 <date-time> 직원 액세스 권한 부여의 만료 날짜입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.
grantType 필수	문자열 열거형: 'CLUSTER_DATABASE_LOGS' "CLUSTER_INFRASTRUCTURE" "CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA" MongoDB 직원에게 부여할 액세스 수준입니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-08-05+json

{"expirationTime": "2019-08-24T14:15:22Z",
"grantType": "CLUSTER_DATABASE_LOGS"
}

응답 샘플

콘텐츠 유형

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개의 클러스터에 대한 FCV 고정

현재 MongoDB 버전에 기능 호환성 버전(기능 호환성 버전)을 고정하고 고정 만료 날짜를 설정합니다. 클러스터에 대한 기능 호환성 버전 고정 항목이 이미 존재하는 경우 이 메서드를 호출하면 기존 고정 항목의 만료 날짜만 업데이트되고 기능 호환성 버전이 다시 고정되지 않습니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

요청 본문 스키마: application/vnd.atlas.2024-05-30+json

FCV 고정 구성을 조정하기 위한 선택적 요청 매개변수입니다.

만료 날짜

문자열 <date-time>

고정 FCV 의 만료 날짜입니다. 지정하지 않으면 만료 날짜는 기본적으로 FCV 원래 고정된 날짜로부터 4 주로 기본값 됩니다. 이 필드 고정된 날짜로부터 4 주를 초과할 수 없습니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2024-05-30+json

{"expirationDate": "2019-08-24T14:15:22Z"
}

응답 샘플

콘텐츠 유형

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 직원 클러스터 액세스 권한을 취소합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

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개의 클러스터에 대한 FCV 고정 해제

현재 고정된 기능 호환성 버전을 고정 해제합니다. 이 기능은 빠른 릴리스의 클러스터에서는 사용할 수 없습니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

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 샘플 데이터 세트를 로드하도록 요청합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

이름

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

샘플 데이터 세트를 로드하는 클러스터를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

애플리케이션이 응답을 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

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

sampleDatasetId

필수

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

로드된 샘플 데이터 세트를 식별하는 고유한 24자리 16진수 문자열입니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

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

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

사람이 읽을 수 있는 레이블로, 고정된 네임스페이스를 조회할 클러스터를 식별합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-11-15+json

{"clusterId": "32b6e34b3d91647abb20e7b8",
"groupId": "32b6e34b3d91647abb20e7b8",
"pinnedNamespaces": ["string"
]
}

고정된 네임스페이스 추가

지정된 그룹 및 클러스터에 대한 컬렉션 수준 지연 시간 지표 컬렉션 위해 제공된 네임스페이스 목록을 기존의 고정된 네임스페이스 목록에 추가합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

사람이 읽을 수 있는 레이블로, 네임스페이스를 고정할 클러스터를 식별합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

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

쿼리 지연 시간 지표 수집을 위해 고정할 네임스페이스 문자열(데이터베이스와 컬렉션 이름의 조합) 목록입니다.

namespaces

의 배열 strings unique

지정된 호스트 또는 클러스터의 네임스페이스 string(데이터베이스와 컬렉션의 조합) 목록입니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-11-15+json

{"namespaces": ["string"
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-11-15+json

{"clusterId": "32b6e34b3d91647abb20e7b8",
"groupId": "32b6e34b3d91647abb20e7b8",
"pinnedNamespaces": ["string"
]
}

네임스페이스 고정

지정된 그룹 및 클러스터에 대한 컬렉션 수준 지연 시간 지표 수집을 위해 제공된 네임스페이스 목록을 고정합니다. 이렇게 하면 고정된 네임스페이스 목록이 초기화되거나 그룹 및 클러스터의 기존 고정된 네임스페이스 목록이 바뀝니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

사람이 읽을 수 있는 레이블로, 네임스페이스를 고정할 클러스터를 식별합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

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

쿼리 지연 시간 지표 수집을 위해 고정할 네임스페이스 문자열(데이터베이스와 컬렉션 이름의 조합) 목록입니다.

namespaces

의 배열 strings unique

지정된 호스트 또는 클러스터의 네임스페이스 string(데이터베이스와 컬렉션의 조합) 목록입니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-11-15+json

{"namespaces": ["string"
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-11-15+json

{"clusterId": "32b6e34b3d91647abb20e7b8",
"groupId": "32b6e34b3d91647abb20e7b8",
"pinnedNamespaces": ["string"
]
}

네임스페이스 고정 해제

지정된 그룹 및 클러스터에 대한 컬렉션 수준 지연 시간 지표 컬렉션 위해 제공된 네임스페이스 목록을 고정 해제합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

clusterName

필수

문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$

사람이 읽을 수 있는 레이블로, 네임스페이스를 고정 해제할 클러스터를 식별합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

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

쿼리 지연 시간 지표 수집을 위해 고정할 네임스페이스 문자열(데이터베이스와 컬렉션 이름의 조합) 목록입니다.

namespaces

의 배열 strings unique

지정된 호스트 또는 클러스터의 네임스페이스 string(데이터베이스와 컬렉션의 조합) 목록입니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-11-15+json

{"namespaces": ["string"
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-11-15+json

{"clusterId": "32b6e34b3d91647abb20e7b8",
"groupId": "32b6e34b3d91647abb20e7b8",
"pinnedNamespaces": ["string"
]
}

클러스터에서 순위가 지정된 네임스페이스 반환

주어진 기간 내에서 가장 높은 총 실행 시간(내림차순)을 기준으로 분류된 클러스터의 네임스페이스 하위 집합을 반환합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 사람이 읽을 수 있는 레이블로, 네임스페이스를 고정할 클러스터를 식별합니다.
clusterView 필수	문자열 열거형: "primary" "secondary" "INDIVIDUAL_PROCESS" 사람이 읽을 수 있는 레이블로, 지표를 조회할 클러스터 토폴로지를 식별합니다.

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `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 기간 형식으로 값을 표현합니다. 시작과 끝을 설정하지 않을 경우 이 매개변수를 포함하세요.

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-11-15+json

{"groupId": "32b6e34b3d91647abb20e7b8",
"identifierId": "string",
"rankedNamespaces": ["string"
]
}

클러스터 수준 쿼리 지연 시간 반환

지정된 네임스페이스에 대한 Coll Stats 지연 시간 클러스터 수준 측정 목록을 가져옵니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([a-f0-9]{24})$ 예시: 32b6e34b3d91647abb20e7b8 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. 인증된 사용자가 액세스 권한이 있는 모든 프로젝트를 조회하려면 /groups 엔드포인트를 사용합니다. 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
clusterName 필수	문자열^[a-zA-Z0-9][a-zA-Z0-9-]*$ 사람이 읽을 수 있는 레이블로, 지표를 조회할 클러스터를 식별합니다.
clusterView 필수	문자열 열거형: "primary" "secondary" "INDIVIDUAL_PROCESS" 사람이 읽을 수 있는 레이블로, 지표를 조회할 클러스터 토폴로지를 식별합니다.
databaseName 필수	문자열 예시: mydb 데이터베이스를 식별하는 사람이 읽을 수 있는 레이블입니다.
collectionName 필수	문자열 예시: mycoll 컬렉션을 식별하는 사람이 읽을 수 있는 레이블입니다.

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
지표	의 배열 strings unique 항목 열거형: "READS_OPS" "READS_LATENCY" "AVERAGE_READS_LATENCY" "READS_P50_VALUE" "READS_P95_VALUE" "READS_P99_VALUE" "WRITES_OPS" "WRITES_LATENCY" "AVERAGE_WRITES_LATENCY" 'WRITES_P50_VALUE' 'WRITES_P95_VALUE' 'WRITES_P99_VALUE' 'COMMANDS_OPS' "COMMANDS_LATENCY" "AVERAGE_COMMANDS_LATENCY" "COMMANDS_P50_VALUE" "COMMANDS_P95_VALUE" "COMMANDS_P99_VALUE" "TOTAL_OPS" "TOTAL_LATENCY" "AVERAGE_TOTAL_OPS_LATENCY" "TOTAL_OPS_P50_VALUE" "TOTAL_OPS_P95_VALUE" "TOTAL_OPS_P99_VALUE" 관련 데이터 계열에 대해 조회하려는 지표가 포함된 목록입니다. 이 매개변수를 설정하지 않으면 이 리소스는 모든 컬렉션 지연 시간 통계 지표에 대한 데이터 계열을 반환합니다.
시작하기	문자열 <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": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"measurements": [{"dataPoints": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0
}
],
"name": "string",
"units": "BYTES"
}
],
"processId": "mongodb.example.com:27017",
"start": "2019-08-24T14:15:22Z"
}

모든 지표 이름 반환

요청 시 지정된 프로젝트에 대해 사용 가능한 모든 Coll Stats 지연 시간 지표 이름과 해당 단위를 반환합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

응답

응답 샘플

400
401
403
404
500

콘텐츠 유형

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

필수

문자열^([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` 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 기간 형식으로 값을 표현합니다. 시작과 끝을 설정하지 않을 경우 이 매개변수를 포함하세요.

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-11-15+json

{"groupId": "32b6e34b3d91647abb20e7b8",
"identifierId": "string",
"rankedNamespaces": ["string"
]
}

호스트 수준 쿼리 지연 시간 반환

지정된 네임스페이스 에 대한 콜 통계 지연 시간 프로세스 수준 측정값의 목록을 가져옵니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId 필수	문자열^([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` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
지표	의 배열 strings unique 항목 열거형: "READS_OPS" "READS_LATENCY" "AVERAGE_READS_LATENCY" "READS_P50_VALUE" "READS_P95_VALUE" "READS_P99_VALUE" "WRITES_OPS" "WRITES_LATENCY" "AVERAGE_WRITES_LATENCY" 'WRITES_P50_VALUE' 'WRITES_P95_VALUE' 'WRITES_P99_VALUE' 'COMMANDS_OPS' "COMMANDS_LATENCY" "AVERAGE_COMMANDS_LATENCY" "COMMANDS_P50_VALUE" "COMMANDS_P95_VALUE" "COMMANDS_P99_VALUE" "TOTAL_OPS" "TOTAL_LATENCY" "AVERAGE_TOTAL_OPS_LATENCY" "TOTAL_OPS_P50_VALUE" "TOTAL_OPS_P95_VALUE" "TOTAL_OPS_P99_VALUE" 관련 데이터 계열에 대해 조회하려는 지표가 포함된 목록입니다. 이 매개변수를 설정하지 않으면 이 리소스는 모든 컬렉션 지연 시간 통계 지표에 대한 데이터 계열을 반환합니다.
시작하기	문자열 <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": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"measurements": [{"dataPoints": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0
}
],
"name": "string",
"units": "BYTES"
}
],
"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

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

[{"actions": [{"action": "FIND",
"resources": [{"cluster": true,
"collection": "string",
"db": "string"
}
]
}
],
"inheritedRoles": [{"db": "string",
"role": "string"
}
],
"roleName": "string"
}
]

1개의 사용자 지정 역할 만들기

지정된 프로젝트 에 하나의 사용자 지정 역할 만듭니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할, 프로젝트 스트림 처리 소유자 역할 또는 프로젝트 데이터베이스 액세스 관리자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

지정된 프로젝트에 하나의 사용자 지정 역할을 만듭니다.

	의 배열 객체 (데이터베이스 권한 작업) 역할이 부여하는 개별 권한 작업의 목록.
	의 배열 객체 (상속된 역할) unique 이 사용자 지정 역할이 상속하는 기본 제공 역할의 목록.
roleName 필수	문자열 요청에 대한 역할을 식별하는 인간 판독 가능 레이블. 이 프로젝트에 포함된 이 사용자 지정 역할에 대해 고유한 이름이어야 합니다.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"actions": [{"action": "FIND",
"resources": [{"cluster": true,
"collection": "string",
"db": "string"
}
]
}
],
"inheritedRoles": [{"db": "string",
"role": "string"
}
],
"roleName": "string"
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"actions": [{"action": "FIND",
"resources": [{"cluster": true,
"collection": "string",
"db": "string"
}
]
}
],
"inheritedRoles": [{"db": "string",
"role": "string"
}
],
"roleName": "string"
}

1개의 프로젝트에서 1개의 사용자 지정 역할 제거

지정된 프로젝트 에서 사용자 지정 역할 하나를 제거합니다. 상위 역할이나 작업이 없는 하나 이상의 하위 역할을 남겨두는 사용자 지정 역할 제거 할 수 없습니다. 또한 한 명 이상의 데이터베이스 사용자를 역할 없이 남겨두는 사용자 지정 역할 제거 할 수 없습니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할, 프로젝트 스트림 처리 소유자 역할 또는 프로젝트 데이터베이스 액세스 관리자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

roleName

필수

문자열

요청에 대한 역할을 식별하는 인간 판독 가능 레이블. 이 프로젝트에 포함된 이 사용자 지정 역할에 대해 고유한 이름이어야 합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

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

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

roleName

필수

문자열

요청에 대한 역할을 식별하는 인간 판독 가능 레이블. 이 프로젝트에 포함된 이 사용자 지정 역할에 대해 고유한 이름이어야 합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"actions": [{"action": "FIND",
"resources": [{"cluster": true,
"collection": "string",
"db": "string"
}
]
}
],
"inheritedRoles": [{"db": "string",
"role": "string"
}
],
"roleName": "string"
}

1개의 프로젝트에서 1개의 사용자 지정 역할 업데이트

지정된 프로젝트 에서 하나의 사용자 지정 역할 업데이트합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할, 프로젝트 스트림 처리 소유자 역할 또는 프로젝트 데이터베이스 액세스 관리자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

roleName

필수

문자열

요청에 대한 역할을 식별하는 인간 판독 가능 레이블. 이 이름은 이 프로젝트에서 이 사용자 지정 역할에 대해 고유해야 합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

지정된 프로젝트의 사용자 지정 역할 하나를 업데이트합니다.

	의 배열 객체 (데이터베이스 권한 작업) 역할이 부여하는 개별 권한 작업의 목록.
	의 배열 객체 (상속된 역할) unique 이 사용자 지정 역할이 상속하는 기본 제공 역할의 목록.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"actions": [{"action": "FIND",
"resources": [{"cluster": true,
"collection": "string",
"db": "string"
}
]
}
],
"inheritedRoles": [{"db": "string",
"role": "string"
}
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"actions": [{"action": "FIND",
"resources": [{"cluster": true,
"collection": "string",
"db": "string"
}
]
}
],
"inheritedRoles": [{"db": "string",
"role": "string"
}
],
"roleName": "string"
}

데이터 페더레이션

연합 데이터베이스 인스턴스를 반환, 추가, 편집 및 제거합니다. 이 리소스에는 프로젝트 ID가 필요합니다. 연합 데이터베이스 인스턴스 구성을 변경하면 비용에 영향을 미칠 수 있습니다.

1개의 프로젝트에서 모든 연합 데이터베이스 인스턴스 반환

지정된 프로젝트 에 있는 모든 연합 데이터베이스 인스턴스의 세부 정보를 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 이상의 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint
유형	문자열 기본값입니다: "USER" 열거형: "USER" "ONLINE_ARCHIVE" 반환할 연합 데이터베이스 인스턴스 유형.

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

[{"cloudProviderConfig": {"aws": {"externalId": "string",
"iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
"iamUserARN": "string",
"roleId": "32b6e34b3d91647abb20e7b8"
},
"azure": {"atlasAppId": "string",
"roleId": "32b6e34b3d91647abb20e7b8",
"servicePrincipalId": "string",
"tenantId": "string"
},
"gcp": {"gcpServiceAccount": "string",
"roleId": "32b6e34b3d91647abb20e7b8"
}
},
"dataProcessRegion": {"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
},
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnames": ["string"
],
"name": "string",
"privateEndpointHostnames": [{"hostname": "string",
"privateEndpoint": "string"
}
],
"state": "UNVERIFIED",
"storage": {"databases": [{"collections": [{"dataSources": [{"allowInsecure": false,
"collection": "string",
"collectionRegex": "string",
"database": "string",
"databaseRegex": "string",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetPrefix": "string",
"defaultFormat": ".avro",
"path": "string",
"provenanceFieldName": "string",
"storeName": "string",
"trimLevel": 0,
"urls": [null
]
}
],
"name": "string"
}
],
"maxWildcardCollections": 100,
"name": "string",
"views": [{"name": "string",
"pipeline": "string",
"source": "string"
}
]
}
],
"stores": [{"name": "string",
"provider": "string",
"additionalStorageClasses": ["STANDARD"
],
"bucket": "string",
"delimiter": "string",
"includeTags": false,
"prefix": "string",
"public": false,
"region": "US_GOV_WEST_1"
}
]
}
}
]

1개의 프로젝트에 1개의 연합 데이터베이스 인스턴스 만들기

지정된 프로젝트 에 하나의 연합 데이터베이스 인스턴스 만듭니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 또는 프로젝트 Charts 관리자 역할이 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint
skipRoleValidation	부울 기본값입니다: 거짓 요청한 IAM 역할이 S3 버킷에서 읽을 수 있는지를 이 요청에서 확인해야 하는지 여부를 나타내는 플래그. AWS는 버킷에 쓰기 전에 역할이 버킷에 있는 객체를 나열할 수 있는지 확인합니다. 일부 IAM 역할에는 쓰기 권한만 필요합니다. 이 플래그를 사용하면 해당 확인 과정을 건너뛸 수 있습니다.

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

지정된 프로젝트에 하나의 연합 데이터베이스 인스턴스를 만들기 위한 세부 정보.

	객체 (데이터 페더레이션 클라우드 공급자) 이 연합 데이터베이스 인스턴스가 호스팅되는 클라우드 제공자입니다.
	객체 (DataLakeDataProcessRegion) 연합 데이터베이스 인스턴스가 클라이언트 연결을 라우팅하는 클라우드 공급자 리전에 대한 정보입니다.
이름	문자열 연합 데이터베이스 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.
	객체 (DataLakeStorage) 각 데이터 저장소 구성 정보 및 MongoDB Cloud 데이터베이스에 대한 매핑.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"cloudProviderConfig": {"aws": {"roleId": "32b6e34b3d91647abb20e7b8",
"testS3Bucket": "string"
},
"azure": {"roleId": "32b6e34b3d91647abb20e7b8"
},
"gcp": {"roleId": "32b6e34b3d91647abb20e7b8"
}
},
"dataProcessRegion": {"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
},
"name": "string",
"storage": {"databases": [{"collections": [{"dataSources": [{"allowInsecure": false,
"collection": "string",
"collectionRegex": "string",
"database": "string",
"databaseRegex": "string",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetPrefix": "string",
"defaultFormat": ".avro",
"path": "string",
"provenanceFieldName": "string",
"storeName": "string",
"trimLevel": 0,
"urls": ["string"
]
}
],
"name": "string"
}
],
"maxWildcardCollections": 100,
"name": "string",
"views": [{"name": "string",
"pipeline": "string",
"source": "string"
}
]
}
],
"stores": [{"name": "string",
"provider": "string",
"additionalStorageClasses": ["STANDARD"
],
"bucket": "string",
"delimiter": "string",
"includeTags": false,
"prefix": "string",
"public": false,
"region": "US_GOV_WEST_1"
}
]
}
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"cloudProviderConfig": {"aws": {"externalId": "string",
"iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
"iamUserARN": "string",
"roleId": "32b6e34b3d91647abb20e7b8"
},
"azure": {"atlasAppId": "string",
"roleId": "32b6e34b3d91647abb20e7b8",
"servicePrincipalId": "string",
"tenantId": "string"
},
"gcp": {"gcpServiceAccount": "string",
"roleId": "32b6e34b3d91647abb20e7b8"
}
},
"dataProcessRegion": {"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
},
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnames": ["string"
],
"name": "string",
"privateEndpointHostnames": [{"hostname": "string",
"privateEndpoint": "string"
}
],
"state": "UNVERIFIED",
"storage": {"databases": [{"collections": [{"dataSources": [{"allowInsecure": false,
"collection": "string",
"collectionRegex": "string",
"database": "string",
"databaseRegex": "string",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetPrefix": "string",
"defaultFormat": ".avro",
"path": "string",
"provenanceFieldName": "string",
"storeName": "string",
"trimLevel": 0,
"urls": ["string"
]
}
],
"name": "string"
}
],
"maxWildcardCollections": 100,
"name": "string",
"views": [{"name": "string",
"pipeline": "string",
"source": "string"
}
]
}
],
"stores": [{"name": "string",
"provider": "string",
"additionalStorageClasses": ["STANDARD"
],
"bucket": "string",
"delimiter": "string",
"includeTags": false,
"prefix": "string",
"public": false,
"region": "US_GOV_WEST_1"
}
]
}
}

1개의 프로젝트에서 1개의 연합 데이터베이스 인스턴스 제거

지정된 프로젝트 에서 연합 데이터베이스 인스턴스 한 개를 제거합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 또는 프로젝트 Charts 관리자 역할이 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

tenantName

필수

문자열

제거할 연합 데이터베이스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

401
403
404
500

콘텐츠 유형

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 키에 프로젝트 읽기 전용 또는 프로젝트 Charts 관리자 역할이 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

tenantName

필수

문자열

반환할 연합 데이터베이스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"cloudProviderConfig": {"aws": {"externalId": "string",
"iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
"iamUserARN": "string",
"roleId": "32b6e34b3d91647abb20e7b8"
},
"azure": {"atlasAppId": "string",
"roleId": "32b6e34b3d91647abb20e7b8",
"servicePrincipalId": "string",
"tenantId": "string"
},
"gcp": {"gcpServiceAccount": "string",
"roleId": "32b6e34b3d91647abb20e7b8"
}
},
"dataProcessRegion": {"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
},
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnames": ["string"
],
"name": "string",
"privateEndpointHostnames": [{"hostname": "string",
"privateEndpoint": "string"
}
],
"state": "UNVERIFIED",
"storage": {"databases": [{"collections": [{"dataSources": [{"allowInsecure": false,
"collection": "string",
"collectionRegex": "string",
"database": "string",
"databaseRegex": "string",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetPrefix": "string",
"defaultFormat": ".avro",
"path": "string",
"provenanceFieldName": "string",
"storeName": "string",
"trimLevel": 0,
"urls": ["string"
]
}
],
"name": "string"
}
],
"maxWildcardCollections": 100,
"name": "string",
"views": [{"name": "string",
"pipeline": "string",
"source": "string"
}
]
}
],
"stores": [{"name": "string",
"provider": "string",
"additionalStorageClasses": ["STANDARD"
],
"bucket": "string",
"delimiter": "string",
"includeTags": false,
"prefix": "string",
"public": false,
"region": "US_GOV_WEST_1"
}
]
}
}

1개의 프로젝트에서 1개의 연합 데이터베이스 인스턴스 업데이트

지정된 프로젝트 에 있는 하나의 연합 데이터베이스 인스턴스 에 대한 세부 정보를 업데이트합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 이상의 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

tenantName

필수

문자열

업데이트할 연합 데이터베이스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint
skipRoleValidation 필수	부울 요청한 IAM 역할이 S3 버킷에서 읽을 수 있는지를 이 요청에서 확인해야 하는지 여부를 나타내는 플래그. AWS는 버킷에 쓰기 전에 역할이 버킷에 있는 객체를 나열할 수 있는지 확인합니다. 일부 IAM 역할에는 쓰기 권한만 필요합니다. 이 플래그를 사용하면 해당 확인 과정을 건너뛸 수 있습니다.

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

지정된 프로젝트에서 업데이트할 연합 데이터베이스 한 개에 대한 세부 정보.

	객체 (데이터 페더레이션 클라우드 공급자) 이 연합 데이터베이스 인스턴스가 호스팅되는 클라우드 제공자입니다.
	객체 (DataLakeDataProcessRegion) 연합 데이터베이스 인스턴스가 클라이언트 연결을 라우팅하는 클라우드 공급자 리전에 대한 정보입니다.
이름	문자열 연합 데이터베이스 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다.
	객체 (DataLakeStorage) 각 데이터 저장소 구성 정보 및 MongoDB Cloud 데이터베이스에 대한 매핑.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"cloudProviderConfig": {"aws": {"roleId": "32b6e34b3d91647abb20e7b8",
"testS3Bucket": "string"
},
"azure": {"roleId": "32b6e34b3d91647abb20e7b8"
},
"gcp": {"roleId": "32b6e34b3d91647abb20e7b8"
}
},
"dataProcessRegion": {"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
},
"name": "string",
"storage": {"databases": [{"collections": [{"dataSources": [{"allowInsecure": false,
"collection": "string",
"collectionRegex": "string",
"database": "string",
"databaseRegex": "string",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetPrefix": "string",
"defaultFormat": ".avro",
"path": "string",
"provenanceFieldName": "string",
"storeName": "string",
"trimLevel": 0,
"urls": ["string"
]
}
],
"name": "string"
}
],
"maxWildcardCollections": 100,
"name": "string",
"views": [{"name": "string",
"pipeline": "string",
"source": "string"
}
]
}
],
"stores": [{"name": "string",
"provider": "string",
"additionalStorageClasses": ["STANDARD"
],
"bucket": "string",
"delimiter": "string",
"includeTags": false,
"prefix": "string",
"public": false,
"region": "US_GOV_WEST_1"
}
]
}
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"cloudProviderConfig": {"aws": {"externalId": "string",
"iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
"iamUserARN": "string",
"roleId": "32b6e34b3d91647abb20e7b8"
},
"azure": {"atlasAppId": "string",
"roleId": "32b6e34b3d91647abb20e7b8",
"servicePrincipalId": "string",
"tenantId": "string"
},
"gcp": {"gcpServiceAccount": "string",
"roleId": "32b6e34b3d91647abb20e7b8"
}
},
"dataProcessRegion": {"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
},
"groupId": "32b6e34b3d91647abb20e7b8",
"hostnames": ["string"
],
"name": "string",
"privateEndpointHostnames": [{"hostname": "string",
"privateEndpoint": "string"
}
],
"state": "UNVERIFIED",
"storage": {"databases": [{"collections": [{"dataSources": [{"allowInsecure": false,
"collection": "string",
"collectionRegex": "string",
"database": "string",
"databaseRegex": "string",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetPrefix": "string",
"defaultFormat": ".avro",
"path": "string",
"provenanceFieldName": "string",
"storeName": "string",
"trimLevel": 0,
"urls": ["string"
]
}
],
"name": "string"
}
],
"maxWildcardCollections": 100,
"name": "string",
"views": [{"name": "string",
"pipeline": "string",
"source": "string"
}
]
}
],
"stores": [{"name": "string",
"provider": "string",
"additionalStorageClasses": ["STANDARD"
],
"bucket": "string",
"delimiter": "string",
"includeTags": false,
"prefix": "string",
"public": false,
"region": "US_GOV_WEST_1"
}
]
}
}

1개의 연합 데이터베이스 인스턴스에 대해 모든 쿼리 제한 반환

지정된 프로젝트 의 연합 데이터베이스 인스턴스 에 대한 쿼리 제한을 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

tenantName

필수

문자열

쿼리 제한을 검색하려는 연합 데이터베이스 인스턴스를 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

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

필수

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

응답

응답 샘플

400
401
403
404
500

콘텐츠 유형

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

필수

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

200
401
403
404
500

콘텐츠 유형

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

필수

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

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

하나의 연합 데이터베이스 인스턴스에 대해 쿼리 제한을 한 개 만들거나 업데이트합니다.

overrunPolicy	문자열 열거형: "차단" "BLOCK_AND_KILL" 데이터 페더레이션 한도에만 사용됩니다. 사용량 한도 초과 시 취해야 할 조치입니다. 한도 범위를 'QUERY'로 설정한 경우 MongoDB Cloud는 사용량 한도를 초과하면 쿼리를 중지하므로 이러한 한도를 무시됩니다.
value 필수	integer <int64> 한도의 크기.

응답

샘플 요청

Payload

콘텐츠 유형

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: 애플리케이션 /vnd.atlas.YYYY-MM-DD+gzip' 형식의 수락 헤더를 사용하여 gzip 응답 스키마 요청 해야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

문자열^([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 키에 프로젝트 읽기 전용 또는 프로젝트 Charts 관리자 역할이 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope	부울 기본값입니다: 거짓 애플리케이션이 응답을 `envelope` JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
includeCount	부울 기본값입니다: true 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
itemsPerPage	integer [ 1 .. 500 ] 기본값입니다: 100 페이지당 응답이 반환하는 항목 수입니다.
pageNum	integer >= 1 기본값입니다: 1 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
pretty	부울 기본값입니다: 거짓 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}
],
"totalCount": 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 키에 프로젝트 소유자 또는 프로젝트 Charts 관리자 역할이 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

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

지정된 프로젝트에 추가할 연합 데이터베이스 인스턴스 및 온라인 아카이브에 대한 프라이빗 엔드포인트입니다.

azureLinkId	문자열 Azure 비공개 엔드포인트 연결을 식별하는 링크 ID 입니다.
comment	문자열 이 비공개 엔드포인트에 연결할 인간 판독 가능 문자열.
customerEndpointDNSName	문자열 고객의 VPC 엔드포인트 DNS 이름을 식별하는 인간 가독형 레이블. 정의된 경우 리전 값도 지정해야 합니다.
customerEndpointIPAddress	문자열^((25[0-5]\|(2[0-4]\|1\d\|[1-9]\|)\d)(\.(?!$)\|$))... Azure 비공개 엔드포인트에 연결하는 데 사용되는 IP 주소 입니다.
endpointId 필수	문자열^vpce-[0-9a-f]{17}$ 비공개 엔드포인트를 식별하는 고유한 22자 영숫자 문자열입니다. Atlas Data Lake는 AWS PrivateLink 기능을 사용하여 Amazon Web Services 프라이빗 엔드포인트를 지원합니다.
오류 메시지	문자열 비공개 엔드포인트 요청 승인 실패를 설명하는 오류 메시지입니다.
provider	문자열 기본값입니다: "A" 값: "A" 클라우드 서비스 제공자를 식별하는 인간 판독 가능 레이블. Atlas Data Lake는 Amazon Web Services만 지원합니다.
리전	문자열 고객의 VPC 엔드포인트 리전을 식별하기 위한 사람이 인간 가독형 레이블. 정의된 경우 customerEndpointDNSName 값도 지정해야 합니다.
상태	문자열 열거형: "PENDING" "OK" "FAILED" "DELETING" 비공개 엔드포인트 연결 요청 의 상태입니다.
유형	문자열 기본값입니다: "DATA_LAKE" 값: "DATA_LAKE" 이 프라이빗 엔드포인트와 연결된 리소스 유형을 식별하는 인간 판독 가능 레이블.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"links": [{"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [{"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}
],
"totalCount": 0
}

1개의 프로젝트에서 1개의 연합 데이터베이스 인스턴스 및 온라인 아카이브 비공개 엔드포인트 제거

지정된 프로젝트 에서 연합 데이터베이스 인스턴스 및 온라인 아카이브에 대한 비공개 엔드포인트 한 개를 제거합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

endpointId

필수

문자열^vpce-[0-9a-f]{17}$

제거할 프라이빗 엔드포인트를 식별하는 고유한 22자 영숫자 문자열. Atlas Data Federation은 AWS PrivateLink 기능을 사용하여 AWS 프라이빗 엔드포인트를 지원합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

401
403
404
500

콘텐츠 유형

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 키에 프로젝트 읽기 전용 또는 프로젝트 Charts 관리자 역할이 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

endpointId

필수

문자열^vpce-[0-9a-f]{17}$

반환할 비공개 엔드포인트를 식별하는 고유한 22자 영숫자 문자열입니다. Atlas Data Federation은 AWS PrivateLink 기능을 사용하여 AWS 프라이빗 엔드포인트를 지원합니다.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"azureLinkId": "string",
"comment": "string",
"customerEndpointDNSName": "string",
"customerEndpointIPAddress": "string",
"endpointId": "vpce-3bf78b0ddee411ba1",
"errorMessage": "string",
"provider": "AWS",
"region": "US_EAST_1",
"status": "PENDING",
"type": "DATA_LAKE"
}

Data Lake 파이프라인

Atlas Data Lake 파이프라인 및 관련 실행을 반환, 편집 및 제거합니다.

데이터 레이크 파이프라인은 더 이상 사용되지 않습니다. 데이터 레이크 사용 중단 가이드를 참조하세요.

1개의 프로젝트에서 모든 데이터 레이크 파이프라인 반환 사용 중단됨

Data Lake 파이프라인 목록을 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

[{"_id": "32b6e34b3d91647abb20e7b8",
"createdDate": "2019-08-24T14:15:22Z",
"datasetRetentionPolicy": {"lastModifiedDate": "2019-08-24T14:15:22Z",
"units": "DAYS",
"value": 1
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"name": "string",
"sink": {"type": "DLS"
},
"source": {"type": "PERIODIC_CPS"
},
"state": "ACTIVE",
"transformations": [{"field": "string",
"type": "EXCLUDE"
}
]
}
]

데이터 레이크 파이프라인 1개 만들기 중단됨

Data Lake 파이프라인을 한 개 생성합니다.

데이터 레이크 파이프라인은 더 이상 사용되지 않습니다. 데이터 레이크 사용 중단 가이드를 참조하세요.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

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

Data Lake 파이프라인을 한 개 생성합니다.

	객체 (데이터 세트 보존 정책) 예약된 데이터 레이크 파이프라인에 적용되는 데이터 세트 보존 정책.
이름	문자열 이 Data Lake 파이프라인의 이름.
	객체 (수집 대상) Data Lake 파이프라인의 수집 대상.
	객체 (수집 소스) Data Lake 파이프라인의 수집 소스.
	의 배열 객체 (필드 변환) 이 Data Lake 파이프라인에서 제외할 필드.

응답

샘플 요청

Payload

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"datasetRetentionPolicy": {"units": "DAYS",
"value": 1
},
"name": "string",
"sink": { },
"source": {"type": "PERIODIC_CPS"
},
"transformations": [{"field": "string",
"type": "EXCLUDE"
}
]
}

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"_id": "32b6e34b3d91647abb20e7b8",
"createdDate": "2019-08-24T14:15:22Z",
"datasetRetentionPolicy": {"lastModifiedDate": "2019-08-24T14:15:22Z",
"units": "DAYS",
"value": 1
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"name": "string",
"sink": {"type": "DLS"
},
"source": {"type": "PERIODIC_CPS"
},
"state": "ACTIVE",
"transformations": [{"field": "string",
"type": "EXCLUDE"
}
]
}

데이터 레이크 파이프라인 1개 제거 중단됨

Data Lake 파이프라인을 한 개 제거합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

pipelineName

필수

문자열^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

응답

응답 샘플

401
403
404
500

콘텐츠 유형

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개의 데이터 레이크 파이프라인 반환 사용 중단됨

지정된 프로젝트 내 Data Lake 파이프라인 한 개에 대한 세부 정보를 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할 있어야 합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

pipelineName

필수

문자열^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

pretty

부울

기본값입니다: 거짓

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

Prettyprint

응답

응답 샘플

콘텐츠 유형

application/vnd.atlas.2023-01-01+json

{"_id": "32b6e34b3d91647abb20e7b8",
"createdDate": "2019-08-24T14:15:22Z",
"datasetRetentionPolicy": {"lastModifiedDate": "2019-08-24T14:15:22Z",
"units": "DAYS",
"value": 1
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"name": "string",
"sink": {"type": "DLS"
},
"source": {"type": "PERIODIC_CPS"
},
"state": "ACTIVE",
"transformations": [{"field": "string",
"type": "EXCLUDE"
}
]
}

데이터 레이크 파이프라인 하나 업데이트(더 이상 사용되지 않음)

Data Lake 파이프라인을 한 개 업데이트합니다.

권한 부여

서비스 계정DigestAuth

경로 매개변수

groupId

필수

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

예시: 32b6e34b3d91647abb20e7b8

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

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

pipelineName

필수

문자열^[^/\\ "$]{1,64}$

Data Lake 파이프라인을 식별하는 인간 판독 가능 레이블.

쿼리 매개변수

envelope

부울

기본값입니다: 거짓

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

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

Data Lake 파이프라인을 한 개 업데이트합니다.

	객체 (데이터 세트 보존 정책) 예약된 데이터 레이크 파이프라인에 적용되는 데이터 세트 보존 정책.
이름	문자열 이 Data Lake 파이프라인의 이름.