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

요청 본문 매개변수

이름	유형	필요성	설명
acceptTos	부울	필수 사항	MongoDB Ops Manager에서 S3호환 저장소를 사용하기 위한 서비스 약관에 동의했는지 여부를 나타내는 플래그입니다. S3호환 저장 스토어를 만들려면 이것을 `true`로 설정해야 합니다. 이 값을 `false` 로 설정하면 Ops Manager에서 오류를 반환합니다. 오류는 Ops Manager가 S3 호환 스토리지 저장소를 생성할 수 없다고 표시됩니다.
AssignmentEnabled	부울	옵션	이 데이터 저장소에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그.
AWS 액세스 키	문자열	조건부	s3BucketName에 지정된 S3호환 저장 버킷에 액세스 할 수 있는AWS 액세스 키 ID . `"s3AuthMethod" : "IAM_ROLE"` 인 경우 awsAccessKey 를 포함할 필요가 없습니다.
AWS 비밀 키	문자열	조건부	`<s3BucketName>`에 지정된 S3호환 저장 버킷에 액세스 할 수 있는AWS 시크릿 액세스 키입니다. `"s3AuthMethod" : "IAM_ROLE"` 인 경우 awsSecretKey 를 포함할 필요가 없습니다.
customCertificates	배열	옵션	연결된 S3 호환 저장소 버킷에 적용되는 유효한 인증 기관 인증서 목록입니다.
customCertificates[n].filename	문자열	옵션	인증 기관 PEM 파일을 식별하는 이름입니다.
customCertificates[n].certString	문자열	옵션	인증 기관 체인을 구성하는 인증 기관 PEM 파일의 콘텐츠입니다.
disableProxyS3	부울	필수 사항	S3호환 저장 에 연결할 때 HTTP proxy 사용할지 여부를 나타냅니다. HTTP proxy 사용하도록 Ops Manager 구성하지 않은 경우에도 S3호환 저장 oplog 저장 생성하거나 업데이트 하려면 모든 요청 에 이 필드 포함해야 합니다.
암호화된 자격증명	부울	옵션	이 S3호환 저장 oplog 저장 의 사용자 이름 과 비밀번호가 credentialstool을 사용하여 암호화됨 되었는지 여부를 나타내는 플래그입니다 .
id	문자열	필수 사항	이 S3호환 스토리지 oplog 저장소를 고유하게 식별하는 이름입니다.
labels	문자열 배열	옵션	가 어떤 S 저장에 할당할 수 있는 백업 작업 을 관리 하기 위한 태그 배열입니다. MongoDB Ops Manager 3 oplog 이러한 태그를 설정하면 이 S3호환 저장 oplog 저장 가 프로세스 할 수 있는 백업 작업이 제한됩니다. 생략하면 이 S3호환 저장 oplog 저장 는 레이블을 사용하여 작업을 필터하다 하지 않는 프로젝트의 백업 작업만 프로세스 할 수 있습니다.
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}`를 제출 .
경로 스타일 액세스 활성화	부울	필수 사항	이 엔드포인트의 스타일을 나타내는 플래그입니다. `true`: 경로 스타일 URL 엔드포인트입니다. 예시: `s3.amazonaws.com/<bucket>`. `false`: 가상 호스트 스타일의 URL 엔드포인트입니다. 예시: `<bucket>.s3.amazonaws.com`. S3호환 저장 버킷 URL 규칙을 검토 하려면 AWS S3 문서를 참조하세요.
s3AuthMethod	문자열	옵션	s3BucketName 에 지정된 S3 호환 스토리지 버킷에 대한 액세스 권한을 부여하는 데 사용되는 메서드입니다. Ops Manager는 다음 값을 허용합니다. `KEYS` 또는 없음: Ops Manager awsAccessKey 및 awsSecretKey를 사용하여 s3BucketName에 지정된 S3호환 저장 버킷에 대한 액세스 권한을 부여합니다. `IAM_ROLE`: Ops Manager AWS IAM 역할 사용하여 s3BucketName에 지정된 S3호환 저장 버킷에 대한 액세스권한을 부여합니다. awsAccessKey 및 awsSecretKey 필드는 무시됩니다. 자세한 학습 은 AWS 설명서를 참조하세요.
s3BucketEndpoint	문자열	필수 사항	이 S3 호환 저장 버킷에 액세스 데 사용되는URL .
S3 버킷 이름	문자열	필수 사항	S3호환 스토리지 oplog 저장소를 호스팅하는 S3호환 스토리지 버킷의 이름입니다.
S3 최대 연결	숫자	필수 사항	이 S3호환 스토리지 oplog 저장소에 대한 최대 연결 수를 나타내는 양의 정수입니다.
s3RegionOverride	문자열	조건부	S3 호환 스토리지 버킷이 있는 리전입니다. 이 필드 S3호환 저장 저장소의 s3BucketEndpoint가 리전 범위를 지원 하지 않는 경우에만 사용합니다. 이 필드 AWS S3 버킷과 함께 사용하지 마세요.
sseEnabled	부울	필수 사항	이 S3 호환 저장 oplog 저장 서버 측 암호화 활성화하는지 여부를 나타내는 플래그입니다.
ssl	부울	옵션	Flag that indicates whether this S3-compatible storage oplog store only accepts connections encrypted using TLS.
uri	문자열	필수 사항	이 S3호환 저장 oplog 저장 의 메타데이터 데이터베이스 에 연결하는 연결 문자열입니다. 이 데이터베이스 S3 호환 저장 버킷에 블록의 위치를 저장합니다.
쓰기 고려	문자열	옵션	이 oplog 스토어에 사용되는 쓰기 고려입니다. Ops Manager는 다음 값을 허용합니다. `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` MongoDB 의 쓰기 (write) 승인 수준에 학습 보려면 쓰기 고려를 참조하세요 .

응답

이름	유형	설명
acceptTos	부울	MongoDB Ops Manager에서 S3호환 저장소를 사용하기 위한 서비스 약관에 동의했는지 여부를 나타내는 플래그입니다. S3호환 저장 스토어를 만들려면 이것을 `true`로 설정해야 합니다.
AssignmentEnabled	부울	이 데이터 저장소에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그.
AWS 액세스 키	문자열	s3BucketName에 지정된 S3호환 저장 버킷에 액세스 할 수 있는AWS 액세스 키 ID .
AWS 비밀 키	문자열	s3BucketName에 지정된 S3호환 저장 버킷에 액세스 할 수 있는AWS 시크릿 액세스 키입니다.
customCertificates	배열	연결된 S3 호환 저장소 버킷에 적용되는 유효한 인증 기관 인증서 목록입니다.
customCertificates[n].filename	문자열	인증 기관 PEM 파일을 식별하는 이름입니다.
customCertificates[n].certString	문자열	인증 기관 체인을 구성하는 인증 기관 PEM 파일의 콘텐츠입니다.
disableProxyS3	부울	S3호환 저장소에 연결할 때 HTTP proxy를 사용해야 하는지 여부를 나타내는 플래그입니다.
암호화된 자격증명	부울	이 S3호환 저장 oplog 저장 의 사용자 이름 과 비밀번호가 credentialstool을 사용하여 암호화됨 되었는지 여부를 나타내는 플래그입니다 .
id	문자열	이 S3호환 스토리지 oplog 저장소를 고유하게 식별하는 이름입니다.
labels	문자열 배열	가 어떤 S 호환 저장 저장할 수 있는 백업 작업 을 관리 있는 태그 배열입니다. MongoDB Ops Manager 3 oplog
링크	객체 배열	하위 리소스 또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에 설명되어 있습니다.
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`인 경우에만 제시됩니다.
경로 스타일 액세스 활성화	부울	이 엔드포인트의 스타일을 나타내는 플래그입니다. `true`: 경로 스타일 URL 엔드포인트입니다. 예시: `s3.amazonaws.com/<bucket>` `false`: 가상 호스트 스타일의 URL 엔드포인트입니다. 예시: `<bucket>.s3.amazonaws.com` S3호환 저장 버킷 URL 규칙을 검토 하려면 AWS S3 문서를 참조하세요.
s3BucketEndpoint	문자열	Ops Manager 이 S3 호환 저장 버킷에 액세스 데 사용하는URL 입니다.
S3 버킷 이름	문자열	S3호환 스토리지 oplog 저장소를 호스팅하는 S3호환 스토리지 버킷의 이름입니다.
s3RegionOverride	문자열	S3 호환 스토리지 버킷이 있는 리전입니다. 이 필드는 S3 호환 스토리지 저장소의 s3BucketEndpoint 가 리전 범위를 지원하지 않는 경우에만 적용됩니다. Ops Manager 이 S3호환 저장 oplog 저장 생성하거나 업데이트할 때 포함시킨 경우에만 이 필드 반환합니다.
sseEnabled	부울	이 S3 호환 저장 oplog 저장 서버 측 암호화 활성화하는지 여부를 나타내는 플래그입니다.
ssl	부울	Flag that indicates whether this S3-compatible storage oplog store only accepts connections encrypted using TLS.
uri	문자열	이 S3호환 저장 oplog 저장 의 메타데이터 데이터베이스 에 연결하는 연결 문자열입니다. 이 데이터베이스 S3 호환 저장 버킷에 블록의 위치를 저장합니다.
쓰기 고려	문자열	이 oplog 스토어에 사용되는 쓰기 고려입니다. Ops Manager는 다음 값 중 하나를 반환합니다. `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/oplog/s3Configs?pretty=true' \
6      --data '{
7        "assignmentEnabled": true,
8        "awsAccessKey": "access",
9        "awsSecretKey": "secret",
10        "encryptedCredentials": false,
11        "id": "{S3-OPLOG-CONFIG-ID}",
12        "labels": [
13          "l1",
14          "l2"
15        ],
16        "s3BucketEndpoint": "http://backup.example.com/oplog",
17        "s3BucketName": "oplog",
18        "uri": "mongodb://localhost:27017",
19        "ssl": true,
20        "writeConcern": "W2"
21      }'

응답 예시

응답 헤더

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   "awsAccessKey": "access",
4   "awsSecretKey": "secret",
5   "encryptedCredentials": false,
6   "id": "{S3-OPLOG-CONFIG-ID}",
7   "labels": [
8     "l1",
9     "l2"
10   ],
11   "links": [
12     {
13       "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs",
14       "rel": "self"
15     }
16   ],
17   "s3BucketEndpoint": "http://backup.example.com/oplog",
18   "s3BucketName": "oplog",
19   "uri": "mongodb://localhost:27017",
20   "ssl": true,
21   "writeConcern": "W2"
22 }

돌아가기

모두 가져오기

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/oplog/s3Configs?pretty=true' \
6	--data '{
7	"assignmentEnabled": true,
8	"awsAccessKey": "access",
9	"awsSecretKey": "secret",
10	"encryptedCredentials": false,
11	"id": "{S3-OPLOG-CONFIG-ID}",
12	"labels": [
13	"l1",
14	"l2"
15	],
16	"s3BucketEndpoint": "http://backup.example.com/oplog",
17	"s3BucketName": "oplog",
18	"uri": "mongodb://localhost:27017",
19	"ssl": true,
20	"writeConcern": "W2"
21	}'