1개의 S3 Oplog 구성 생성
하나의 새3 oplog 저장소를 구성합니다.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
리소스
POST /oplog/s3Configs
요청 경로 매개변수
이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
요청 본문 매개변수
이름 | 유형 | 필요성 | 설명 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
acceptTos | 부울 | 필수 사항 | Ops Manager에서 S3호환 스토리지 호환 저장소를 사용하기 위한 텀에 동의했는지 여부를 나타내는 플래그입니다. S3-호환 스토리지 호환 저장소를 만들려면 이 값을 이 값을 | |||||||||
AssignmentEnabled | 부울 | 옵션 | 이 데이터 저장소에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그. | |||||||||
AWS 액세스 키 | 문자열 | 조건부 | s3BucketName 에 지정된 S3 호환 스토리지 버킷에 액세스할 수 있는 Amazon Web Services 액세스 키 ID입니다.
| |||||||||
AWS 비밀 키 | 문자열 | 조건부 |
| |||||||||
customCertificates | 배열 | 옵션 | 연결된 S3 호환 저장소 버킷에 적용되는 유효한 인증 기관 인증서 목록입니다. | |||||||||
customCertificates[n].filename | 문자열 | 옵션 | 인증 기관 PEM 파일을 식별하는 이름입니다. | |||||||||
customCertificates[n].certString | 문자열 | 옵션 | 인증 기관 체인을 구성하는 인증 기관 PEM 파일의 콘텐츠입니다. | |||||||||
disableProxyS3 | 부울 | 옵션 | S3 호환 스토리지에 연결할 때 HTTP 프록시 를 사용해야 하는지 여부를 나타내는 플래그입니다. HTTP proxy를 사용하도록 Ops Manager를 구성하지 않은 경우 이 값을 설정할 필요가 없습니다. | |||||||||
암호화된 자격증명 | 부울 | 옵션 | 이 S3호환 스토리지 oplog 저장소의 사용자 이름과 비밀번호가 credentialstool을 사용하여 암호화되었는지 여부를 나타내는 플래그입니다. | |||||||||
id | 문자열 | 필수 사항 | 이 S3호환 스토리지 oplog 저장소를 고유하게 식별하는 이름입니다. | |||||||||
labels | 문자열 배열 | 옵션 | Ops Manager가 S3 oplog가 저장하는 백업 작업에 할당할 수 있는 백업 작업 을 managed하기 위한 태그 배열입니다. 이러한 태그를 설정하면 이 S3호환 스토리지 oplog 저장소가 처리할 수 있는 백업 작업이 제한됩니다. 생략하면 이 S3호환 스토리지 oplog 저장소는 레이블을 사용하여 작업을 필터링하지 않는 프로젝트의 백업 작업만 처리할 수 있습니다. | |||||||||
경로 스타일 액세스 활성화 | 부울 | 필수 사항 | 이 엔드포인트의 스타일을 나타내는 플래그입니다.
S3호환 스토리지 버킷 URL 규칙을 검토하려면 AWS S3 설명서를 참조하세요. | |||||||||
s3AuthMethod | 문자열 | 옵션 | s3BucketName 에 지정된 S3 호환 스토리지 버킷에 대한 액세스 권한을 부여하는 데 사용되는 메서드입니다. Ops Manager는 다음 값을 허용합니다.
| |||||||||
s3BucketEndpoint | 문자열 | 필수 사항 | 이 AWS S3호환 스토리지 또는 S3호환 스토리지 호환 버킷에 액세스하는 데 사용되는 URL 입니다. | |||||||||
S3 버킷 이름 | 문자열 | 필수 사항 | S3호환 스토리지 oplog 저장소를 호스팅하는 S3호환 스토리지 버킷의 이름입니다. | |||||||||
S3 최대 연결 | 숫자 | 필수 사항 | 이 S3호환 스토리지 oplog 저장소에 대한 최대 연결 수를 나타내는 양의 정수입니다. | |||||||||
s3RegionOverride | 문자열 | 조건부 | S3 호환 스토리지 버킷이 있는 리전입니다. 이 필드는 S3-호환 스토리지 호환 저장소의 3BucketEndpoint 가 리전 범위 지정을 지원하지 않는 경우에만 사용합니다. 이 필드를 AWS S3호환 스토리지 버킷과 함께 사용하지 마세요. | |||||||||
sseEnabled | 부울 | 필수 사항 | 이 S3호환 스토리지 oplog 저장소 가 서버 측 암호화를 활성화하는지 여부를 나타내는 플래그입니다. | |||||||||
ssl | 부울 | 옵션 | 이 S3호환 스토리지 oplog 저장소가 TLS 를 사용하여 암호화된 연결만 허용하는지 여부를 나타내는 플래그입니다. | |||||||||
uri | 문자열 | 필수 사항 | 이 S3호환 스토리지 oplog 저장소의 메타데이터 데이터베이스에 연결하는 연결 문자열 입니다. 이 데이터베이스는 블록의 위치를 AWS S3호환 스토리지 버킷에 저장합니다. | |||||||||
쓰기 고려 | 문자열 | 옵션 | 이 oplog 스토어에 사용되는 쓰기 고려 (write concern)입니다. Ops Manager는 다음 값을 허용합니다.
팁다음도 참조하세요.MongoDB의 쓰기 승인 수준에 대해 자세히 알아보려면 쓰기고려를 참조하세요. |
응답
이름 | 유형 | 설명 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
acceptTos | 부울 | Ops Manager에서 S3호환 스토리지 호환 저장소를 사용하기 위한 텀에 동의했는지 여부를 나타내는 플래그입니다. S3-호환 스토리지 호환 저장소를 만들려면 이 값을 true 로 설정해야 합니다. | |||||||||
AssignmentEnabled | 부울 | 이 데이터 저장소에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그. | |||||||||
AWS 액세스 키 | 문자열 | s3BucketName 에 지정된 S3 호환 스토리지 버킷에 액세스할 수 있는 Amazon Web Services 액세스 키 ID입니다. | |||||||||
AWS 비밀 키 | 문자열 | s3BucketName 에 지정된 S3 호환 스토리지 버킷에 액세스할 수 있는 Amazon Web Services 비밀 액세스 키입니다. | |||||||||
customCertificates | 배열 | 연결된 S3 호환 저장소 버킷에 적용되는 유효한 인증 기관 인증서 목록입니다. | |||||||||
customCertificates[n].filename | 문자열 | 인증 기관 PEM 파일을 식별하는 이름입니다. | |||||||||
customCertificates[n].certString | 문자열 | 인증 기관 체인을 구성하는 인증 기관 PEM 파일의 콘텐츠입니다. | |||||||||
disableProxyS3 | 부울 | S3 호환 스토리지에 연결할 때 HTTP 프록시 를 사용해야 하는지 여부를 나타내는 플래그입니다. | |||||||||
암호화된 자격증명 | 부울 | 이 S3호환 스토리지 oplog 저장소의 사용자 이름과 비밀번호가 credentialstool을 사용하여 암호화되었는지 여부를 나타내는 플래그입니다. | |||||||||
id | 문자열 | 이 S3호환 스토리지 oplog 저장소를 고유하게 식별하는 이름입니다. | |||||||||
labels | 문자열 배열 | Ops Manager가 S3호환 스토리지 oplog가 저장할 수 있는 백업 작업 을 managed하기 위한 태그 배열입니다. | |||||||||
링크 | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 | |||||||||
경로 스타일 액세스 활성화 | 부울 | 이 엔드포인트의 스타일을 나타내는 플래그입니다.
S3호환 스토리지 버킷 URL 규칙을 검토하려면 AWS S3 설명서를 참조하세요. | |||||||||
s3BucketEndpoint | 문자열 | Ops Manager가 이 AWS S3호환 스토리지 또는 S3호환 스토리지 호환 버킷에 액세스하는 데 사용하는 URL 입니다. | |||||||||
S3 버킷 이름 | 문자열 | S3호환 스토리지 oplog 저장소를 호스팅하는 S3호환 스토리지 버킷의 이름입니다. | |||||||||
s3RegionOverride | 문자열 | ||||||||||
sseEnabled | 부울 | 이 S3호환 스토리지 oplog 저장소 가 서버 측 암호화를 활성화하는지 여부를 나타내는 플래그입니다. | |||||||||
ssl | 부울 | 이 S3호환 스토리지 oplog 저장소가 TLS 를 사용하여 암호화된 연결만 허용하는지 여부를 나타내는 플래그입니다. | |||||||||
uri | 문자열 | 이 S3호환 스토리지 oplog 저장소의 메타데이터 데이터베이스에 연결하는 연결 문자열 입니다. 이 데이터베이스는 블록의 위치를 AWS S3호환 스토리지 버킷에 저장합니다. | |||||||||
쓰기 고려 | 문자열 | 이 oplog 스토어에 사용되는 쓰기 고려 (write concern)입니다. Ops Manager는 다음 값 중 하나를 반환합니다.
팁다음도 참조하세요.MongoDB의 쓰기 승인 수준에 대해 자세히 알아보려면 쓰기고려를 참조하세요. |
요청 예시
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 }'
응답 예시
응답 헤더
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
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 }