Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

모든 프로젝트 백업 작업 구성 가져오기

이 페이지의 내용

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

모든 프로젝트의 백업 작업 구성을 조회합니다.

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

GET /groups

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

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

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

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

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

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

false
backupJobsEnabledOnly
부울
옵션
데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. backupJobsEnabled 플래그가 false 로 설정된 daemon 구성을 포함하려면 이 값을 false 로 설정합니다.
true

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

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

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

결과 는 프로젝트 한 개의 백업 작업에 해당합니다.

이름
유형
설명
DaemonFilter
객체 배열
이 프로젝트의 백업 작업이 제한되는 백업 디먼 호스트 및 해당 헤드 디렉토리 쌍의 배열 입니다.
DaemonFilter.headRootDirectory
문자열
이 백업 데몬 호스트에 있는 헤드 디렉토리 의 루트 상대 경로입니다.
DaemonFilter. machine
문자열
하나의 백업 데몬 호스트에 대한 호스트 주소입니다.
id
문자열
이 프로젝트와 해당 백업 작업 구성을 나타내는 고유 식별자입니다.
kmipClientCertPassword
문자열
KMIP 클라이언트 인증서를 암호화하는 비밀번호입니다.
kmipClientCertPath
문자열
KMIP클라이언트 인증서를 저장하는 백업 데몬 호스트의 디렉토리 경로입니다.
링크
객체 배열

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

레이블 필터
문자열 배열
이 프로젝트 의 백업 작업 을 프로세스 할 수 있는 백업 데몬스냅샷 저장소 를 제한하는 태그 배열 입니다.
oplogStoreFilter
객체 배열
이 프로젝트의 백업 작업에 사용할 수 있는 oplog 저장소 를 나타내는 고유 식별자의 배열입니다.
oplogStoreFilter.id
문자열
이 프로젝트의 백업 작업에 사용할 수 있는 oplog 스토어 를 나타내는 고유 식별자입니다.
oplogStoreFilter.type
문자열
사용할 oplog 스토어 의 유형입니다. 이 값은 항상 oplogStore 입니다.
snapshotStoreFilter
객체 배열
이 프로젝트의 백업 작업에 사용할 수 있는 특정 스냅샷 저장소 및 해당 유형을 나타내는 고유 식별자의 배열입니다. 생략하면 사용 가능한 모든 스냅샷 저장소가 사용됩니다.
snapshotStoreFilter.id
문자열
이 프로젝트의 백업 작업에 사용할 수 있는 특정 스냅샷 저장소 를 나타내는 고유 식별자입니다.
snapshotStoreFilter.type
문자열

snapshotStoreFilter.id 로 지정된 특정 스냅샷 저장소의 유형입니다.

이 옵션에 허용되는 값은 다음과 같습니다.

  • s3blockstore

  • blockstore

  • fileSystemStore

syncStoreFilter
문자열 배열
이 프로젝트의 백업 작업에 사용할 수 있는 동기화 저장소 필터의 배열입니다. 생략하면 사용 가능한 모든 동기화 저장소가 사용됩니다.
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups?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" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups?pretty=true&pageNum=1&itemsPerPage=100",
"rel" : "self"
} ],
"results" : [ {
"daemonFilter" : [ {
"headRootDirectory" : "/data/backup",
"machine" : "http://backup.example.com"
} ],
"id" : "{PROJECT-ID}",
"kmipClientCertPassword" : "P4$$w0rD",
"kmipClientCertPath" : "/certs/kmip",
"labelFilter" : [ "label1", "label2" ],
"links" : [ {
"href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups/{PROJECT-ID}",
"rel" : "self"
}, {
"href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/groups/{PROJECT-ID}",
"rel" : "http://mms.mongodb.com/group"
} ],
"oplogStoreFilter" : [ {
"id" : "oplog1",
"type" : "oplogStore"
} ],
"snapshotStoreFilter" : [ {
"id" : "sPid",
"type" : "s3blockstore"
} ],
"syncStoreFilter" : [ "s1", "s2" ]
} ],
"totalCount" : 1
}

돌아가기

ID별로 1개의 프로젝트 백업 작업 구성 가져오기