Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Ops Manager 관리 API 리소스
/
백업 및 복원
/
작업 복원

1개의 cluster에 대해 모든 복원 작업 가져오기

이 페이지의 내용

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

클러스터의 모든 복원 작업을 가져옵니다. CLUSTER-ID 은 복제본 세트 또는 샤드 클러스터의 ID여야 합니다.

참고

BATCH-ID 쿼리 매개변수를 사용하면 지정된 배치의 모든 복원 작업을 검색할 수 있습니다. 샤딩된 cluster에 대한 작업을 생성할 때 Ops Manager는 각 샤드에 대해 별도의 작업을 생성하고 config 서버에 대해 또 다른 작업을 생성합니다. 이러한 각 작업은 배치의 일부입니다. 그러나 복제본 세트에 대한 복원 작업은 배치에 포함될 수 없습니다.

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

리소스

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs
GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?batchId={BATCH-ID}

요청 경로 매개변수

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

요청 쿼리 매개변수

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

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

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

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

false
배치 ID
문자열
배치 의 고유 식별자입니다.
NONE

요청 본문 매개변수

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

응답

응답 문서

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

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

results embeddedDocument

각 결과 는 하나의 cluster 복원 작업입니다.

이름
유형
설명
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 를 사용한 복원 전달은 MongoDB Ops Manager 4.0에서 제거되었습니다.

delivery.statusName
문자열

다운로드 가능한 파일의 현재 상태입니다. 허용되는 값은 다음과 같습니다.

  • NOT_STARTED

  • IN_PROGRESS

  • READY

  • FAILED

  • INTERRUPTED

  • EXPIRED

  • MAX_DOWNLOADS_EXCEEDED

delivery.URL
문자열
조건부: "delivery.methodName" : "HTTP". 복원된 스냅샷 데이터를 다운로드할 수 있는URL 입니다.
encryptionEnabled
부울
복원된 스냅샷 데이터의 암호화 여부를 나타내는 플래그입니다.
groupId
문자열
복원 작업을 소유한 그룹 의 고유 식별자입니다.
해시
객체 배열

해당 delivery.url 가 다운로드된 경우 이 배열의 각 문서는 복원 파일을 해시 체크섬에 매핑한 것입니다. 이 배열은 파일이 다운로드 된 후에만 표시됩니다.

HTTP 복원 의 경우 이 배열 에는 .tar.gz 파일 의 해시를 나타내는 단일 객체 만 포함됩니다.

해시.파일 이름
문자열
해시된 스냅샷 파일의 이름입니다.
해시.해시
문자열
스냅샷 파일의 해시입니다.
Hashes.typeName
문자열
해시 값을 계산하는 데 사용되는 해싱 알고리즘입니다. 이 값이 있는 경우 이 값은 SHA1 입니다.
hostId
문자열
조건부: 미러링된 config 서버 (SCCC). 이 복원 작업이 속한 config 서버 의 고유 식별자입니다.
id
문자열
복원 작업의 고유 식별자입니다.
링크
객체 배열

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

마스터 키UUID
문자열
조건부: "encryptionEnabled" : true. 스냅샷 데이터를 암호화하는 데 사용되는 KMIP 마스터 키 ID 입니다.
pointInTime
부울
작업이 PIT 복원임을 나타내는 플래그입니다.
snapshotId
문자열
복원할 스냅샷 의 고유 식별자입니다.
statusName
문자열

작업의 현재 상태입니다. 허용되는 값은 다음과 같습니다.

  • FINISHED

  • IN_PROGRESS

  • BROKEN

  • KILLED

timestamp
객체
스냅샷이 생성되었을 때 Oplog 항목의 타임스탬프입니다.
timestamp.date
문자열
ISO 8601 의 타임스탬프 복원된 스냅샷에 있는 최신 oplog 항목의 UTC 날짜 및 시간 형식입니다.
타임스탬프.증가
문자열
복원된 스냅샷의 가장 최근 oplog 항목에서 완료된 모든 작업의 순서입니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "batchId" : "{BATCH-ID}",
    "clusterId" : "{CLUSTER-ID}",
    "created" : "2017-04-21T03:49:57Z",
    "delivery" : {
      "expirationHours" : 1,
      "expires" : "2017-04-21T04:49:57Z",
      "maxDownloads" : 1,
      "methodName" : "HTTP",
      "statusName" : "READY",
      "url" : "https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz"
    },
    "encryptionEnabled" : false,
    "groupId" : "{PROJECT-ID}",
    "id" : "{JOB-ID}",
    "links" : [ {
      "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}",
      "rel" : "self"
    } ],
    "pointInTime" : false,
    "snapshotId" : "{SNAPSHOT-ID}",
    "statusName" : "FINISHED",
    "timestamp" : {
      "date" : "2017-04-18T15:14:25Z",
      "increment" : 1
    }
  }, {
    "batchId" : "{BATCH-ID}",
    "clusterId" : "{CLUSTER-ID}",
    "created" : "2017-04-18T19:21:23Z",
    "delivery" : {
      "expirationHours" : 1,
      "expires" : "2017-04-18T20:21:23Z",
      "maxDownloads" : 1,
      "methodName" : "HTTP",
      "statusName" : "READY",
      "url" : "https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v2/pull/{JOB-ID}/NWRlMTk4NzgxYzNjNDIzOTg2Yzc3YzkyODYxYjNjMzY=/electron_0-1492528465-{JOB-ID}.tar.gz"
    },
    "encryptionEnabled" : false,
    "groupId" : "{PROJECT-ID}",
    "id" : "{JOB-ID}",
    "links" : [ {
      "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}",
      "rel" : "self"
    } ],
    "pointInTime" : false,
    "snapshotId" : "{SNAPSHOT-ID}",
    "statusName" : "FINISHED",
    "timestamp" : {
      "date" : "2017-04-19T21:14:25Z",
      "increment" : 1
    }
  } ],
  "totalCount" : 2
}

돌아가기

작업 복원

다음

1개의 클러스터에 대해 1개의 복원 작업 가져오기