Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

하나의 클러스터에 대한 모든 스냅샷 가져오기

이 페이지의 내용

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

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

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots
이름
유형
설명

프로젝트 ID

문자열

스냅샷 을 소유한 프로젝트 고유 식별자입니다.

CLUSTER-ID

문자열

스냅샷 이 나타내는 클러스터의 고유 식별자입니다.

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

이름
유형
필요성
설명
기본값

pageNum

숫자

옵션

결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.

1

itemsPerPage

숫자

옵션

페이지당 반환할 항목 수. 최대 500개까지 가능합니다.

100

pretty

부울

옵션

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

false

envelope

부울

옵션

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

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

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

false

completed

문자열

옵션

완료된 스냅샷 또는 완료되지 않은 스냅샷을 반환할지 여부를 나타내는 string 입니다.

  • true: 완료된 스냅샷만 반환

  • false: 불완전한 스냅샷만 반환

  • all: 완료된 스냅샷과 불완전한 스냅샷을 모두 반환합니다.

true

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

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

이름
유형
설명

results

배열

배열에는 내장된 results 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체 가 포함됩니다.

links

배열

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

totalCount

숫자

결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다.

결과 는 하나의 동기화 저장소입니다.

Name
유형
설명

clusterId

문자열

스냅샷 이 나타내는 클러스터의 고유 식별자입니다.

clusterName

문자열

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

complete

부울

스냅샷 이 생성되었음을 나타내는 플래그입니다. 스냅샷 생성 작업이 아직 진행 중인 경우 false 입니다.

created

문서

created
.date

timestamp

ISO8601- 스냅샷 이 생성된 시간입니다.

created
.increment

integer

스냅샷 이 정확한 시점에 발생한 작업 순서입니다. MongoDB에서 타임스탬프가 작동하는 방식을 알아보려면 타임스탬프를 참조하세요.

doNotDelete

부울

스냅샷 을 삭제할 수 없음을 나타내는 플래그입니다.

expires

timestamp

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

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

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

groupId

문자열

스냅샷 을 소유한 프로젝트 고유 식별자입니다.

id

문자열

isPossibly
Inconsistent

부울

스냅샷 의 일관성 을 나타내는 플래그입니다. isPossiblyInconsistent샤딩된 클러스터 스냅샷에만 표시됩니다.

일관된 상태로 샤드 클러스터 의 스냅샷을 찍기 위해 백업은 스냅샷 을 생성하기 전에 밸런서를 일시적으로 끕니다. 경우에 따라 적시에 밸런서를 끌 수 없습니다. 그런 다음 밸런서가 여전히 실행 중인 상태에서 스냅샷이 생성됩니다.

이 경우 스냅샷의 상태가 일관되지 않을 수 있습니다(예: 청크 마이그레이션이 진행 중일 수 있음).

lastOplog
AppliedTimestamp

문서

마지막 oplog 항목의 타임스탬프 구성 요소가 적용되었습니다.

lastOplog
AppliedTimestamp
.date

timestamp

ISO 8601 의 타임스탬프 마지막 oplog 가 적용된 UTC의 날짜 및 시간 형식 입니다 .

lastOplog
AppliedTimestamp
.increment

integer

이 정확한 시점에 마지막 oplog 가 적용된 작업 순서입니다. MongoDB에서 타임스탬프가 작동하는 방식을 알아보려면 타임스탬프를 참조하세요.

links

객체 배열

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

namespaceFilterList

객체

스냅샷 에포함되거나 제외된 네임스페이스 입니다.

namespaceFilterList
.filterList

문자열 배열

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

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

namespaceFilterList
.filterType

문자열

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

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

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

기본값은 blacklist입니다.

missingShards

객체 배열

스냅샷 에 누락된 샤드 목록입니다. missingShards샤딩된 클러스터 스냅샷에만 표시됩니다.

정상 상태에서 이 배열은 비어 있습니다. 스냅샷 을 생성할 때 백업을 샤드에 연결할 수 없는 경우 해당 샤드는 스냅샷에서 생략됩니다. 배열의 각 문서self 링크가 포함된 클러스터 문서입니다.

missingShards
.id

문자열

missingShards
.groupId

문자열

missingShards
.typeName

문자열

누락된 샤드 가 나타내는 서버 유형:

  • CONFIG_SERVER_REPLICA_SET

  • REPLICA_SET

  • CONFIG_SHARD_REPLICA_SET

missingShards
.clusterName

문자열

missingShards
.shardName

문자열

missingShards
.replicaSetName

문자열

missingShards
.lastHeartbeat

timestamp

ISO 8601 타임스탬프 누락된 샤드 에서 마지막 하트비트를 수신했을 UTC의 날짜 및 시간 형식입니다.

parts

객체 배열

전체 스냅샷을 구성하는 개별 부분입니다.

parts
.clusterId

문자열

parts
.completedTime

문자열

스냅샷 이 완료된 날짜 및 시간입니다.

parts
.compressionSetting

문자열

parts
.dataSizeBytes

숫자

스냅샷 에 있는 데이터의 총 크기(바이트)입니다.

parts
.encryptionEnabled

부울

스냅샷 데이터의 암호화 상태를 나타내는 표시기입니다.

parts
.fcv

문자열

MongoDB Cloud가 스냅샷 을 생성할 때 복제본 세트 프라이머리 가 실행한 MongoDB 의 기능 호환성 버전 을 나타내는 숫자입니다.

parts
.fileSizeBytes

숫자

데이터 파일의 총 크기(바이트)입니다.

parts
.machineId

문자열

MongoDB Cloud가 스냅샷 을 생성한 노드 를 나타내는 호스트 이름 및 포트입니다.

parts
.masterKeyUUID

문자열

스냅샷 데이터를 암호화하는 데 사용되는 KMIP 마스터 키 ID 입니다. parts.masterKeyUUID 는 이 스냅샷 에 parts.encryptionEnabled : true 이 있는 경우에만 표시됩니다.

parts
.mongodVersion

문자열

스냅샷 이 생성될 mongod복제본 세트 프라이머리 가 실행 중이던 의 버전입니다.

parts
.replicaSetName

문자열

parts
.replicaState

문자열

스냅샷 프로세스 가 시작된 시점의 노드 역할 입니다.

parts
.storageSizeBytes

숫자

문서 저장에 할당된 공간의 총 크기입니다.

parts
.typeName

문자열

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

  • REPLICA_SET

  • CONFIG_SERVER_REPLICA_SET

  • CONFIG_SHARD_REPLICA_SET

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-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://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-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://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-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
}

돌아가기

스냅샷