Docs Home

/ /

스냅샷

Docs Home

/ /

하나의 스냅샷에 대한 만료 기한 변경

이 버전의 문서는 보관되어 더 이상 지원되지 않습니다. 최신 문서 를 참조하여 MongoDB Ops Manager 버전을 업그레이드 방법을 학습.

이 엔드포인트에 대한 모든 요청은 IP MongoDB Ops Manager 사용자의 액세스 API 목록에 있는 주소 에서 시작되어야 합니다. API 액세스 목록 구성에 대한 전체 문서는 조직에 API 액세스 목록 필요를 참조하세요.

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

Resource

PATCH /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}

요청 매개변수

요청 경로 매개변수

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

요청 쿼리 매개변수

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

이름

유형

필요성

설명

기본값

pretty

부울

옵션

응답 본문이 pretty-print 형식이어야 하는지 여부를 나타내는 플래그입니다.

false

envelope

부울

옵션

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

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

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

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

false

요청 본문 매개변수

이름	유형	설명
doNotDelete	부울	스냅샷을 삭제할 수 없음을 나타내는 표시기입니다. 중요 동일한 요청에서 `doNotDelete` 을(를) `true` (으 )로 설정하고 `expires` 에 대한 타임스탬프를 설정할 수 없습니다. 이 경우 Ops Manager에서 `Cannot modify snapshot because of invalid fields.` 오류를 반환합니다.
expires	timestamp	이 스냅샷 삭제할 수 있는 UTC 기준 ISO 8601 날짜 및 시간 형식의 날짜입니다. 을 로 설정하면 `doNotDelete` `true`의 기존 값이 모두 제거됩니다.`expires` `expires` 이(가) 현재 날짜 및 시간 또는 그 이전의 타임스탬프로 설정되어 있으면 Ops Manager는 다음 기회에 스냅샷을 삭제합니다. 스냅샷이 즉시 삭제된다는 보장은 없습니다. 현재 `expires` 타임스탬프가 이미 지난 경우에는 편집할 수 없습니다.

응답

