1개의 레거시 미러링된 config 서버에 대해 1개의 복원 작업 만들기

이 페이지의 내용

Resource

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

Cloud Manager는 2024년 8월 30일부터 더 이상 MongoDB 3.6 및 4.0에 대한 자동화, 백업 및 모니터링을 지원하지 않습니다. MongoDB 배포를 업그레이드하거나 Atlas로 마이그레이션하세요.

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

Resource

POST /groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs

요청 경로 매개변수

이름	유형	설명
프로젝트 ID	문자열	작업을 소유한 프로젝트 의 고유 식별자입니다.
HOST-ID	문자열	작업이 나타내는 미러링된 config 서버 (SCCC)의 고유 식별자입니다.

요청 쿼리 매개변수

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

이름

유형

필요성

설명

기본값

pretty

부울

옵션

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

false

envelope

부울

옵션

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

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

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

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

false

요청 본문 매개변수

이름	유형	필요성	설명
`checkpointId`	문자열	조건부	데이터가 복원될 시점을 나타내는 샤드 클러스터 체크포인트의 고유 식별자입니다. 조건: `"delivery.methodName" : "AUTOMATED_RESTORE"` 을 설정합니다. 4.0 이하의 `FCV` 를 사용하여 샤드 클러스터를 실행합니다. `oplogInc`, `oplogTs` 또는 `pointInTimeUTCMillis` 을 설정할 수 없습니다. 이 설정을 제공하면 이 엔드포인트는 이 체크포인트 까지의 모든 데이터를 `delivery` 객체에서 지정한 데이터베이스에 복원합니다.
`delivery`	객체	필수 사항	복원된 스냅샷 데이터를 전달하는 방법 및 방법에 대한 세부 정보입니다.
`delivery` `.expires`	문자열	조건부	ISO 8601 의 타임스탬프 날짜 및 시간 형식(UTC 기준 ) 이후에는 URL 을 더 이상 사용할 수 없습니다. `delivery.methodName" : "HTTP"`
`delivery` `.expirationHours`	숫자	조건부	복원 작업이 완료된 후 다운로드 URL 이 유효한 시간 수입니다. `delivery.methodName" : "HTTP"`
`delivery` `.maxDownloads`	숫자	조건부	다운로드 URL 을 사용할 수 있는 횟수입니다. 이 값은 `1` 이상이어야 합니다. `delivery.methodName" : "HTTP"`
`delivery` `.methodName`	문자열	필수 사항	Cloud Manager가 데이터를 전달하는 수단입니다. 허용되는 값은 다음과 같습니다. `AUTOMATED_RESTORE` `HTTP` `"delivery.methodName" : "AUTOMATED_RESTORE"` 을 설정하는 경우 다음도 설정해야 합니다. `delivery.targetGroupId` 개인정보 정책에 `delivery.targetClusterId` 또한 응답에서 `delivery.methodName` 을 `HTTP` 으로 표시합니다. 자동 복원은 `HTTP` 메서드를 사용하여 복원 작업을 대상 호스트에 전달합니다. 중요 SCP 를 통한 복원 전달은 27, 2018 월부터 제거되었습니다.
`delivery` `.targetClusterId`	문자열	조건부	대상 클러스터의 고유 식별자입니다. 모든 스냅샷 가져오기 및 스냅샷 가져오기 엔드포인트의 응답 본문에 반환된 `clusterId` 를 사용합니다. `delivery.methodName" : "AUTOMATED_RESTORE"`. 대상 cluster에서 백업이 활성화되어 있지 않은 경우, 모든 스냅샷 가져오기 엔드포인트는 `clusterId` 요소가 없는 빈 `results` 배열을 반환 하며 스냅샷 가져오기 엔드포인트도 `clusterId` 요소를 반환하지 않습니다.
`delivery` `.targetGroupId`	문자열	조건부	복원 job의 대상 cluster가 포함된 프로젝트의 고유 식별자입니다. `delivery.methodName" : "AUTOMATED_RESTORE"`
`oplogTs`	문자열	조건부	유닉스 oplog 시간 이후 경과된 시간(초)을 타임 스탬프 로 표시한 타임스탬프 . `oplogInc` 와 함께 사용하면 데이터가 복원되는 시점을 나타냅니다. 복제본 세트 에서 `local.oplog.rs` 에 대한 쿼리를 실행하여 원하는 타임스탬프를 찾습니다. `"delivery.methodName" : "AUTOMATED_RESTORE"` 복제본 세트에만 해당됩니다. `oplogTs` 을(를) 설정하면 다음이 수행됩니다. `oplogInc` 을 설정해야 합니다. `checkpointId` 또는 `pointInTimeUTCMillis` 을(를) 설정할 수 없습니다. 이 설정을 제공하면 이 엔드포인트는 이 Oplog 타임스탬프를 포함한 모든 데이터를 `delivery` 객체에 지정한 데이터베이스에 복원합니다.
`oplogInc`	문자열	조건부	주어진 초 내의 작업을 나타내는 32비트 증분 서수입니다. `oplogTs` 과 함께 쌍을 이루는 경우 데이터가 복원되는 점을 나타냅니다. `"delivery.methodName" : "AUTOMATED_RESTORE"` 복제본 세트에만 해당됩니다. `oplogInc` 을(를) 설정하면 다음이 수행됩니다. `oplogTs` 을 설정해야 합니다. `checkpointId` 또는 `pointInTimeUTCMillis` 을(를) 설정할 수 없습니다. 이 설정을 제공하면 이 엔드포인트는 이 Oplog 타임스탬프를 포함한 모든 데이터를 `delivery` 객체에 지정한 데이터베이스에 복원합니다.
`pointInTimeUTCMillis`	long	조건부	유닉스 시간 이후 경과된 밀리초 수의 타임스탬프 '는 데이터가 복원될 시점을 나타냅니다. 이 타임스탬프는 현재 시간에서 지난 24 시간 이내여야 합니다. 이 설정을 제공하면 이 엔드포인트는 이 시점 까지의 모든 데이터를 `delivery` 객체에서 지정한 데이터베이스로 복원합니다. `"delivery.methodName" : "AUTOMATED_RESTORE"` 복제본 세트에만 해당됩니다. `pointInTimeUTCMillis` 을 설정하면 `oplogInc`, `oplogTs` 또는 `checkpointId` 을 설정할 수 없습니다.
`snapshotId`	문자열	조건부	복원할 스냅샷 의 고유 식별자입니다.

