Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
Cloud Manager 관리 API 리소스
/
백업 및 복원
/
스냅샷

하나의 Config 서버에 대한 모든 스냅샷 가져오기

이 페이지의 내용

  • Resource
  • 요청 매개변수
  • 요청 경로 매개변수
  • 요청 쿼리 매개변수
  • 요청 본문 매개변수
  • 응답
  • 응답 문서
  • results embeddedDocument
  • 요청 예시
  • 응답 예시

중요

MongoDB 3.4 사용 시 더 이상 제공되지 않습니다.

MongoDB 3.4 부터 미러링된 config 서버 배포서버(SCCC 라고도 함)는 더 이상 지원되지 않습니다. 다음 API 메서드는 SCCC config 서버에서만 작동합니다. 복제본 설정하다 구성 서버(CSRS 라고도 함)는 하나의 클러스터에 대해 모든 스냅샷 가져오기 메서드를 사용합니다. config 서버를 SCCC에서 CSRS로 변환하는 방법을 학습 보려면 MongoDB Server 매뉴얼의 Config 서버를 복제본 세트로 업그레이드를 참조하세요.

기본 URL: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots

요청 매개변수

요청 경로 매개변수

이름
유형
설명
프로젝트 ID
문자열
스냅샷 을 소유한 프로젝트 의고유 식별자입니다.
HOST-ID
문자열
스냅샷 이 나타내는 호스트의 고유 식별자입니다.

요청 쿼리 매개변수

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

이름
유형
필요성
설명
기본값
pageNum
숫자
옵션
결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.
1
itemsPerPage
숫자
옵션
페이지당 반환할 항목 수. 최대 500개까지 가능합니다.
100
pretty
부울
옵션
응답 본문을 프리티프린트 에 넣어야 하는지 여부를 나타내는 플래그입니다. 형식.
false
envelope
부울
옵션

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

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

결과 목록을 반환하는 엔드포인트의 경우 content 객체는 엔벨로프입니다. Cloud Manager가 status 필드를 응답 본문에 추가합니다.

false
backupJobsEnabledOnly
부울
옵션
데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. backupJobsEnabled 플래그가 false 로 설정된 daemon 구성을 포함하려면 이 값을 false 로 설정합니다.
true

요청 본문 매개변수

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

응답

응답 문서

응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.

이름
유형
설명
results
배열
배열에는 results 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체가 포함됩니다.
links
배열
배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
totalCount
숫자
결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다.

results embeddedDocument

각 결과 는 하나의 스냅샷입니다.

이름
유형
설명
clusterId
스냅샷 이 나타내는 클러스터의 ID입니다.
complete
부울
스냅샷 이 생성되었음을 나타내는 표시기입니다. 스냅샷 생성 작업이 아직 진행 중인 경우 false 입니다.
생성됨
문서
created.date
timestamp
스냅샷이 ISO 8601 에서 생성된 정확한 시점입니다.UTC 의 날짜 및 시간 형식입니다.
created.증분
integer
이 스냅샷 이 정확한 시점에 발생한 작업 순서입니다. MongoDB에서 타임스탬프가 작동하는 방식을 알아보려면 타임스탬프를 참조하세요.
doNotDelete
부울

스냅샷 을 삭제할 수 없음을 나타내는 표시기입니다.

을 로 doNotDelete true설정하면 의 모든 값이 무시됩니다.expires

expires
timestamp

ISO 의 8601 날짜 날짜 및 시간 형식(UTC 기준 ) 이후에는 이 스냅샷 을 삭제할 수 있습니다.

을 로 doNotDelete true설정하면 의 모든 값이 제거됩니다.expires

expires 값이 현재 날짜 및 시간보다 이전인 경우 더 이상 편집할 수 없습니다.

