1개의 프로젝트 백업 작업 구성 업데이트

이 페이지의 내용

Resource

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

한 프로젝트의 백업 작업 구성을 업데이트합니다.

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

Resource

PUT /groups/{PROJECT-ID}

요청 경로 매개변수

이름	유형	설명
프로젝트 ID	문자열	이 프로젝트와 해당 백업 작업 구성을 나타내는 고유 식별자입니다.

요청 쿼리 매개변수

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

이름

유형

필요성

설명

기본값

pretty

부울

옵션

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

false

envelope

부울

옵션

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

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

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

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

false

요청 본문 매개변수

이름	유형	설명
DaemonFilter	객체 배열	선택 사항. 이 프로젝트의 백업 작업이 제한되는 백업 디먼 호스트 및 해당 헤드 디렉토리 쌍의 배열 입니다. 생략하면 사용 가능한 모든 백업 데몬이 사용됩니다.
DaemonFilter.headRootDirectory	문자열	선택 사항. 이 백업 디먼 호스팅하다 에 있는 헤드 디렉토리 의 루트 상대 경로입니다.
DaemonFilter. machine	문자열	하나의 백업 데몬 호스트에 대한 호스트 주소입니다.
id	문자열	이 프로젝트와 해당 백업 작업 구성을 나타내는 고유 식별자입니다.
kmipClientCertPassword	문자열	선택 사항. KMIP 클라이언트 인증서를 암호화하는 비밀번호입니다.
kmipClientCertPath	문자열	선택 사항. KMIP클라이언트 인증서를 저장하는 백업 데몬 호스트의 루트 상대 경로입니다.
레이블 필터	문자열 배열	선택 사항. 이 프로젝트 의 백업 작업 을 프로세스 할 수 있는 백업 데몬 과 스냅샷 저장소 를 제한하는 태그 배열 입니다. 스냅샷 저장소 또는 백업 데몬에 이 `labelFilter` 와 동일한 `labels` 가 설정되어 있는 경우 이 프로젝트의 백업 작업을 처리할 수 있습니다. 생략하면 프로젝트의 백업 작업에서 사용 가능한 모든 백업 데몬 또는 스냅샷 저장소를 사용할 수 있습니다.
oplogStoreFilter	객체 배열	선택 사항. 이 프로젝트의 백업 작업에 사용할 수 있는 oplog 저장소 를 나타내는 고유 식별자의 배열입니다. 생략하면 사용 가능한 모든 oplog 스토어를 사용할 수 있습니다.
oplogStoreFilter.id	문자열	이 프로젝트의 백업 작업에 사용할 수 있는 oplog 스토어 를 나타내는 고유 식별자입니다. 모든 구성 가져오기 와 함께 사용하려는 `id` 저장 oplog 의 를 검색합니다.oplog
oplogStoreFilter.type	문자열	사용할 oplog 스토어 의 유형입니다. 지원되는 유일한 값은 `oplogStore` 입니다.
snapshotStoreFilter	객체 배열	선택 사항. 이 프로젝트의 백업 작업에 사용할 수 있는 특정 스냅샷 저장소 및 해당 유형을 나타내는 고유 식별자의 배열입니다. 생략하면 사용 가능한 모든 스냅샷 저장소가 사용됩니다.
snapshotStoreFilter.id	문자열	선택 사항. 이 프로젝트의 백업 작업에 사용할 수 있는 특정 스냅샷 저장소 를 나타내는 고유 식별자입니다.
snapshotStoreFilter.type	문자열	선택 사항. `snapshotStoreFilter.id` 으로 지정된 특정 스냅샷 저장소의 유형입니다. 이 옵션에 허용되는 값은 다음과 같습니다. `s3blockstore` `blockstore` `fileSystemStore`
syncStoreFilter	문자열 배열	선택 사항. 이 프로젝트의 백업 작업에 사용할 수 있는 동기화 저장소 필터의 배열입니다. 생략하면 사용 가능한 모든 동기화 저장소가 사용됩니다.

응답

이름	유형	설명
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' \
 --header 'Content-Type: application/json' \
 --include \
 --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups/{PROJECT-ID}?pretty=true' \
 --data '{
  "daemonFilter" : [ {
     "headRootDirectory" : "/data/backup",
     "machine" : "http://backup.example.com"
   } ],
   "id" : "{PROJECT-ID}",
   "kmipClientCertPassword" : "P4$$w0rD",
   "kmipClientCertPath" : "/certs/kmip",
   "labelFilter" : [ "label1", "label2" ],
   "oplogStoreFilter" : [ {
     "id" : "oplog1",
     "type" : "oplogStore"
   } ],
   "snapshotStoreFilter" : [ {
     "id" : "sPid",
     "type" : "s3blockstore"
   } ],
   "syncStoreFilter" : [ "s1", "s2" ]
 }'

응답 예시

응답 헤더

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}

응답 본문

{
  "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" ]
}

돌아가기

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

백업 암호화 키