응답

이름	유형	설명
batchId	문자열	조건부: 샤드 클러스터 에만 해당됩니다. 이 복원 작업이 속한 배치 의 고유 식별자입니다.
clusterId	문자열	조건부: 클러스터 전용. 복원 작업이 나타내는 클러스터 의 고유 식별자입니다.
생성됨	문자열	ISO 8601 의 타임스탬프 복원 작업이 요청된 시점의 UTC 날짜 및 시간 형식입니다.
전달	객체	복원된 스냅샷 데이터를 전달하는 방법 및 방법에 대한 세부 정보입니다.
delivery.expirationHours	숫자	조건부: `"delivery.methodName" : "HTTP"`. 복원 작업이 완료된 후 다운로드 URL 이 유효한 시간 수입니다.
delivery.expires	문자열	조건부: `"delivery.methodName" : "HTTP"`. ISO 8601 의 타임스탬프 날짜 및 시간 형식(UTC 기준 ) 이후에는 URL 을 더 이상 사용할 수 없습니다.
delivery.maxDownloads	숫자	조건부: `"delivery.methodName" : "HTTP"`. 다운로드 URL 을 사용할 수 있는 횟수입니다. 이 값은 `1` 이상이어야 합니다.
delivery.methodName	문자열	데이터가 전달되는 수단입니다. 허용되는 값은 다음과 같습니다. `HTTP` 중요 SCP 를 통한 복원 전달은 27, 2018 월부터 제거되었습니다.
delivery.statusName	문자열	다운로드 가능한 파일의 현재 상태입니다. 허용되는 값은 다음과 같습니다. `NOT_STARTED` `IN_PROGRESS` `READY` `FAILED` `INTERRUPTED` `EXPIRED` `MAX_DOWNLOADS_EXCEEDED`
delivery.targetClusterId	문자열	조건부: `delivery.methodName" : "AUTOMATED_RESTORE"`. 복원 작업을 수행할 대상 클러스터의 고유 식별자입니다.
delivery.targetGroupId	문자열	조건부: `delivery.methodName" : "AUTOMATED_RESTORE"`. 복원 작업의 대상 클러스터가 포함된 프로젝트의 고유 식별자입니다.
delivery.URL	문자열	조건부: `"delivery.methodName" : "HTTP"`. 복원된 스냅샷 데이터를 다운로드할 수 있는URL 입니다.
groupId	문자열	복원 작업을 소유한 그룹 의 고유 식별자입니다.
해시	객체 배열	해당 `delivery.url` 가 다운로드된 경우 이 배열의 각 문서는 복원 파일을 해시 체크섬에 매핑한 것입니다. 이 배열은 파일이 다운로드 된 후에만 표시됩니다. `HTTP` 복원의 경우 이 배열에는 `.tar.gz` 파일의 해시를 나타내는 단일 객체만 포함됩니다.
해시.파일 이름	문자열	해시된 스냅샷 파일의 이름입니다.
해시.해시	문자열	스냅샷 파일의 해시입니다.
Hashes.typeName	문자열	해시 값을 계산하는 데 사용되는 해싱 알고리즘입니다. 이 값이 있는 경우 이 값은 `SHA1` 입니다.
hostId	문자열	조건부: 미러링된 config 서버 (SCCC). 이 복원 작업이 속한 config 서버 의 고유 식별자입니다.
id	문자열	복원 작업의 고유 식별자입니다.
링크	객체 배열	하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 이라는 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
snapshotId	문자열	복원할 스냅샷 의 고유 식별자입니다.
statusName	문자열	작업의 현재 상태입니다. 허용되는 값은 다음과 같습니다. `FINISHED` `IN_PROGRESS` `BROKEN` `KILLED`
timestamp	객체	스냅샷이 생성되었을 때 Oplog 항목의 타임스탬프입니다.
timestamp.date	문자열	ISO 8601 의 타임스탬프 복원된 스냅샷에 있는 최신 oplog 항목의 UTC 날짜 및 시간 형식입니다.
타임스탬프.증가	문자열	복원된 스냅샷의 가장 최근 oplog 항목에서 완료된 모든 작업의 순서입니다.