`Name`	유형	설명
`clusterId`	문자열	스냅샷 이 나타내는 클러스터의 고유 식별자입니다.
`complete`	부울	스냅샷 이 생성되었음을 나타내는 플래그입니다. 스냅샷 생성 작업이 아직 진행 중인 경우 `false` 입니다.
`created`	문서	타임스탬프의 구성 요소입니다.
`created` `.date`	timestamp	ISO8601- 스냅샷 이 생성된 시간입니다.
`created` `.increment`	integer	이 스냅샷 이 정확한 시점에 발생한 작업 순서입니다. MongoDB에서 타임스탬프가 작동하는 방식을 알아보려면 타임스탬프를 참조하세요.
`doNotDelete`	부울	스냅샷 을 삭제할 수 없음을 나타내는 플래그입니다.
`expires`	timestamp	ISO 8601 날짜 및 시간 형식(UTC 기준)의 타임스탬프이며, 이후에는 이 스냅샷 삭제할 수 있습니다. 을 로 `doNotDelete` `true`설정하면 의 모든 값이 제거됩니다.`expires` `expires` 값이 현재 날짜 및 시간보다 이른 경우 편집할 수 없습니다.
`groupId`	문자열	스냅샷 을 소유한 프로젝트 의고유 식별자입니다.
`id`	문자열	스냅샷의 고유 식별자입니다.
`isPossibly` `Inconsistent`	부울	이 스냅샷 의 일관성 을 나타내는 플래그입니다. `isPossiblyInconsistent` 는 샤딩된 클러스터 스냅샷에만 표시됩니다. 일관된 상태로 샤드 클러스터 의 스냅샷을 찍기 위해 백업은 스냅샷 을 생성하기 전에 밸런서를 일시적으로 끕니다. 경우에 따라 적시에 밸런서를 끌 수 없습니다. 그런 다음 밸런서가 여전히 실행 중인 상태에서 스냅샷이 생성됩니다. 이 경우 스냅샷의 상태가 일관되지 않을 수 있습니다(예: 청크 마이그레이션이 진행 중일 수 있음).
`lastOplog` `AppliedTimestamp`	문서	마지막 oplog 항목의 타임스탬프 구성 요소가 적용되었습니다.
`lastOplog` `AppliedTimestamp` `.date`	timestamp	마지막 oplog 적용된 시점의 ISO 8601 날짜 및 시간 형식(UTC기준)의 타임스탬프입니다.
`lastOplog` `AppliedTimestamp` `.increment`	integer	이 정확한 시점에 마지막 oplog 가 적용된 작업 순서입니다. MongoDB에서 타임스탬프가 작동하는 방식을 알아보려면 타임스탬프를 참조하세요.
`links`	객체 배열	하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양.에 설명되어 있습니다.
`namespaceFilterList`	객체	이 스냅샷 에포함되거나 제외된 네임스페이스 입니다.
`namespaceFilterList` `.filterList`	문자열 배열	스냅샷에 독점적으로 포함되거나 명시적으로 제외된 데이터베이스 또는 네임스페이스 조합을 쉼표로 구분한 목록입니다. 기본값은 빈 배열(`[]`)입니다.
`namespaceFilterList` `.filterType`	문자열	이 스냅샷에 대해 네임스페이스 를 필터링하는 방법을 결정하는 레이블입니다. 이 값을 `blacklist` 로 `namespaceFilterList.filterList` 설정하면 의 네임스페이스가 스냅샷에서 제외됩니다. 이 값을 `whitelist` 로 `namespaceFilterList.filterList` 설정하면 의 네임스페이스만 스냅샷에 포함됩니다. 기본값은 `blacklist`입니다.
`missingShards`	객체 배열	스냅샷 에 누락된 샤드 목록입니다. `missingShards` 는 샤딩된 클러스터 스냅샷에만 표시됩니다. 정상 상태에서 이 배열은 비어 있습니다. 스냅샷 을 생성할 때 백업을 샤드에 연결할 수 없는 경우 해당 샤드는 스냅샷에서 생략됩니다. 배열의 각 문서 는 `self` 링크가 포함된 클러스터 문서입니다.
`missingShards` `.id`	문자열	누락된 샤드의 고유 식별자입니다.
`missingShards` `.groupId`	문자열	누락된 샤드를 소유한 프로젝트의 고유 식별자입니다.
`missingShards` `.typeName`	문자열	누락된 샤드 가 나타내는 서버 유형: `CONFIG_SERVER_REPLICA_SET` `REPLICA_SET`
`missingShards` `.clusterName`	문자열	누락된 샤드에 대한 클러스터의 이름입니다.
`missingShards` `.shardName`	문자열	누락된 샤드의 이름입니다.
`missingShards` `.replicaSetName`	문자열	누락된 샤드에 있는 복제본 세트의 이름입니다.
`missingShards` `.lastHeartbeat`	timestamp	누락된 샤드 에서 마지막 하트비트를 수신했을 때 ISO 8601 날짜 및 시간 형식(UTC 기준)의 타임스탬프입니다.
`parts`	객체 배열	전체 스냅샷을 구성하는 개별 부분입니다. 복제본 세트 의 경우 이 배열에는 단일 문서가 포함됩니다. 샤드 클러스터 의 경우 이 배열에는 각 샤드에 대한 문서 하나와 config 서버에 대한 문서 하나가 포함됩니다.
`parts` `.clusterId`	문자열	복제본 세트의 고유 식별자입니다.
`parts` `.compressionSetting`	문자열	스냅샷의 압축 방법입니다.
`parts` `.dataSizeBytes`	숫자	스냅샷 에 있는 데이터의 총 크기(바이트)입니다.
`parts` `.encryptionEnabled`	부울	스냅샷 데이터의 암호화 상태를 나타내는 표시기입니다.
`parts` `.fileSizeBytes`	숫자	데이터 파일의 총 크기(바이트)입니다.
`parts` `.masterKeyUUID`	문자열	스냅샷 데이터를 암호화하는 데 사용되는 KMIP 마스터 키 ID 입니다. `parts.masterKeyUUID` 는 이 스냅샷 에 `parts.encryptionEnabled : true` 이 있는 경우에만 표시됩니다.
`parts` `.mongodVersion`	문자열	스냅샷 이 생성될 `mongod` 때 복제본 세트 프라이머리 가 실행 중이던 의 버전입니다.
`parts` `.replicaSetName`	문자열	복제본 세트의 이름입니다.
`parts` `.storageSizeBytes`	숫자	문서 저장에 할당된 공간의 총 크기입니다.
`parts` `.typeName`	문자열	부분이 나타내는 서버 유형입니다. `REPLICA_SET` `CONFIG_SERVER_REPLICA_SET`

`links` 배열

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

관계	설명
self	이 리소스의 URL 엔드포인트입니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}?pretty=true" \
 --data '
 {
   "doNotDelete": 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}

응답 본문

{
  "id" : "{SNAPSHOT-ID}",
  "CLUSTER-ID" : "{CLUSTER-ID}",
  "complete" : true,
  "created" : {
    "date" : "2014-07-09T15:24:37Z",
    "increment" : 1
  },
  "doNotDelete" : true,
  "GROUP-ID" : "{PROJECT-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" : [ {
    "CLUSTER-ID" : "{CLUSTER-ID}",
    "dataSizeBytes" : 17344,
    "fileSizeBytes" : 67108864,
    "mongodVersion" : "2.6.3",
    "replicaSetName" : "rs0",
    "storageSizeBytes" : 10502144,
    "typeName" : "REPLICA_SET"
  } ],
}

돌아가기

하나 가져오기(클러스터)

하나 제거

Resource

요청 매개변수

요청 경로 매개변수

요청 쿼리 매개변수

요청 본문 매개변수

중요

응답

links 배열

요청 예시

응답 예시

응답 헤더

응답 본문

`links` 배열