문서 메뉴

문서 홈 → MongoDB Ops Manager

모든 백업 데몬 구성 가져오기

이 페이지의 내용

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

모든 백업 디먼의 구성을 검색합니다.

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

리소스

GET /daemon/configs

요청 경로 매개변수

이 엔드포인트는 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 배열의 객체 수보다 클 수 있습니다.

results embeddedDocument

각 결과 는 하나의 백업 데몬입니다.

이름
유형
설명
assignmentEnabled
부울
이 백업 데몬 에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그입니다.
backupJobsEnabled
부울
이 백업 데몬 을 데이터베이스 백업에 사용할 수 있는지 여부를 나타내는 플래그입니다.
configured
부울
이 백업 데몬 을 사용할 준비가 되었는지 여부를 나타내는 플래그입니다.
garbageCollectionEnabled
부울
이 백업 데몬 에 가비지 컬렉션이 설정되어 있는지 여부를 나타내는 플래그입니다.
headDiskType
문자열

헤드 디렉토리를 저장하는 데 사용되는 디스크 유형입니다.

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

  • HDD

  • SSD

id
문자열
이 백업 데몬의 고유 식별자입니다.
labels
문자열 배열
Ops Manager가 어떤 백업 데몬 에 할당할 수 있는 백업 작업 을 관리하기 위한 태그 배열입니다.
links
객체 배열

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

machine
객체
백업 데몬 호스트 및 해당 헤드 디렉토리.
machine.headRootDirectory
문자열
이 백업 데몬 호스트에 있는 헤드 디렉토리 의 루트 상대 경로입니다.
machine.machine
문자열
백업 데몬 호스트의 호스트 이름 또는 IP 주소입니다.
numWorkers
숫자
백업 데몬에 대한 작업(예: 백업, 복원 또는 그루밍)을 수행할 수 있는 작업자 프로세스의 수입니다.
resourceUsageEnabled
부울
이 백업 데몬 의 리소스 사용량을 모니터링하는지 여부를 나타내는 플래그입니다.
restoreQueryableJobsEnabled
부울
이 백업 데몬 이 쿼리 가능한 복원을 수행할 수 있는지 여부를 나타내는 플래그입니다.

요청 예시

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs?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/daemon/configs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
     "assignmentEnabled" : true,
     "backupJobsEnabled" : false,
     "configured" : true,
     "garbageCollectionEnabled" : true,
     "headDiskType" : "SSD",
     "id" : "{DAEMON-CONFIG}",
     "labels" : [ "l1", "l2" ],
     "links" : [ {
       "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{DAEMON-CONFIG}",
       "rel" : "self"
     }],
     "machine" : {
       "headRootDirectory" : "/data/backup/",
       "machine" : "localhost"
     },
     "numWorkers" : 50,
     "resourceUsageEnabled" : true,
     "restoreJobsEnabled" : false,
     "restoreQueryableJobsEnabled" : true
  } ],
  "totalCount" : 1
}
← ID별로 1개의 백업 데몬 구성 가져오기
1개의 백업 데몬 구성 만들기 →

이 페이지의 내용