요청 예시

HTTP 를 사용하여 압축된 스냅샷을 전송하는 복원 작업을 만듭니다.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs?pretty=true" \
     --data '
      {
        "delivery" : {
          "expirationHours" : 1,
          "expires" : "2017-04-21T04:49:57Z",
          "maxDownloads" : 1,
          "methodName" : "HTTP",
          "statusName" : "READY",
          "url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz"
        },
        "snapshotId" : "{SNAPSHOT-ID}"
      }'

응답 예시

응답 헤더

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}

응답 본문

{
  "created" : "2017-08-25T16:22:15Z",
  "delivery" : {
    "expirationHours" : 1,
    "expires" : "2017-04-21T04:49:57Z",
    "maxDownloads" : 1,
    "methodName" : "HTTP",
    "statusName" : "READY",
    "url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz"
  },
  "encryptionEnabled" : true,
  "groupId" : "{PROJECT-ID}",
  "hostId" : "{HOST-ID}",
  "id" : "{JOB-ID}",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs/{JOB-ID}",
    "rel" : "self"
  }, {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}",
    "rel" : "http://mms.mongodb.com/cluster"
  }, {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}",
    "rel" : "http://mms.mongodb.com/snapshot"
  }, {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",
    "rel" : "http://mms.mongodb.com/group"
  } ],
  "masterKeyUUID" : "{UUID}",
  "snapshotId" : "{SNAPSHOT-ID}",
  "statusName" : "IN_PROGRESS"
}

돌아가기

1개의 레거시 미러링된 config 서버에 대해 1개의 복원 작업 가져오기

자동화