문서 메뉴
문서 홈
/
MongoDB Ops Manager
/
API
/
Ops Manager 관리 API 리소스
/
백업 및 복원
/
백업 구성

1개의 프로젝트에서 1개의 백업 구성 가져오기

이 페이지의 내용

  • 리소스
  • 요청 매개변수
  • 요청 경로 매개변수
  • 요청 쿼리 매개변수
  • 요청 본문 매개변수
  • 응답
  • 요청 예시
  • 응답 예시
  • 응답 헤더
  • 응답 본문

참고

그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.

기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

리소스

GET /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}

요청 매개변수

요청 경로 매개변수

매개변수
유형
필요성
설명
프로젝트 ID
문자열
필수 사항
찾으려는 백업 구성이 있는 cluster를 보유하는 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다.
CLUSTER-ID
문자열
필수 사항
백업 구성을 찾으려는 cluster를 식별하는 고유한 24자리 16진수 문자열입니다.

요청 쿼리 매개변수

다음 쿼리 매개변수는 선택 사항입니다.

이름
유형
필요성
설명
기본값
pretty
부울
옵션
응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타내는 플래그입니다. 형식.
false
envelope
부울
옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다.

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름
설명
상태
HTTP 응답 코드
envelope
예상되는 응답 본문
false

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답

이름
유형
설명
availableMembers
문자열 배열
백업에 사용할 수 있는 cluster 멤버 목록입니다. 회원 요청에 대해서만 표시됩니다.
clusterId
문자열
백업을 위해 구성할 cluster를 식별하는 고유한 24자리 16진수 문자열입니다.
encryptionEnabled
부울

백업 구성에 암호화가 활성화되어 있는지 여부를 나타내는 플래그입니다. 백업 구성에 대한 암호화를 활성화할 때 syncSource 필드를 포함해야 합니다. 프로젝트의 기존 백업의 경우 암호화를 활성화하려면 백업의 헤드 데이터베이스를 다시 만들기 위한 초기 동기화 가 필요합니다.

참고

FCV FCV 4.2 이상에서는 헤드 데이터베이스 대신 백업 커서 를 사용합니다. 자세한 내용은 백업 데몬 서비스를 참조하세요.

FCV 4.2 이상의 백업 암호화에 대한 자세한 내용은 암호화된 백업 스냅샷을 참조하세요.

제외된 네임스페이스
문자열 배열

백업에서 생략할 데이터베이스 이름 및 collection 이름 목록입니다. 각 문자열은 {database} 또는 {database}.{collection} 형식의 네임스페이스입니다. 이 필드가 있는 경우 includedNamespaces 필드는 있을 수 없습니다.

이미 나열된 네임스페이스를 포함하여 제외된 네임스페이스의 새로운 전체 목록을 보내야 합니다.

새 목록이 이전 목록의 네임스페이스를 제거하는 경우 제외된 네임스페이스를 제거하면 전체 재동기화가 필요하므로 syncSource 필드도 설정해야 합니다. syncSource 필드가 없으면 요청이 실패합니다.

새 목록이 이전 목록에만 추가되는 경우 syncSource 을 설정할 필요가 없습니다.

groupId
문자열
이 백업 구성을 소유하는 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다.
includeNamespaces
문자열 배열

백업에 포함할 데이터베이스 이름 및 collection 이름 목록입니다. 각 문자열은 {database} 또는 {database}.{collection} 형식의 네임스페이스입니다. 이 배열에 포함 되지 않은 네임스페이스 는 백업되지 않습니다. 이 필드가 있는 경우 excludedNamespaces 필드는 있을 수 없습니다.

이미 나열된 네임스페이스를 포함하여 포함된 네임스페이스의 새로운 전체 목록을 보내야 합니다.

새 목록이 이전 목록에 네임스페이스를 추가하는 경우 포함된 네임스페이스를 추가하면 전체 재동기화가 필요하므로 syncSource 필드도 설정해야 합니다. syncSource 필드가 없으면 요청이 실패합니다.

새 목록이 이전 목록의 네임스페이스만 제거하는 경우 syncSource 을 설정할 필요가 없습니다.

링크
객체 배열

하위 리소스 및/또는 관련 리소스에 links 대한 하나 이상의 링크입니다. 응답의 모든 배열에는 이라는 링크가 하나 이상 포함되어 self 있습니다.URL 간의 관계는 웹 링크 사양에설명되어 있습니다.

preferenceMember
문자열
백업에 대한 기본 멤버로 수동으로 지정된 cluster 멤버. UI 또는 API를 사용하여 기본 멤버가 설정된 경우 멤버 요청에 대해서만 표시됩니다.
sslEnabled
부울
동기화 소스 데이터베이스에 대해 TLS 를 사용하도록 설정했는지 여부를 나타내는 플래그입니다.
statusName
문자열

백업 구성의 현재(또는 원하는) 상태입니다. 가능한 값은 다음과 같습니다.

  • INACTIVE

  • PROVISIONING

  • STARTED

  • STOPPED

  • TERMINATING

storageEngineName
문자열

백업에 사용되는 스토리지 엔진입니다. 가능한 값은 다음과 같습니다.

  • MEMORY_MAPPED

  • WIRED_TIGER

요청 예시

응답 예시

응답 헤더

HTTP/1.1 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
HTTP/1.1 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개의 프로젝트에 대해 모든 백업 구성 가져오기
1개의 백업 구성 업데이트 →

이 페이지의 내용