/ /

/ /

1개의 블록 저장소 구성 생성

하나의 새 블록 저장소를 구성합니다.

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

Resource

POST /snapshot/mongoConfigs

요청 경로 매개변수

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

요청 쿼리 매개변수

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

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

요청 본문 매개변수

이름	유형	설명
AssignmentEnabled	부울	선택 사항. 이 블록 저장소 에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그입니다.
암호화된 자격증명	부울	선택 사항. 이 블록 저장소의 사용자 이름 과 비밀번호가 블록 저장소 을 사용하여 암호화됨 되었는지 여부를 나타내는 플래그 입니다.
id	문자열	이 블록 저장소에 레이블을 지정하는 고유 이름입니다.
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`: 문자열.IdP 토큰 엔드포인트입니다. `method`가 `callback`일 때 필요합니다. `clientId`: 문자열.IdP에 등록된 클라이언트 ID . `method`가 `callback`인 경우 필수입니다. `method`이 `azure`인 경우 선택 사항입니다. `clientSecret`: 문자열.IdP에 등록된 클라이언트 시크릿입니다. `method`가 `callback`일 때 필요합니다. 기존 저장 편집하고 이 필드 생략하거나 이전 `GET` 요청 에서 반환된 수정된 값을 제출 경우, Ops Manager 기존 시크릿을 유지합니다. `scope`: 문자열.IdP에서 요청한 OAuth2 범위입니다. `method`가 `callback`인 경우에만 사용됩니다. `tokenResource`: 문자열. 워크로드 ID 토큰의 대상 또는 리소스 식별자입니다. `method`가 `azure` 또는 `gcp`인 경우 필수입니다. 이 값은 대상 MongoDB deployment의 `oidcIdentityProviders` 설정에서 이 IdP에 대해 구성된 `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`: 문자열.IdP 토큰 엔드포인트입니다. `method`가 `callback`인 경우에만 표시됩니다. `clientId`: 문자열.IdP에 등록된 클라이언트 ID . `clientSecret`: string. MongoDB Ops Manager는 응답에서 이 값을 수정하며 원본 클라이언트 시크릿을 반환하지 않습니다. `scope`: 문자열.IdP에서 요청한 OAuth2 범위입니다. `method`가 `callback`인 경우에만 표시됩니다. `tokenResource`: string. 워크로드 인덴티티 토큰의 대상 또는 리소스 식별자입니다. `method`이 `azure` 또는 `gcp`인 경우에만 제시됩니다.
uri	문자열	이 블록 저장소에 액세스하는 데 사용할 수 있는 `<hostname:port>` 형식의 쉼표로 구분된 호스트 목록입니다 .
ssl	부울	이 블록 저장소가 TLS 를 사용하여 암호화된 연결만 허용하는지 여부를 나타내는 플래그입니다.
usedSize	숫자	기존 백업이 사용하는 백업 용량( MB )입니다.
쓰기 고려	문자열	이 블록 저장소에 사용되는 쓰기 고려입니다. 이 옵션에 허용되는 값은 다음과 같습니다. `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` MongoDB 의 쓰기 (write) 승인 수준에 학습 보려면 쓰기 고려를 참조하세요 .

요청 예시

1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2      --header 'Accept: application/json' \
3      --header 'Content-Type: application/json' \
4      --include \
5      --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs?pretty=true' \
6      --data '{
7          "assignmentEnabled" : true,
8          "encryptedCredentials" : false,
9          "id" : "{BLOCKSTORE-CONFIG-ID}",
10          "labels" : [ "l1", "l2" ],
11          "loadFactor" : 2,
12          "maxCapacityGB" : 8,
13          "uri" : "mongodb://localhost:27017",
14          "ssl" : true,
15          "writeConcern" : "W2"
16        }'

응답 예시

응답 헤더

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   "encryptedCredentials" : false,
4   "id" : "{BLOCKSTORE-CONFIG-ID}",
5   "labels" : [ "l1", "l2" ],
6   "links" : [ {
7     "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs",
8     "rel" : "self"
9   }],
10   "loadFactor" : 2,
11   "maxCapacityGB" : 8,
12   "uri" : "mongodb://localhost:27017",
13   "ssl" : true,
14   "usedSize" : 222,
15   "writeConcern" : "W2"
16 }

돌아가기

모두 가져오기

Update

1	curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2	--header 'Accept: application/json' \
3	--header 'Content-Type: application/json' \
4	--include \
5	--request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs?pretty=true' \
6	--data '{
7	"assignmentEnabled" : true,
8	"encryptedCredentials" : false,
9	"id" : "{BLOCKSTORE-CONFIG-ID}",
10	"labels" : [ "l1", "l2" ],
11	"loadFactor" : 2,
12	"maxCapacityGB" : 8,
13	"uri" : "mongodb://localhost:27017",
14	"ssl" : true,
15	"writeConcern" : "W2"
16	}'