/ /

/ /

1개의 블록 저장소 구성 업데이트

한 블록 저장소의 구성을 업데이트합니다.

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

Resource

PUT /snapshot/mongoConfigs/{BLOCKSTORE-ID}

요청 경로 매개변수

이름	유형	설명
BLOCKSTORE-ID	문자열	이 블록 저장소 구성에 레이블을 지정하는 고유한 이름입니다.

요청 쿼리 매개변수

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

이름	유형	필요성	설명	기본값
pretty	부울	옵션	응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다.	`false`
envelope	부울	옵션	응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다. `status`HTTP 응답 코드 `content`예상되는 응답 본문	`false`

요청 본문 매개변수

이름	유형	설명
AssignmentEnabled	부울	선택 사항. 이 블록 저장소 에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그입니다.
암호화된 자격증명	부울	선택 사항. 이 블록 저장소의 사용자 이름 과 비밀번호가 블록 저장소 을 사용하여 암호화됨 되었는지 여부를 나타내는 플래그 입니다.
labels	문자열 배열	선택 사항. 가 어떤 블록 저장소에 MongoDB Ops Manager 할당할 수 있는 백업 작업 을 관리 하기 위한 태그 배열입니다. 이러한 태그를 설정하면 이 블록 저장소가 처리할 수 있는 백업 작업이 제한됩니다. 생략하면 이 블록 저장소는 레이블을 사용하여 작업을 필터링하지 않는 프로젝트의 백업 작업만 처리할 수 있습니다.
부하 계수	숫자	선택 사항. 이 스냅샷 저장소 가 다른 스냅샷 저장소와 비교하여 수행해야 하는 백업 작업의 양을 나타내는 0이 아닌 양의 정수입니다. 이 옵션은 둘 이상의 스냅샷 저장소를 사용 중인 경우에만 필요합니다. Load Factor 에 학습 보려면 기존 블록 저장소 1개 편집을 참조하세요.
maxCapacityGB	숫자	선택 사항. OUTSIDE_SPACE_USED_THRESHOLD 경고 에서 사용할 수 있는 블록 저장소의 예상 최대 가용 용량 입니다. `maxCapacityGB` 는 백업 데이터베이스 의 크기에 대한 제한을 시행하다 하지 않습니다.
OIDC	객체	선택 사항. 이 저장소에 대한 OIDC 인증 설정입니다. `oidc` 객체는 다음 필드를 허용합니다. `enabled`: 불리언. 이 저장에 대한 OIDC 인증을 활성화합니다. `method`: string. `callback`, `azure`, `gcp` 또는 `k8s` 중 하나. `tokenUri`: string. 자격 증명 공급자 토큰 엔드포인트입니다. `method`가 `callback`인 경우 필수입니다. `clientId`: string. 자격 증명 공급자에 등록된 클라이언트 ID입니다. `method`가 `callback`인 경우 필수입니다. `method`가 `azure`인 경우 선택 사항입니다. `clientSecret`: string. 자격 증명 공급자에 등록된 클라이언트 시크릿. `method`이 `callback`인 경우 필수입니다. 기존 저장소를 편집하고 이 필드를 생략하거나 이전 `GET` 요청에서 반환된 수정된 값을 제출하면 MongoDB Ops Manager에서 기존 시크릿을 유지합니다. `scope`: string. 자격 증명 공급자에서 요청한 OAuth2 범위. `method`이 `callback`인 경우에만 사용됩니다. `tokenResource`: string. 워크로드 자격 정보 토큰의 대상 그룹 또는 리소스 식별자입니다. `method`이 `azure` 또는 `gcp`인 경우 필수입니다. 이 값은 대상 MongoDB 배포의 `oidcIdentityProviders` 설정에서 이 자격 증명 공급자에 구성된 `audience`와(과) 일치해야 합니다. `callback`, `azure`, `gcp` 및 `k8s` 메서드에 모든 동일한 필드가 필요하지는 않습니다. `azure`, `gcp` 및 `k8s` 메서드에는 `clientSecret`가 필요하지 않습니다. `oidc.enabled`이 `true`인 경우, 저장소의 `uri` 필드에만 호스팅과 연결 옵션을 제공합니다. MongoDB Ops Manager는 URI에 포함된 사용자 이름 또는 비밀번호를 무시합니다. 저장소를 OIDC에서 다른 인증 메커니즘으로 전환하려면 `oidc` 객체를 생략하는 대신 요청에 `oidc: {enabled: false}`를 제출합니다.
uri	문자열	이 블록 저장소에 액세스하는 데 사용할 수 있는 `<hostname:port>` 형식의 쉼표로 구분된 호스트 목록입니다 .
ssl	부울	선택 사항. 이 블록 저장소 가 TLS 를 사용하여 암호화됨 연결만 허용하는지 여부를 나타내는 플래그입니다.
쓰기 고려	문자열	선택 사항. 이 블록 저장소에 사용되는 쓰기 고려입니다. 이 옵션에 허용되는 값은 다음과 같습니다. `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` MongoDB 의 쓰기 (write) 승인 수준에 학습 보려면 쓰기 고려를 참조하세요 .

