1개의 백업 데몬 구성 업데이트

이 페이지의 내용

Resource

요청 경로 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답
요청 예시
응답 예시
응답 헤더
응답 본문

하나의 백업 데몬의 구성을 업데이트합니다.

참고

이미 구성한 하나의 백업 데몬을 업데이트하려는 경우 이 엔드포인트를 사용합니다.

백업 디먼 을 아직 구성하지 않은 경우 하나의 백업 디먼 구성 엔드포인트를 사용하여 구성합니다.

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

Resource

PUT /daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}

요청 경로 매개변수

이름

유형

필요성

설명

MACHINE

문자열

필수 사항

백업 디먼을 제공하는 머신의 호스트 이름 또는 IP 주소입니다.

HEAD-ROOT-DIRECTORY

문자열

필수 사항

루트 상대 URL -인코딩된 경로 이 백업 디먼 호스팅하다 의 헤드 디렉토리 입니다.

URL 경로에 슬래시 인코딩을 요청합니다. 예를 예시 Linux 플랫폼의 경우 다음 형식으로 헤드 디렉토리 를 추가해야 합니다.

http://localhost:8080/api/public/v1.0/admin/backup/
daemon/config/localhost/%2Fdata%2Fbackup%2F

요청 쿼리 매개변수

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

이름

유형

필요성

설명

기본값

pretty

부울

옵션

응답 본문이 프리티 프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

false

envelope

부울

옵션

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

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

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름	설명
`status`	HTTP 응답 코드
`content`	예상되는 응답 본문

false

요청 본문 매개변수

이름	유형	필요성	설명
`assignmentEnabled`	부울	옵션	이 백업 데몬 에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그입니다.
`backupJobsEnabled`	부울	옵션	이 백업 데몬 을 데이터베이스 백업에 사용할 수 있는지 여부를 나타내는 플래그입니다.
`configured`	부울	옵션	이 백업 디먼 을 사용할 준비가 되었는지 여부를 나타내는 플래그입니다.
`garbageCollectionEnabled`	부울	옵션	이 백업 데몬 에 가비지 컬렉션이 설정되어 있는지 여부를 나타내는 플래그입니다.
`headDiskType`	문자열	옵션	헤드 디렉토리를 저장하는 데 사용되는 디스크 유형입니다. 이 옵션에 허용되는 값은 다음과 같습니다. `HDD` `SSD`
`id`	문자열	필수 사항	이 백업 데몬의 고유 식별자입니다.
`labels`	문자열 배열	옵션	가 어떤 백업 데몬 에 할당할 수 있는 백업 작업 을 관리 MongoDB Ops Manager 하기 위한 태그 배열입니다. 이러한 태그를 설정하면 이 백업 데몬이 처리할 수 있는 백업 작업이 제한됩니다. 생략하면 이 백업 데몬은 레이블을 사용하여 작업을 필터링하지 않는 프로젝트의 백업 작업만 처리할 수 있습니다.
`machine`	객체	필수 사항	백업 데몬 호스트 및 해당 헤드 디렉토리.
`machine.headRootDirectory`	문자열	옵션	이 백업 디먼 호스팅하다 에 있는 헤드 디렉토리 의 루트 상대 경로입니다. 이 디렉토리 는 슬래시(`/`)로 끝나야 합니다. 슬래시를 생략하면 백업 디먼 이 Java 예외 오류를 생성합니다.
`machine.machine`	문자열	필수 사항	백업 디먼 호스팅하다 의 호스트 이름 또는 IP 주소 입니다.
`numWorkers`	숫자	옵션	작업을 수행할 수 있는 작업자 프로세스 수(예: 백업, 복원 또는 그루밍) .
`resourceUsageEnabled`	부울	옵션	이 백업 데몬 의 리소스 사용량을 모니터링하는지 여부를 나타내는 플래그입니다.
`restoreQueryableJobsEnabled`	부울	옵션	이 백업 데몬 이 쿼리 가능한 복원을 수행할 수 있는지 여부를 나타내는 플래그입니다.

