참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID가 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /admin/backup/backupDeployments요청 매개변수
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 |
|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다. |
|
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
요청 본문 매개변수
이름 | 유형 | 필요성 | 설명 |
|---|---|---|---|
| 부울 | 옵션 | 백업 리소스에 배포 리전 을 할당할 수 있는지 여부를 나타내는 플래그입니다. |
| 문자열 | 필수 사항 | MongoDB Ops Manager 쿼리 가능 백업 요청을 처리하는 인스턴스 입니다. 값의 형식은 |
| 문자열 | 필수 사항 | 배포 리전의 목적을 설명하는 string 입니다. |
| 문자열 | Reguired | 구성에서 이 배포서버 리전 을 참조하는 고유 식별자입니다. |
| 문자열 | Reguired | 백업 에이전트 스냅샷 또는 oplog 데이터를 쓰기 (write)하는 Ops Manager 인스턴스. 값은 유효한 URL 예를 들어 |
| 문자열 | 필수 사항 | 복원 요청을 처리하는 MongoDB Ops Manager 인스턴스 입니다. |
응답
이름 | 유형 | 설명 |
|---|---|---|
| 부울 | 백업 리소스에 배포 리전 을 할당할 수 있는지 여부를 나타내는 플래그입니다. |
| 문자열 | MongoDB Ops Manager 쿼리 가능 백업 요청을 처리하는 인스턴스 입니다. 값의 형식은 |
| 문자열 | 배포 리전의 목적을 설명하는 string 입니다. |
| 문자열 | 구성에서 이 배포서버 리전 을 참조하는 고유 식별자입니다. |
| 문자열 | 백업 에이전트 스냅샷 또는 oplog 데이터를 쓰기 (write)하는 Ops Manager 인스턴스. 값은 유효한 URL 예를 들어 |
| 객체 배열 | 하위 리소스 또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
| 문자열 | 복원 요청을 처리하는 MongoDB Ops Manager 인스턴스 입니다. |
요청 예시
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --include \ --request POST "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/NY_NJ?pretty=true" --data ' { "id": "AU_NZ", "ingestionEndpoint": "https://api-backup.mongodb.com", "restoreEndpoint": "https://api-backup.mongodb.com", "bqProxyEndpoint": "queryable-backup.mongodb.com:27217", "deploymentDescription": "Australia and New Zealand", "assignmentEnabled": true }'응답 예시
응답 헤더
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}응답 본문
{ "assignmentEnabled" : true, "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217", "deploymentDescription" : "Australia and New Zealand", "id" : "AU_NZ", "ingestionEndpoint" : "https://api-backup.mongodb.com", "links" : [ ], "restoreEndpoint" : "https://api-backup.mongodb.com"}