1개의 cluster에 대해 1개의 작업 복원 만들기
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs
요청 경로 매개변수
이름 | 유형 | 설명 |
---|---|---|
| 문자열 | 작업을 소유한 프로젝트의 고유 식별자입니다. |
| 문자열 | 작업이 나타내는 cluster의 고유 식별자입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
요청 본문 매개변수
이름 | 유형 | 필요성 | 설명 |
---|---|---|---|
| 객체 | 필수 사항 | 복원된 스냅샷 데이터를 전달하는 방법 및 방법에 대한 세부 정보입니다. |
delivery .expires | 문자열 | 조건부 | ISO 8601 의 타임스탬프 날짜 및 시간 형식(UTC 기준 ) 이후에는 URL 을 더 이상 사용할 수 없습니다.
|
delivery .expirationHours | 숫자 | 조건부 | 복원 작업이 완료된 후 다운로드 URL 이 유효한 시간 수입니다.
|
delivery .maxDownloads | 숫자 | 필수 사항 | 다운로드 URL 을 사용할 수 있는 횟수입니다. 이 값은 |
delivery .methodName | 문자열 | 필수 사항 | Ops Manager가 데이터를 전달하는 수단입니다. |
| 문자열 | 필수 사항 | 복원할 스냅샷 의 고유 식별자입니다. |
참고
조건
"delivery.methodName" :
AUTOMATED_RESTORE"
을 설정하다 하는 경우 delivery.targetGroupId
및 delivery.targetClusterId
을 설정하다 해야 합니다.
스냅샷 에서 자동 복원 을 만듭니다.
이름 | 유형 | 필요성 | 설명 |
---|---|---|---|
| 객체 | 필수 사항 | 복원된 스냅샷 데이터를 전달하는 방법 및 방법에 대한 세부 정보입니다. |
delivery .methodName | 문자열 | 필수 사항 | Ops Manager가 데이터를 전달하는 수단입니다. 응답에 중요: SCP 를 사용한 복원 전달은 MongoDB Ops Manager 4.0에서 제거되었습니다. |
delivery .targetClusterId | 문자열 | 필수 사항 | |
delivery .targetGroupId | 문자열 | 필수 사항 | 복원 job의 대상 cluster가 포함된 프로젝트의 고유 식별자입니다. |
| 문자열 | 필수 사항 | 복원할 스냅샷 의 고유 식별자입니다. |
oplog 타임스탬프에서 자동 복원 을 생성합니다.
oplog 복원은 MongoDB 버전을 사용하는 복제본 세트 또는 4.2 이상의 FCV 를 사용하는 샤드 클러스터에서 작동합니다.
이름 | 유형 | 필요성 | 설명 |
---|---|---|---|
| 객체 | 필수 사항 | 복원된 스냅샷 데이터를 전달하는 방법 및 방법에 대한 세부 정보입니다. |
delivery .methodName | 문자열 | 필수 사항 | Ops Manager가 데이터를 전달하는 수단입니다. 응답에 중요: SCP 를 사용한 복원 전달은 MongoDB Ops Manager 4.0에서 제거되었습니다. |
delivery .targetClusterId | 문자열 | 필수 사항 | |
delivery .targetGroupId | 문자열 | 필수 사항 | 복원 job의 대상 cluster가 포함된 프로젝트의 고유 식별자입니다. |
| 문자열 | 필수 사항 | |
| 문자열 | 필수 사항 | 주어진 초 내의 작업을 나타내는 32비트 증분 서수입니다. 이 설정을 제공하면 이 엔드포인트는 이 Oplog 타임스탬프를 포함한 모든 데이터를 |
특정 점 부터 자동 복원 을 생성합니다.
PIT 복원은 MongoDB 버전을 사용하는 복제본 세트 또는 4.2 이상의 FCV 를 사용하는 샤드 클러스터에서 작동합니다.
이름 | 유형 | 필요성 | 설명 |
---|---|---|---|
| 객체 | 필수 사항 | 복원된 스냅샷 데이터를 전달하는 방법 및 방법에 대한 세부 정보입니다. |
delivery .methodName | 문자열 | 필수 사항 | Ops Manager가 데이터를 전달하는 수단입니다. 응답에 중요: SCP 를 사용한 복원 전달은 MongoDB Ops Manager 4.0에서 제거되었습니다. |
delivery .targetClusterId | 문자열 | 필수 사항 | |
delivery .targetGroupId | 문자열 | 필수 사항 | 복원 job의 대상 cluster가 포함된 프로젝트의 고유 식별자입니다. |
| long | 필수 사항 |
응답
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
---|---|---|
| 배열 | 배열에는 내장된 |
| 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다. |
| 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results
embeddedDocument
각 결과 는 하나의 cluster 복원 작업입니다. 이 배열에는 하나의 복원 작업만 포함됩니다.
이름 | 유형 | 설명 | |||
---|---|---|---|---|---|
| 문자열 | 이 복원 작업이 속한 배치 의 고유 식별자입니다. 스냅샷이 샤드 cluster에서 가져온 경우 반환됩니다. | |||
| 문자열 | 복원 작업이 나타내는 클러스터 의 고유 식별자입니다. 스냅샷이 복제본 세트 또는 샤드 클러스터에서 가져온 경우 반환됩니다. | |||
| 문자열 | ISO 8601 의 타임스탬프 복원 작업이 요청된 시점의 UTC 날짜 및 시간 형식입니다. | |||
| 객체 | 복원된 스냅샷 데이터를 전달하는 방법 및 방법에 대한 세부 정보입니다. | |||
delivery .authBearer | 문자열 |
| |||
delivery .authHeader | 문자열 |
| |||
delivery .authValue | 문자열 |
| |||
delivery .expirationHours | 숫자 | 복원 작업이 완료된 후 다운로드 URL 이 유효한 시간 수입니다. | |||
delivery .expires | 문자열 | ISO 8601 의 타임스탬프 날짜 및 시간 형식(UTC 기준 ) 이후에는 URL 을 더 이상 사용할 수 없습니다. | |||
delivery .maxDownloads | 숫자 | 다운로드 URL 을 사용할 수 있는 횟수입니다. 이 값은 | |||
delivery .methodName | 문자열 | 데이터가 전달되는 수단입니다. | |||
delivery .statusName | 문자열 | 다운로드 가능한 파일의 현재 상태입니다. 허용되는 값은 다음과 같습니다.
| |||
delivery .url | 문자열 | ||||
delivery .urlV2 | 문자열 | 복원된 스냅샷 데이터를 안전하게 다운로드할 수 있는 URL 입니다. 이 URL 에 대한 요청은 HTTP 요청 헤더에
예를 들면 다음과 같습니다.
| |||
| 문자열 | 복원 작업을 소유한 그룹 의 고유 식별자입니다. | |||
| 객체 배열 | 해당 | |||
hashes .fileName | 문자열 | 해시된 스냅샷 파일의 이름입니다. | |||
hashes .hash | 문자열 | 스냅샷 파일의 해시입니다. | |||
hashes .typeName | 문자열 | 해시 값을 계산하는 데 사용되는 해싱 알고리즘입니다. 반환되면 값은 | |||
| 문자열 | ||||
| 문자열 | 복원 작업의 고유 식별자입니다. | |||
| 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 | |||
| 부울 | 스냅샷이 점에서 생성된 것인지 여부를 나타내는 플래그입니다. | |||
| 문자열 | 복원할 스냅샷 의 고유 식별자입니다. | |||
| 문자열 | 작업의 현재 상태입니다. 허용되는 값은 다음과 같습니다.
| |||
| 객체 | 스냅샷이 생성되었을 때 Oplog 항목의 타임스탬프입니다. | |||
timestamp .date | 문자열 | ISO 8601 의 타임스탬프 복원된 스냅샷에 있는 최신 oplog 항목의 UTC 날짜 및 시간 형식입니다. | |||
timestamp .increment | 문자열 | 복원된 스냅샷의 가장 최근 oplog 항목에서 완료된 모든 작업의 순서입니다. |
이름 | 유형 | 설명 |
---|---|---|
| 문자열 | 이 복원 작업이 속한 배치 의 고유 식별자입니다. 스냅샷이 샤드 cluster에서 가져온 경우 반환됩니다. |
| 문자열 | 복원 작업이 나타내는 클러스터 의 고유 식별자입니다. 스냅샷이 복제본 세트 또는 샤드 클러스터에서 가져온 경우 반환됩니다. |
| 문자열 | ISO 8601 의 타임스탬프 복원 작업이 요청된 시점의 UTC 날짜 및 시간 형식입니다. |
| 객체 | 복원된 스냅샷 데이터를 전달하는 방법 및 방법에 대한 세부 정보입니다. |
delivery .methodName | 문자열 | 데이터가 전달되는 수단입니다. |
delivery .targetClusterId | 문자열 | 복원 작업 을 수행할 대상 클러스터 의 고유 식별자입니다. |
delivery .targetGroupId | 문자열 | 복원 job의 대상 cluster가 포함된 프로젝트의 고유 식별자입니다. |
| 문자열 | 복원 작업을 소유한 그룹 의 고유 식별자입니다. |
| 문자열 | |
| 문자열 | 복원 작업의 고유 식별자입니다. |
| 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
| 부울 | 스냅샷이 점에서 생성된 것인지 여부를 나타내는 플래그입니다. |
| 문자열 | 복원할 스냅샷 의 고유 식별자입니다. |
| 문자열 | 작업의 현재 상태입니다. 허용되는 값은 다음과 같습니다.
|
| 객체 | 스냅샷이 생성되었을 때 Oplog 항목의 타임스탬프입니다. |
timestamp .date | 문자열 | ISO 8601 의 타임스탬프 복원된 스냅샷에 있는 최신 oplog 항목의 UTC 날짜 및 시간 형식입니다. |
timestamp .increment | 문자열 | 복원된 스냅샷의 가장 최근 oplog 항목에서 완료된 모든 작업의 순서입니다. |
이름 | 유형 | 설명 |
---|---|---|
| 문자열 | 이 복원 작업이 속한 배치 의 고유 식별자입니다. 스냅샷이 샤드 cluster에서 가져온 경우 반환됩니다. |
| 문자열 | 복원 작업이 나타내는 클러스터 의 고유 식별자입니다. 스냅샷이 복제본 세트 또는 샤드 클러스터에서 가져온 경우 반환됩니다. |
| 문자열 | ISO 8601 의 타임스탬프 복원 작업이 요청된 시점의 UTC 날짜 및 시간 형식입니다. |
| 객체 | 복원된 스냅샷 데이터를 전달하는 방법 및 방법에 대한 세부 정보입니다. |
delivery .methodName | 문자열 | 데이터가 전달되는 수단입니다. |
delivery .targetClusterId | 문자열 | 복원 작업 을 수행할 대상 클러스터 의 고유 식별자입니다. |
delivery .targetGroupId | 문자열 | 복원 job의 대상 cluster가 포함된 프로젝트의 고유 식별자입니다. |
| 문자열 | 복원 작업을 소유한 그룹 의 고유 식별자입니다. |
| 문자열 | |
| 문자열 | 복원 작업의 고유 식별자입니다. |
| 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
| 부울 | 스냅샷이 점에서 생성된 것인지 여부를 나타내는 플래그입니다. |
| 문자열 | 복원할 스냅샷 의 고유 식별자입니다. |
| 문자열 | 작업의 현재 상태입니다. 허용되는 값은 다음과 같습니다.
|
| 객체 | 스냅샷이 생성되었을 때 Oplog 항목의 타임스탬프입니다. |
timestamp .date | 문자열 | ISO 8601 의 타임스탬프 복원된 스냅샷에 있는 최신 oplog 항목의 UTC 날짜 및 시간 형식입니다. |
timestamp .increment | 문자열 | 복원된 스냅샷의 가장 최근 oplog 항목에서 완료된 모든 작업의 순서입니다. |
이름 | 유형 | 설명 |
---|---|---|
| 문자열 | 이 복원 작업이 속한 배치 의 고유 식별자입니다. 스냅샷이 샤드 cluster에서 가져온 경우 반환됩니다. |
| 문자열 | 복원 작업이 나타내는 클러스터 의 고유 식별자입니다. 스냅샷이 복제본 세트 또는 샤드 클러스터에서 가져온 경우 반환됩니다. |
| 문자열 | ISO 8601 의 타임스탬프 복원 작업이 요청된 시점의 UTC 날짜 및 시간 형식입니다. |
| 객체 | 복원된 스냅샷 데이터를 전달하는 방법 및 방법에 대한 세부 정보입니다. |
delivery .methodName | 문자열 | 데이터가 전달되는 수단입니다. |
delivery .targetClusterId | 문자열 | 복원 작업 을 수행할 대상 클러스터 의 고유 식별자입니다. |
delivery .targetGroupId | 문자열 | 복원 job의 대상 cluster가 포함된 프로젝트의 고유 식별자입니다. |
| 문자열 | 복원 작업을 소유한 그룹 의 고유 식별자입니다. |
| 문자열 | |
| 문자열 | 복원 작업의 고유 식별자입니다. |
| 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
| 부울 | 스냅샷이 점에서 생성된 것인지 여부를 나타내는 플래그입니다. |
| 문자열 | 복원할 스냅샷 의 고유 식별자입니다. |
| 문자열 | 작업의 현재 상태입니다. 허용되는 값은 다음과 같습니다.
|
| 객체 | 스냅샷이 생성되었을 때 Oplog 항목의 타임스탬프입니다. |
timestamp .date | 문자열 | ISO 8601 의 타임스탬프 복원된 스냅샷에 있는 최신 oplog 항목의 UTC 날짜 및 시간 형식입니다. |
timestamp .increment | 문자열 | 복원된 스냅샷의 가장 최근 oplog 항목에서 완료된 모든 작업의 순서입니다. |
요청 예시
HTTP 를 사용하여 압축된 스냅샷을 전송하는 복원 작업을 만듭니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "expirationHours" : "1", "maxDownloads" : "1", "methodName" : "HTTP" }, "snapshotId" : "{SNAPSHOT-ID}" }'
스냅샷 에서 자동 복원 을 만듭니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "methodName" : "AUTOMATED_RESTORE", "targetGroupId" : "{TARGET-PROJECT-ID}", "targetClusterId" : "{TARGET-CLUSTER-ID}" }, "snapshotId": "{SNAPSHOT-ID}" }'
oplog 타임스탬프에서 자동 복원 을 생성합니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "methodName" : "AUTOMATED_RESTORE", "targetGroupId" : "{TARGET-PROJECT-ID}", "targetClusterId" : "{TARGET-CLUSTER-ID}" }, "oplogTs" : "1536610288", "oplogInc" : "1" }'
특정 점 부터 자동 복원 을 생성합니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "methodName" : "AUTOMATED_RESTORE", "targetGroupId" : "{TARGET-PROJECT-ID}", "targetClusterId" : "{TARGET-CLUSTER-ID}" }, "pointInTimeUTCMillis" : "1536610288000" }'
응답 예시
응답 헤더
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
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": "2018-09-20T15:00:00Z", "delivery": { "authBearer": "Bearer", "authHeader": "Authorization", "expirationHours": 1, "maxDownloads": 1, "methodName": "HTTP", "statusName": "READY" }, "encryptionEnabled": false, "groupId": "{PROJECT-ID}", "id": "{RESTORE-JOB-ID}", "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}", "rel": "self" }], "pointInTime": false, "snapshotId": "{SNAPSHOT-ID}", "statusName": "FINISHED", "timestamp": { "date": "2018-09-15T15:53:00Z", "increment": 1 } } ], "totalCount" : 1, "url": "{DOWNLOAD-URL}", "urlV2": "https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v3/pull/{restoreJobId}/{filename}" }
{ "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" : "2020-04-21T03:49:57Z", "delivery" : { "expirationHours" : 1, "expires" : "2020-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" } ], "snapshotId" : "{SNAPSHOT-ID}", "statusName" : "FINISHED", "timestamp" : { "date" : "2020-04-18T15:14:25Z", "increment" : 1 } } ], "totalCount" : 1 }
{ "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": "2018-09-20T15:01:00Z", "delivery": { "methodName": "HTTP", "statusName": "READY" }, "encryptionEnabled": false, "groupId": "{PROJECT-ID}", "id": "{RESTORE-JOB-ID}", "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}", "rel": "self" }], "pointInTime": false, "snapshotId": "{SNAPSHOT-ID}", "statusName": "FINISHED", "timestamp": { "date": "2018-09-15T15:53:00Z", "increment": 1 } } ], "totalCount" : 1 }
{ "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": "2018-09-20T15:02:00Z", "delivery": { "methodName": "HTTP", "statusName": "READY" }, "encryptionEnabled": false, "groupId": "{PROJECT-ID}", "id": "{RESTORE-JOB-ID}", "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}", "rel": "self" }], "snapshotId": "{SNAPSHOT-ID}", "statusName": "FINISHED", "timestamp": { "date": "2018-09-15T15:53:00Z", "increment": 1 } } ], "totalCount" : 1 }
{ "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": "2018-09-20T15:03:00Z", "delivery": { "methodName": "HTTP", "statusName": "READY" }, "encryptionEnabled": false, "groupId": "{PROJECT-ID}", "id": "{RESTORE-JOB-ID}", "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}", "rel": "self" }], "snapshotId": "{SNAPSHOT-ID}", "statusName": "FINISHED", "timestamp": { "date": "2018-09-15T15:53:00Z", "increment": 1 } } ], "totalCount" : 1 }