groupId
objectId
스냅샷 을 소유한 프로젝트 의 ID입니다.
id
objectId
lastOplogAppliedTimestamp
문서
마지막 oplog 항목의 타임스탬프 구성 요소가 적용되었습니다.
lastOplogAppliedTimestamp.date
timestamp
마지막 oplog 가 ISO 8601 에 적용된 정확한 시점입니다.UTC 의 날짜 및 시간 형식입니다.
lastOplogAppliedTimestamp.증분
integer
이 정확한 시점에 마지막 oplog 가 적용된 작업 순서입니다. MongoDB에서 타임스탬프가 작동하는 방식을 알아보려면 타임스탬프를 참조하세요.
링크
객체 배열

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

namespaceFilterList
객체 배열
이 스냅샷 에 포함되거나 제외된 네임스페이스 입니다.
namespaceFilterList.filterList
문자열 배열

스냅샷에 독점적으로 포함되거나 명시적으로 제외된 데이터베이스 또는 네임스페이스 의 조합을 쉼표로 구분한 목록입니다.

기본값은 빈 배열([])입니다.

namespaceFilterList.filterType
문자열

이 스냅샷에 대해 네임스페이스 를 필터링하는 방법을 결정하는 값입니다.

  • 이 값을 blacklist 로 namespaceFilterList.filterList 설정하면 의 네임스페이스가 스냅샷에서 제외됩니다.

  • 이 값을 whitelist 로 namespaceFilterList.filterList 설정하면 의 네임스페이스만 스냅샷에 포함됩니다.

기본값은 blacklist입니다.

부품
객체 배열
전체 스냅샷 을 구성하는 개별 부분입니다. 이 배열에는 단일 문서가 포함되어 있습니다.
parts.dataSizeBytes
숫자
스냅샷 에 있는 데이터의 총 크기(바이트)입니다.
parts.encryptionEnabled
부울
스냅샷 데이터의 암호화 상태를 나타내는 표시기입니다.
parts.fileSizeBytes
숫자
데이터 파일의 총 크기(바이트)입니다.
parts.hostId
문자열
config 서버의 ID입니다.
parts.masterKeyUUID
objectId
스냅샷 데이터를 암호화하는 데 사용되는 KMIP 마스터 키 ID 입니다. parts.masterKeyUUID 는 이 스냅샷 에 parts.encryptionEnabled : true 이 있는 경우에만 나타납니다.
parts.mongodVersion
문자열
스냅샷 이 생성될 때 실행 중인 mongod 버전입니다.
parts.storageSizeBytes
숫자
문서 저장에 할당된 공간의 총 크기입니다.
parts.typeName
문자열

부분이 나타내는 서버 유형입니다.

  • CONFIG_SERVER

요청 예시

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}/hosts/{HOST-ID}/snapshots?pretty=true"

응답 예시

응답 헤더

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}

응답 본문

{
  "links" : [ {
    "href" : "https://https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "clusterId" : "{CLUSTER-ID}",
    "complete" : true,
    "created" : {
      "date" : "2016-08-21T23:47:38Z",
      "increment" : 1
    },
    "doNotDelete" : false,
    "expires" : "2017-08-20T23:47:38Z",
    "groupId" : "{PROJECT-ID}",
    "id" : "{SNAPSHOT-ID}",
    "lastOplogAppliedTimestamp" : {
      "date" : "2017-08-21T09:14:51Z",
      "increment" : 1
    },
    "links" : [ {
      "href" : "https://https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}",
      "rel" : "self"
    } ],
    "namespaceFilterList" : {
      "filterList" : [ ],
      "filterType" : "blacklist"
    },
    "parts" : [ {
      "clusterId" : "{CLUSTER-ID}",
      "compressionSetting" : "GZIP",
      "dataSizeBytes" : 503779557,
      "encryptionEnabled" : false,
      "fileSizeBytes" : 2855605344,
      "mongodVersion" : "4.0.9",
      "replicaSetName" : "proton",
      "storageSizeBytes" : 547516416,
      "typeName" : "REPLICA_SET"
    } ]
  }, {
  } ],
  "totalCount" : 28
}

돌아가기

클러스터에서 하나의 스냅샷 제거

다음

하나의 Config 서버에 하나의 스냅샷 가져오기