1개의 프로젝트에서 1개의 백업 구성 가져오기
- Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.
- 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.
참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
기본 URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}
요청 매개변수
요청 경로 매개변수
Parameter | 유형 | 필요성 | 설명 |
|---|---|---|---|
프로젝트 ID | 문자열 | 필수 사항 | 찾으려는 백업 구성이 있는 cluster를 보유하는 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. |
CLUSTER-ID | 문자열 | 필수 사항 | 백업 구성을 찾으려는 cluster를 식별하는 고유한 24자리 16진수 문자열입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
이름 | 유형 | 설명 |
|---|---|---|
availableMembers | 문자열 배열 | 백업에 사용할 수 있는 cluster 멤버 목록입니다. 회원 요청에 대해서만 표시됩니다. |
clusterId | 문자열 | 백업을 위해 구성할 cluster를 식별하는 고유한 24자리 16진수 문자열입니다. |
제외된 네임스페이스 | 문자열 배열 | 백업에서 생략할 데이터베이스 이름 및 collection 이름 목록입니다. 각 문자열은 이미 나열된 네임스페이스를 포함하여 제외된 네임스페이스의 새로운 전체 목록을 보내야 합니다. 새 목록이 이전 목록의 네임스페이스를 제거하는 경우 제외된 네임스페이스를 제거하면 전체 재동기화가 필요하므로 새 목록이 이전 목록에만 추가되는 경우 |
groupId | 문자열 | 이 백업 구성을 소유하는 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. |
includeNamespaces | 문자열 배열 | 백업에 포함할 데이터베이스 이름 및 collection 이름 목록입니다. 각 문자열은 이미 나열된 네임스페이스를 포함하여 포함된 네임스페이스의 새로운 전체 목록을 보내야 합니다. 새 목록이 이전 목록에 네임스페이스를 추가하는 경우 포함된 네임스페이스를 추가하면 전체 재동기화가 필요하므로 새 목록이 이전 목록의 네임스페이스만 제거하는 경우 |
링크 | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
preferenceMember | 문자열 | 백업에 대한 기본 멤버로 수동으로 지정된 cluster 멤버. UI 또는 API를 사용하여 기본 멤버가 설정된 경우 멤버 요청에 대해서만 표시됩니다. |
sslEnabled | 부울 | 동기화 소스 데이터베이스에 대해 TLS 를 사용하도록 설정했는지 여부를 나타내는 플래그입니다. |
statusName | 문자열 | 백업 구성의 현재(또는 원하는) 상태입니다. 가능한 값은 다음과 같습니다.
|
storageEngineName | 문자열 | 백업에 사용되는 스토리지 엔진입니다. 가능한 값은 다음과 같습니다.
|
요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}"
각 스냅샷이 시작되면 Cloud Manager는 스냅샷을 실행할 복제본 세트 멤버를 선택합니다. 자동으로 선택된 이 멤버는 복제본 세트에 미치는 성능 영향이 가장 적어야 합니다. 기본 선택 항목을 재정의할 수 있습니다.
중요
가능하면 default selection 를 사용하세요. 이 선택은 백업 가용성을 보장합니다.
다음 요청 은 사용 가능한 멤버를 반환합니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/availableMembers?pretty=true"
응답 예시
응답 헤더
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
응답 본문
1 { 2 "clusterId" : "{CLUSTER-ID}", 3 "excludedNamespaces" : [ ], 4 "groupId" : "{PROJECT-ID}", 5 "includedNamespaces" : [ ], 6 "links" : [ ], 7 "sslEnabled" : false, 8 "statusName" : "STARTED", 9 "storageEngineName" : "WIRED_TIGER" 10 }
각 스냅샷이 시작되면 Cloud Manager는 스냅샷을 실행할 복제본 세트 멤버를 선택합니다. 자동으로 선택된 이 멤버는 복제본 세트에 미치는 성능 영향이 가장 적어야 합니다. 기본 선택 항목을 재정의할 수 있습니다.
중요
가능하면 default selection 을(를) 사용하세요. 이렇게 하면 백업 가용성이 보장됩니다.
다음 응답에는 사용 가능한 멤버와 지정된 기본 멤버가 포함됩니다. 기본 멤버가 정의되지 않은 경우 응답에서 제외됩니다.
1 { 2 "availableMembers" : [ "{HOSTNAME1}:{PORT1}", "{HOSTNAME2}:{PORT2}", "{HOSTNAME3}:{PORT3}"], 3 "clusterId" : "{CLUSTER-ID}", 4 "excludedNamespaces" : [ ], 5 "groupId" : "{PROJECT-ID}", 6 "includedNamespaces" : [ ], 7 "links" : [ ], 8 "sslEnabled" : false, 9 "statusName" : "STARTED", 10 "storageEngineName" : "WIRED_TIGER", 11 "preferredMember" : "{HOSTNAME1}:{PORT1}" 12 }