1개의 S3 블록 저장소 구성 생성
하나의 새 s3 블록 저장소를 구성합니다.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
POST /snapshot/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 proxy 를 사용해야 하는지 여부를 나타내는 플래그입니다. 를 사용하도록 를 구성한 경우가 아니라면 이 값을 설정하다 MongoDB Ops Manager 필요가 HTTP proxy 없습니다. | |||||||||
암호화된 자격증명 | 부울 | 옵션 | 이 S3 호환 저장소 블록 저장소의 사용자 이름과 비밀번호가 credentialstool을 사용하여 암호화되었는지 여부를 나타내는 플래그입니다. | |||||||||
id | 문자열 | 필수 사항 | ||||||||||
labels | 문자열 배열 | 옵션 | MongoDB Ops Manager가 어떤 S3 블록 저장소 에 할당할 수 있는 백업 작업 을 관리하기 위한 태그 배열입니다. Setting these tags limits which backup jobs this S3-compatible storage blockstore can process. 생략하면 이 S3 호환 저장소 블록 저장소는 레이블을 사용하여 작업을 필터링하지 않는 프로젝트의 백업 작업만 처리할 수 있습니다. | |||||||||
부하 계수 | 숫자 | 옵션 | 이 스냅샷 저장소 가 다른 스냅샷 저장소와 비교하여 수행하는 백업 작업의 양을 나타내는 0이 아닌 양의 정수입니다. 이 옵션은 둘 이상의 스냅샷 저장소를 사용 중인 경우에만 필요합니다. Load Factor 에 학습 보려면 기존 블록 저장소 1개 편집을 참조하세요. | |||||||||
경로 스타일 액세스 활성화 | 부울 | 필수 사항 | 이 엔드포인트의 스타일을 나타내는 플래그입니다.
S 호환3저장소 버킷 URL 규칙을 검토하려면 Amazon Web Services S 설명서를3 참조하세요. | |||||||||
s3AuthMethod | 문자열 | 옵션 | s3BucketName 에 지정된 S3 호환 스토리지 버킷에 대한 액세스 권한을 부여하는 데 사용되는 메서드입니다. 이 옵션에 허용되는 값은
| |||||||||
s3BucketEndpoint | 문자열 | 필수 사항 | 이 S3 호환 스토리지 버킷에 액세스하는 데 사용되는 URL 입니다. | |||||||||
S3 버킷 이름 | 문자열 | 필수 사항 | S3 호환 스토리지 블록 저장소를 호스팅하는 S3 호환 스토리지 버킷의 이름입니다. | |||||||||
S3 최대 연결 | 숫자 | 필수 사항 | 이 S3 호환 저장소 블록 저장소에 대한 최대 연결 수를 나타내는 양의 정수입니다. | |||||||||
s3RegionOverride | 문자열 | 조건부 | S3 호환 스토리지 버킷이 있는 리전입니다. 이 필드는 S3 호환 스토리지 저장소의 s3BucketEndpoint 가 리전 범위를 지원하지 않는 경우에만 사용하세요. 이 필드를 Amazon Web Services S3 버킷과 함께 사용하지 마세요. | |||||||||
sseEnabled | 부울 | 필수 사항 | 이 S3호환 스토리지 블록 저장소가 서버 측 암호화를 활성화하는지 여부를 나타내는 플래그입니다. | |||||||||
ssl | 부울 | 옵션 | 이 S3 호환 저장소 블록 저장소가 TLS 를 사용하여 암호화된 연결만 허용하는지 여부를 나타내는 플래그입니다. | |||||||||
uri | 문자열 | 필수 사항 | 이 S3호환 스토리지 블록 저장소의 메타데이터 데이터베이스에 연결하는 연결 string 입니다. 이 데이터베이스는 Amazon Web Services S3호환 스토리지 버킷에 블록 위치를 저장합니다. | |||||||||
쓰기 고려 | 문자열 | 옵션 | 이 블록 저장소에 사용되는 쓰기 고려 (write concern)입니다. Ops Manager는 다음 값을 허용합니다.
MongoDB 의 쓰기 (write) 승인 수준에 학습 보려면 쓰기 고려를 참조하세요 . |
응답
이름 | 유형 | 설명 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
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 호환 저장소 블록 저장소의 사용자 이름과 비밀번호가 credentialstool을 사용하여 암호화되었는지 여부를 나타내는 플래그입니다. | |||||||||
id | 문자열 | 이 S3 호환 저장소 블록 저장소를 고유하게 식별하는 이름입니다. | |||||||||
labels | 문자열 배열 | MongoDB Ops Manager가 어떤 S3 블록 저장소 에 할당할 수 있는 백업 작업 을 관리하기 위한 태그 배열입니다. | |||||||||
링크 | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 | |||||||||
부하 계수 | integer | 이 스냅샷 저장소 가 다른 스냅샷 저장소와 비교하여 수행하는 백업 작업의 양을 나타내는 0이 아닌 양의 정수입니다. 이 옵션은 둘 이상의 스냅샷 저장소를 사용 중인 경우에만 필요합니다. Load Factor 에 학습 보려면 기존 블록 저장소 1개 편집을 참조하세요. | |||||||||
경로 스타일 액세스 활성화 | 부울 | 이 엔드포인트의 스타일을 나타내는 플래그입니다.
S 호환3저장소 버킷 URL 규칙을 검토하려면 Amazon Web Services S 설명서를3 참조하세요. | |||||||||
s3AuthMethod | 문자열 |
이 옵션에 허용되는 값은
| |||||||||
s3BucketEndpoint | 문자열 | Ops Manager가 이 S3 호환 스토리지 버킷에 액세스할 때 사용하는 URL 입니다. | |||||||||
S3 버킷 이름 | 문자열 | S3 호환 스토리지 블록 저장소를 호스팅하는 S3 호환 스토리지 버킷의 이름입니다. | |||||||||
S3 최대 연결 | integer | 이 S3 호환 저장소 블록 저장소에 대한 최대 연결 수를 나타내는 양의 정수입니다. | |||||||||
s3RegionOverride | 문자열 | ||||||||||
sseEnabled | 부울 | 이 S3호환 스토리지 블록 저장소가 서버 측 암호화를 활성화하는지 여부를 나타내는 플래그입니다. | |||||||||
ssl | 부울 | 이 S3 호환 저장소 블록 저장소가 TLS 를 사용하여 암호화된 연결만 허용하는지 여부를 나타내는 플래그입니다. | |||||||||
uri | 문자열 | 이 S3호환 스토리지 블록 저장소의 메타데이터 데이터베이스에 연결하는 연결 string 입니다. 이 데이터베이스는 Amazon Web Services S3호환 스토리지 버킷에 블록 위치를 저장합니다. | |||||||||
쓰기 고려 | 문자열 | 이 블록 저장소에 사용되는 쓰기 고려 (write concern)입니다. Ops Manager는 다음 값 중 하나를 반환합니다.
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://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true' \ 6 --data '{ 7 "id": "{S3-BLOCKSTORE-CONFIG-ID}", 8 "assignmentEnabled": true, 9 "pathStyleAccessEnabled": false, 10 "awsAccessKey": "<access>", 11 "awsSecretKey": "<secret>", 12 "acceptedTos": true, 13 "customCertificates" : [{ 14 "filename" : "CA.pem", 15 "certString" : "-----BEGIN CERTIFICATE-----\nMIIDljCCAn4CCQDJjCHAkAafFTANBgkqhkiG9w0BAQsFADCBjDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAk5ZMQwwCgYDVQQHDANOWUMxEDAOBgNVBAoMB01vbmdvREIx\nDDAKBgNVBAsMA1NXRTEZMBcGA1UEAwwQZXJpbm1jbnVsdHkudGVjaDEnMCUGCSqG\nSIb3DQEJARYYZXJpbi5tY251bHR5QG1vbmdvZGIuY29tMB4XDTIxMDYxMTE1MzY0\nMVoXDTIxMDcxMTE1MzY0MVowgYwxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOWTEM\nMAoGA1UEBwwDTllDMRAwDgYDVQQKDAdNb25nb0RCMQwwCgYDVQQLDANTV0UxGTAX\nBgNVBAMMEGVyaW5tY251bHR5LnRlY2gxJzAlBgkqhkiG9w0BCQEWGGVyaW4ubWNu\ndWx0eUBtb25nb2RiLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAOoAv1btxcEgDOdCgyz+/NtyFwa0h/3yGtj+WK7nMzcEntnxG5apHVRZ6eQ4ayZU\nhZNPbNWtcsbTEiRWyywMAd7/DbIa9GhsP1/P6Cv+TnO2krx8qVKQN93j8cme/b6g\n+yeEWMAM2rvfXq/fRTtJbH1Y6c4mYh4312mPrlEfgvAUQZh3DpJQNIVZ5MM2imp0\nfBgcggrNHUniLCT8ogUA4QII8CKIC4ONX4TNtXbsNtcCzKNqvOdcvWXLTYEJav34\nlaJs1YWJx2PSufgHo+JZUeANwwpztkYhr3nUGTD8fr7JF9CO7UlFBTFqs+PeaTJV\nEbnrF26NimsAmRgRPNLE170CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAe5hAkrhz\nClXg4HPq6U3ONEUVUqQ231gogeUIIQsfn4K89QIFnsm0DC1lE21qHNcD3iHECmDJ\n9R2tXdA0shbc+hM8OHbEW6U31dLrM369PUQmw0GOkFWlYHnX4ySt+zMAjlIrQe7C\nLErYSuLDpjuKvkdpvbcwgkarB9/FPCOhORpAZqduhwUOr28tZzT3/8L7w//+7Yhy\n5ihKgTcP/CmJ+MgLlZqBtQ7lkmKDWXIUlLSRDHEciVGSXgZBreUciNFeMHVvoluc\ndxdsxqMcXgyXwmv7Ck7tCjYRwzwlf3TrcKt8QFijWTbl1Z/3d0/zpjuvR21J0z/3\ns4tNMtQdG6/bHA==\n-----END CERTIFICATE-----" 16 }], 17 "encryptedCredentials": false, 18 "loadFactor": 1, 19 "s3AuthMethod": "KEYS", 20 "s3BucketEndpoint": "s3.amazonaws.com", 21 "s3BucketName": "bucketname", 22 "s3MaxConnections": 50, 23 "sseEnabled": true, 24 "uri": "mongodb://127.0.0.1:27017", 25 "ssl": false, 26 "writeConcern": "ACKNOWLEDGED" 27 }'
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://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true' \ 6 --data '{ 7 "id": "{S3-BLOCKSTORE-CONFIG-ID}", 8 "assignmentEnabled": true, 9 "pathStyleAccessEnabled": false, 10 "acceptedTos": true, 11 "encryptedCredentials": false, 12 "loadFactor": 1, 13 "s3AuthMethod": "IAM_ROLE", 14 "s3BucketEndpoint": "s3.amazonaws.com", 15 "s3BucketName": "bucketname", 16 "s3MaxConnections": 50, 17 "sseEnabled": true, 18 "uri": "mongodb://127.0.0.1:27017", 19 "ssl": false, 20 "writeConcern": "ACKNOWLEDGED" 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 "acceptedTos": true, 3 "assignmentEnabled": true, 4 "awsAccessKey": "<access>", 5 "awsSecretKey": "<secret>", 6 "customCertificates" : [{ 7 "filename" : "CA.pem", 8 "certString" : "-----BEGIN CERTIFICATE-----\nMIIDljCCAn4CCQDJjCHAkAafFTANBgkqhkiG9w0BAQsFADCBjDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAk5ZMQwwCgYDVQQHDANOWUMxEDAOBgNVBAoMB01vbmdvREIx\nDDAKBgNVBAsMA1NXRTEZMBcGA1UEAwwQZXJpbm1jbnVsdHkudGVjaDEnMCUGCSqG\nSIb3DQEJARYYZXJpbi5tY251bHR5QG1vbmdvZGIuY29tMB4XDTIxMDYxMTE1MzY0\nMVoXDTIxMDcxMTE1MzY0MVowgYwxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOWTEM\nMAoGA1UEBwwDTllDMRAwDgYDVQQKDAdNb25nb0RCMQwwCgYDVQQLDANTV0UxGTAX\nBgNVBAMMEGVyaW5tY251bHR5LnRlY2gxJzAlBgkqhkiG9w0BCQEWGGVyaW4ubWNu\ndWx0eUBtb25nb2RiLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAOoAv1btxcEgDOdCgyz+/NtyFwa0h/3yGtj+WK7nMzcEntnxG5apHVRZ6eQ4ayZU\nhZNPbNWtcsbTEiRWyywMAd7/DbIa9GhsP1/P6Cv+TnO2krx8qVKQN93j8cme/b6g\n+yeEWMAM2rvfXq/fRTtJbH1Y6c4mYh4312mPrlEfgvAUQZh3DpJQNIVZ5MM2imp0\nfBgcggrNHUniLCT8ogUA4QII8CKIC4ONX4TNtXbsNtcCzKNqvOdcvWXLTYEJav34\nlaJs1YWJx2PSufgHo+JZUeANwwpztkYhr3nUGTD8fr7JF9CO7UlFBTFqs+PeaTJV\nEbnrF26NimsAmRgRPNLE170CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAe5hAkrhz\nClXg4HPq6U3ONEUVUqQ231gogeUIIQsfn4K89QIFnsm0DC1lE21qHNcD3iHECmDJ\n9R2tXdA0shbc+hM8OHbEW6U31dLrM369PUQmw0GOkFWlYHnX4ySt+zMAjlIrQe7C\nLErYSuLDpjuKvkdpvbcwgkarB9/FPCOhORpAZqduhwUOr28tZzT3/8L7w//+7Yhy\n5ihKgTcP/CmJ+MgLlZqBtQ7lkmKDWXIUlLSRDHEciVGSXgZBreUciNFeMHVvoluc\ndxdsxqMcXgyXwmv7Ck7tCjYRwzwlf3TrcKt8QFijWTbl1Z/3d0/zpjuvR21J0z/3\ns4tNMtQdG6/bHA==\n-----END CERTIFICATE-----" 9 }], 10 "encryptedCredentials": false, 11 "id": "{S3-BLOCKSTORE-CONFIG-ID}", 12 "links": [ 13 { 14 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs", 15 "rel": "self" 16 } 17 ], 18 "loadFactor": 1, 19 "pathStyleAccessEnabled": false, 20 "s3AuthMethod": "KEYS", 21 "s3BucketEndpoint": "s3.amazonaws.com", 22 "s3BucketName": "bucketname", 23 "s3MaxConnections": 50, 24 "sseEnabled": true, 25 "ssl": false, 26 "uri": "mongodb://127.0.0.1:27017", 27 "writeConcern": "ACKNOWLEDGED" 28 }
1 { 2 "acceptedTos": true, 3 "assignmentEnabled": true, 4 "encryptedCredentials": false, 5 "id": "{S3-BLOCKSTORE-CONFIG-ID}", 6 "links": [ 7 { 8 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs", 9 "rel": "self" 10 } 11 ], 12 "loadFactor": 1, 13 "pathStyleAccessEnabled": false, 14 "s3AuthMethod": "IAM_ROLE", 15 "s3BucketEndpoint": "s3.amazonaws.com", 16 "s3BucketName": "bucketname", 17 "s3MaxConnections": 50, 18 "sseEnabled": true, 19 "ssl": false, 20 "uri": "mongodb://127.0.0.1:27017", 21 "writeConcern": "ACKNOWLEDGED" 22 }