응답

이름	유형	설명
`assignmentEnabled`	부울	이 백업 데몬 에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그입니다.
`backupJobsEnabled`	부울	이 백업 데몬 을 데이터베이스 백업에 사용할 수 있는지 여부를 나타내는 플래그입니다.
`configured`	부울	이 백업 디먼 을 사용할 준비가 되었는지 여부를 나타내는 플래그입니다.
`garbageCollectionEnabled`	부울	이 백업 데몬 에 가비지 컬렉션이 설정되어 있는지 여부를 나타내는 플래그입니다.
`headDiskType`	문자열	헤드 디렉토리를 저장하는 데 사용되는 디스크 유형입니다. 이 옵션에 허용되는 값은 다음과 같습니다. `HDD` `SSD`
`id`	문자열	이 백업 데몬의 고유 식별자입니다.
`labels`	문자열 배열	가 어떤 백업 데몬 에 할당할 수 있는 백업 작업 을 관리 MongoDB Ops Manager 하기 위한 태그 배열입니다.
`links`	객체 배열	하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 이라는 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
`machine`	객체	백업 데몬 호스트 및 해당 헤드 디렉토리.
`machine.headRootDirectory`	문자열	이 백업 디먼 호스팅하다 에 있는 헤드 디렉토리 의 루트 상대 경로입니다.
`machine.machine`	문자열	백업 디먼 호스팅하다 의 호스트 이름 또는 IP 주소 입니다.
`numWorkers`	숫자	작업을 수행할 수 있는 작업자 프로세스 수(예: 백업, 복원 또는 그루밍) .
`resourceUsageEnabled`	부울	이 백업 데몬 의 리소스 사용량을 모니터링하는지 여부를 나타내는 플래그입니다.
`restoreQueryableJobsEnabled`	부울	이 백업 데몬 이 쿼리 가능한 복원을 수행할 수 있는지 여부를 나타내는 플래그입니다.

요청 예시

1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2      --header 'Accept: application/json' \
3      --header 'Content-Type: application/json' \
4      --include \
5      --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}?pretty=true' \
6      --data '{
7        "assignmentEnabled" : true,
8        "backupJobsEnabled" : false,
9        "configured" : true,
10        "garbageCollectionEnabled" : true,
11        "headDiskType" : "SSD",
12        "labels" : [ "l1", "l2" ],
13        "machine" : {
14          "headRootDirectory" : "/data/backup/",
15          "machine" : "localhost"
16        },
17        "numWorkers" : 50,
18        "resourceUsageEnabled" : true,
19        "restoreQueryableJobsEnabled" : true
20      }'

응답 예시

응답 헤더

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}

응답 본문

1 {
2   "assignmentEnabled" : true,
3   "backupJobsEnabled" : false,
4   "configured" : true,
5   "garbageCollectionEnabled" : true,
6   "headDiskType" : "SSD",
7   "id" : "5991a422ad5df350005dd062",
8   "labels" : [ "l1", "l2" ],
9   "links" : [ {
10     "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}",
11     "rel" : "self"
12   }],
13   "machine" : {
14     "headRootDirectory" : "/data/backup/",
15     "machine" : "localhost"
16   },
17   "numWorkers" : 50,
18   "resourceUsageEnabled" : true,
19   "restoreQueryableJobsEnabled" : true
20 }

돌아가기

만들기

삭제

1	curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2	--header 'Accept: application/json' \
3	--header 'Content-Type: application/json' \
4	--include \
5	--request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}?pretty=true' \
6	--data '{
7	"assignmentEnabled" : true,
8	"backupJobsEnabled" : false,
9	"configured" : true,
10	"garbageCollectionEnabled" : true,
11	"headDiskType" : "SSD",
12	"labels" : [ "l1", "l2" ],
13	"machine" : {
14	"headRootDirectory" : "/data/backup/",
15	"machine" : "localhost"
16	},
17	"numWorkers" : 50,
18	"resourceUsageEnabled" : true,
19	"restoreQueryableJobsEnabled" : true
20	}'