응답

이름	유형	설명
AssignmentEnabled	부울	이 블록 저장소 에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그입니다.
암호화된 자격증명	부울	이 블록 저장소의 사용자 이름 과 비밀번호가 블록 저장소 을 사용하여 암호화됨 되었는지 여부를 나타내는 플래그 입니다.
id	문자열	이 블록 저장소에 레이블을 지정하는 고유 이름입니다.
labels	문자열 배열	MongoDB Ops Manager가 어떤 블록 저장소에 할당할 수 있는 백업 작업 을 관리하기 위한 태그 배열입니다 .
링크	객체 배열	하위 리소스 또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에 설명되어 있습니다.
부하 계수	숫자	이 스냅샷 저장소 가 다른 스냅샷 저장소와 비교하여 수행해야 하는 백업 작업의 양을 나타내는 0이 아닌 양의 정수입니다. 이 옵션은 둘 이상의 스냅샷 저장소를 사용 중인 경우에만 필요합니다. Load Factor 에 학습 보려면 기존 블록 저장소 1개 편집을 참조하세요.
maxCapacityGB	숫자	선택 사항. OUTSIDE_SPACE_USED_THRESHOLD 경고 에서 사용할 수 있는 블록 저장소의 예상 최대 가용 용량 입니다. `maxCapacityGB` 는 백업 데이터베이스 의 크기에 대한 제한을 시행하다 하지 않습니다.
OIDC	객체	이 저장소에 대한 OIDC 인증 설정입니다. `oidc` 객체에는 다음 필드가 포함되어 있습니다. `enabled`: 불리언. 이 저장소에 OIDC 인증이 활성화되어 있는지 여부를 나타냅니다. `method`: string. `callback`, `azure`, `gcp` 또는 `k8s` 중 하나. `tokenUri`: string. 자격 증명 공급자 토큰 엔드포인트입니다. `method`가 `callback`인 경우에만 표시됩니다. `clientId`: string. 자격 증명 공급자에 등록된 클라이언트 ID입니다. `clientSecret`: string. MongoDB Ops Manager는 응답에서 이 값을 수정하며 원본 클라이언트 시크릿을 반환하지 않습니다. `scope`: string. 자격 증명 공급자에서 요청한 OAuth2 범위입니다. `method`이 `callback`인 경우에만 표시됩니다. `tokenResource`: string. 워크로드 인덴티티 토큰의 대상 또는 리소스 식별자입니다. `method`이 `azure` 또는 `gcp`인 경우에만 제시됩니다.
uri	문자열	이 블록 저장소에 액세스하는 데 사용할 수 있는 `<hostname:port>` 형식의 쉼표로 구분된 호스트 목록입니다 .
ssl	부울	이 블록 저장소가 TLS 를 사용하여 암호화된 연결만 허용하는지 여부를 나타내는 플래그입니다.
usedSize	숫자	기존 백업이 사용하는 백업 용량의 양( MB )입니다.
쓰기 고려	문자열	이 블록 저장소에 사용되는 쓰기 고려입니다. 이 옵션에 허용되는 값은 다음과 같습니다. `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` MongoDB 의 쓰기 (write) 승인 수준에 학습 보려면 쓰기 고려를 참조하세요 .

요청 예시

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/snapshot/mongoConfigs/{BLOCKSTORE-ID}?pretty=true' \
 --data '{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "labels" : [ "l1", "l2" ],
  "loadFactor" : 2,
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "writeConcern" : "W2"
}'

응답 예시

응답 헤더

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}

응답 본문

{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "id" : "{BLOCKSTORE-CONFIG-ID}",
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs/{BLOCKSTORE-ID}",
    "rel" : "self"
  }],
  "loadFactor" : 2,
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "usedSize" : 222,
  "writeConcern" : "W2"
}

돌아가기

만들기

삭제