스냅샷 일정 가져오기

이 페이지의 내용

Resource

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

참고

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

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

Resource

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

요청 매개변수

요청 경로 매개변수

Parameter	유형	필요성	설명
`PROJECT-ID`	문자열	필수 사항	가져오려는 스냅샷 일정이 있는 cluster를 보유하는 프로젝트의 고유 식별자입니다.
`CLUSTER-ID`	문자열	필수 사항	스냅샷 스케줄을 가져오려는 cluster의 고유 식별자입니다.

요청 쿼리 매개변수

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

이름

유형

필요성

설명

기본값

pretty

부울

옵션

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

false

envelope

부울

옵션

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

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

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

이름	설명
`status`	HTTP 응답 코드
`content`	예상되는 응답 본문

false

요청 본문 매개변수

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

응답

이름	유형	설명
`clusterCheckpointIntervalMin`	숫자	연속 클러스터 체크포인트 사이의 시간(분)입니다. 이는 샤드 cluster에만 적용됩니다. 이 숫자는 샤딩된 cluster에 대한 특정 시점 복원의 세분성을 결정합니다. Ops Manager는 `15`, `30` 또는 `60` 값을 반환할 수 있습니다.
`clusterId`	문자열	이 백업 구성이 적용되는 cluster의 고유 식별자입니다.
`dailySnapshotRetentionDays`	숫자	일일 스냅샷을 보관할 일수입니다. Ops Manager는 `1` ~ `365` 사이의 값을 반환할 수 있습니다. `dailySnapshotRetentionDays` 를 `0` 로 설정하면 이 규칙이 비활성화됩니다.
`fullIncrementalDayOfWeek`	문자열	Ops Manager가 전체 스냅샷을 생성하는 요일입니다. 이렇게 하면 최근의 완전한 백업이 보장됩니다. Ops Manager는 기본값을 SUNDAY 으)로 설정합니다.
`groupId`	문자열	백업 구성을 소유한 프로젝트의 고유 식별자입니다.
`links`	객체 배열	하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 이라는 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
`monthlySnapshotRetentionMonths`	숫자	월별 스냅샷을 보관할 개월 수입니다. Ops Manager는 `1` ~ `36` 사이의 값을 반환할 수 있습니다. `monthlySnapshotRetentionMonths` 를 `0` 로 설정하면 이 규칙이 비활성화됩니다.
`pointInTimeWindowHours`	숫자	과거에 점 스냅샷을 생성할 수 있는 시간의 수입니다.
`referenceHourOfDay`	숫자	24시간 형식을 사용하여 스냅샷을 예약할 날의 시간입니다. Ops Manager는 `0` ~ `23` 사이의 값을 반환할 수 있습니다.
`referenceMinuteOfHour`	숫자	스냅샷을 예약할 시간의 분입니다. Ops Manager는 `0` ~ `59` 사이의 값을 반환할 수 있습니다.
`referenceTimeZoneOffset`	문자열	ISO-8601 시간대 오프셋 MongoDB Ops Manager 호스트가 상주하는 위치입니다. 일광 절약 시간제 관련 문제를 방지하려면 UTC 를 사용하세요. 기본값은 `+0000` 이며, 이는 UTC 에 해당합니다. `Z` 도 지원되는 값이며 UTC 에 해당합니다. Ops Manager는 `+0000` 이외의 모든 오프셋을 저장하기 전에 `+0000` 로 변환하고 그에 따라 `referenceHourOfDay` 값을 조정합니다. 예를 예시 `referenceHourOfDay` 이 `5` 이고 `referenceTimeZoneOffset` 이 "+0200". \|onprem\| stores a ``referenceHourOfDay `3` 이고 `referenceTimeZoneOffset` 이 `"+0000"` 인 요청 을 전달합니다.
`snapshotIntervalHours`	숫자	스냅샷 사이의 시간 간격입니다. Ops Manager는 `6`, `8`, `12` 또는 `24` 값을 반환할 수 있습니다.
`snapshotRetentionDays`	숫자	최근 스냅샷을 보관할 일수입니다. Ops Manager는 `2` ~ `5` 사이의 값을 반환할 수 있습니다.
`weeklySnapshotRetentionWeeks`	숫자	주간 스냅샷을 보관할 주 수입니다. Ops Manager는 `1` ~ `52` 사이의 값을 반환할 수 있습니다. `weeklySnapshotRetentionWeeks` 를 `0` 로 설정하면 이 규칙이 비활성화됩니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule"

응답 예시

응답 헤더

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 {
2   "clusterId" : "{CLUSTER-ID}",
3   "dailySnapshotRetentionDays" : 7,
4   "groupId" : "{PROJECT-ID}",
5   "links" : [],
6   "monthlySnapshotRetentionMonths" : 13,
7   "pointInTimeWindowHours": 24,
8   "snapshotIntervalHours" : 6,
9   "snapshotRetentionDays" : 2,
10   "weeklySnapshotRetentionWeeks" : 4
11 }

돌아가기

스냅샷 일정

스냅샷 일정 업데이트

1	{
2	"clusterId" : "{CLUSTER-ID}",
3	"dailySnapshotRetentionDays" : 7,
4	"groupId" : "{PROJECT-ID}",
5	"links" : [],
6	"monthlySnapshotRetentionMonths" : 13,
7	"pointInTimeWindowHours": 24,
8	"snapshotIntervalHours" : 6,
9	"snapshotRetentionDays" : 2,
10	"weeklySnapshotRetentionWeeks" : 4
11	}