/ /

/ /

1개의 동기화 저장소 구성 만들기

하나의 새 동기화 저장소를 구성합니다.

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

Resource

POST /sync/mongoConfigs

요청 경로 매개변수

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

요청 쿼리 매개변수

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

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

요청 본문 매개변수

이름	유형	설명
AssignmentEnabled	부울	선택 사항. 이 동기화 저장소에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그입니다.
암호화된 자격증명	부울	선택 사항. 이 동기화 저장소의 사용자 이름 및 비밀번호가 credentialstool을 사용하여 암호화되었는지 여부를 나타내는 플래그입니다.
id	문자열	이 동기화 저장소에 레이블을 지정하는 고유 이름입니다.
labels	문자열 배열	Optional. Array of tags to manage which backup jobs Ops Manager can assign to which sync stores. 이러한 태그를 설정하면 이 동기화 저장소가 처리할 수 있는 백업 작업이 제한됩니다. 생략하면 이 동기화 저장소는 레이블을 사용하여 작업을 필터링하지 않는 프로젝트의 백업 작업만 처리할 수 있습니다.
maxCapacityGB	숫자	선택 사항. OUTSIDE_SPACE_USED_THRESHOLD 경고 에서 사용할 수 있는 동기화 저장소의 예상 최대 사용 가능한 용량 입니다. `maxCapacityGB` 는 백업 데이터베이스 의 크기에 대한 제한을 시행하다 하지 않습니다.
OIDC	객체	선택 사항. OIDC authentication settings for this store. The `oidc` object accepts the following fields: `enabled`: boolean. Enables OIDC authentication for this store. `method`: string. `callback`, `azure`, `gcp` 또는 `k8s` 중 하나. `tokenUri`: string. The IdP token endpoint. Required when `method` is `callback`. `clientId`: string. The client ID registered with the IdP. Required when `method` is `callback`; optional when `method` is `azure`. `clientSecret`: string. The client secret registered with the IdP. Required when `method` is `callback`. If you edit an existing store and omit this field or submit the redacted value returned by a previous `GET` request, Ops Manager preserves the existing secret. `scope`: string. The OAuth2 scope requested from the IdP. Used only when `method` is `callback`. `tokenResource`: string. The audience or resource identifier for the workload identity token. Required when `method` is `azure` or `gcp`. This value must match the `audience` configured for this IdP in the target MongoDB deployment's `oidcIdentityProviders` setting. `callback`, `azure`, `gcp` 및 `k8s` 메서드에 모든 동일한 필드가 필요하지는 않습니다. `azure`, `gcp` 및 `k8s` 메서드에는 `clientSecret`가 필요하지 않습니다. `oidc.enabled`이 `true`인 경우, 저장소의 `uri` 필드에만 호스팅과 연결 옵션을 제공합니다. MongoDB Ops Manager는 URI에 포함된 사용자 이름 또는 비밀번호를 무시합니다. To switch a store from OIDC to another authentication mechanism, submit `oidc: {enabled: false}` in the request instead of omitting the `oidc` object.
uri	문자열	이 동기화 저장소에 액세스하는 데 사용할 수 있는 `<hostname:port>` 형식의 쉼표로 구분된 호스트 목록입니다.
ssl	부울	선택 사항. 이 동기화 저장소가 TLS 를 사용하여 암호화된 연결만 허용하는지 여부를 나타내는 플래그입니다.
쓰기 고려	문자열	선택 사항. 이 동기화 저장소에 사용되는 쓰기 고려 (write concern)입니다. 이 옵션에 허용되는 값은 다음과 같습니다. `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` MongoDB 의 쓰기 (write) 승인 수준에 학습 보려면 쓰기 고려를 참조하세요 .

응답

이름	유형	설명
AssignmentEnabled	부울	이 동기화 저장소에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그입니다.
암호화된 자격증명	부울	이 동기화 저장소의 사용자 이름 및 비밀번호가 credentialstool을 사용하여 암호화되었는지 여부를 나타내는 플래그입니다.
id	문자열	이 동기화 저장소에 레이블을 지정하는 고유 이름입니다.
labels	문자열 배열	Array of tags to manage which backup jobs Ops Manager can assign to which sync stores.
링크	객체 배열	하위 리소스 또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에 설명되어 있습니다.
maxCapacityGB	숫자	선택 사항. OUTSIDE_SPACE_USED_THRESHOLD 경고 에서 사용할 수 있는 동기화 저장소의 예상 최대 사용 가능한 용량 입니다. `maxCapacityGB` 는 백업 데이터베이스 의 크기에 대한 제한을 시행하다 하지 않습니다.
OIDC	객체	OIDC authentication settings for this store. The `oidc` object contains the following fields: `enabled`: boolean. Indicates whether OIDC authentication is enabled for this store. `method`: string. `callback`, `azure`, `gcp` 또는 `k8s` 중 하나. `tokenUri`: string. The IdP token endpoint. Present only when `method` is `callback`. `clientId`: string. The client ID registered with the IdP. `clientSecret`: string. MongoDB Ops Manager는 응답에서 이 값을 수정하며 원본 클라이언트 시크릿을 반환하지 않습니다. `scope`: string. The OAuth2 scope requested from the IdP. Present only when `method` is `callback`. `tokenResource`: string. 워크로드 인덴티티 토큰의 대상 또는 리소스 식별자입니다. `method`이 `azure` 또는 `gcp`인 경우에만 제시됩니다.
uri	문자열	이 동기화 저장소에 액세스하는 데 사용할 수 있는 `<hostname:port>` 형식의 쉼표로 구분된 호스트 목록입니다.
ssl	부울	이 동기화 저장소가 TLS 를 사용하여 암호화된 연결만 허용하는지 여부를 나타내는 플래그입니다.
usedSize	숫자	기존 백업이 사용하는 백업 용량( MB )입니다.
쓰기 고려	문자열	이 동기화 저장소에 사용되는 쓰기 고려 (write concern)입니다. 이 옵션에 허용되는 값은 다음과 같습니다. `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/sync/mongoConfigs?pretty=true' \
6      --data '{
7        "assignmentEnabled" : true,
8        "encryptedCredentials" : false,
9        "id" : "{SYNCSTORE-CONFIG-ID}",
10        "labels" : [ "l1", "l2" ],
11        "maxCapacityGB" : 8,
12        "uri" : "mongodb://localhost:27017",
13        "ssl" : true,
14        "writeConcern" : "W2"
15      }'

응답 예시

응답 헤더

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

돌아가기

모두 가져오기

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/sync/mongoConfigs?pretty=true' \
6	--data '{
7	"assignmentEnabled" : true,
8	"encryptedCredentials" : false,
9	"id" : "{SYNCSTORE-CONFIG-ID}",
10	"labels" : [ "l1", "l2" ],
11	"maxCapacityGB" : 8,
12	"uri" : "mongodb://localhost:27017",
13	"ssl" : true,
14	"writeConcern" : "W2"
15	}'