하나의 새로운 S3호환 저장 블록 저장소 구성합니다. v 리소스2.0 객체 keyVault 추가합니다. S3호환 저장 블록 저장소 이 객체 사용하여 HashiCorp Vault에서AWS 자격 증명 읽습니다. 자세한 학습 은 스냅샷 저장소 자격 증명용 HashiCorp Vault를 참조하세요.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v2.0/admin/backup
Resource
POST /snapshot/s3Configs
요청 경로 매개변수
이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 |
|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다. |
|
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
요청 본문 매개변수
이름 | 유형 | 필요성 | 설명 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 호환 저장소 블록 저장소의 사용자 이름과 비밀번호가 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개 편집을 참조하세요. | |||||||||
objectLockEnabled | 부울 | 옵션 | S3 버킷의 객체가 삭제되지 않도록 객체 잠금 활성화할지 여부를 나타내는 플래그입니다. | |||||||||
경로 스타일 액세스 활성화 | 부울 | 필수 사항 | 이 엔드포인트의 스타일을 나타내는 플래그입니다.
S3호환 저장 버킷 URL 규칙을 검토 하려면 Amazon Web Services S3 설명서를참조하세요. | |||||||||
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) 승인 수준에 학습 보려면 쓰기 고려를 참조하세요 . |
참고
s3AuthMethod 이(가) KEYS인 경우 자격 증명 소스 keyVault 객체 중 하나만 제공하거나 awsAccessKey 및 awsSecretKey를 모두 제공합니다. s3AuthMethod 가 IAM_ROLE인 경우 keyVault 객체 제공하지 마세요. 이 경우 Ops Manager 오류를 반환하고 awsAccessKey 및 awsSecretKey 값을 무시합니다.
v2.0 리소스 다음과 같은 키 볼트 매개변수를 추가합니다.
이름 | 유형 | 필요성 | 설명 |
|---|---|---|---|
keyVault | 객체 | 조건부 | 이 S3호환 스냅샷 저장소 의 볼트 지원 자격 증명 소스입니다. |
keyVault.vaultId | 문자열 | 조건부 | 자격 증명 저장하는 키 볼트 구성의 고유 식별자입니다. 이 값은 키 볼트 구성의 |
keyVault.awsAccessKeyPath | 문자열 | 조건부 | 키 볼트에 있는 AWS 액세스 키의 경로( |
keyVault.awsSecretKeyPath | 문자열 | 조건부 | 키 볼트에 있는 AWS 비밀 키의 경로입니다. 와 동일한 |
응답
이름 | 유형 | 설명 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
acceptTos | 부울 | Ops Manager에서 S3 호환 스토리지를 사용하기 위한 텀에 동의했는지 여부를 나타내는 플래그입니다. S3 호환 스토리지 저장소를 생성하려면 이 값을 | |||||||||
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개 편집을 참조하세요. | |||||||||
objectLockEnabled | 부울 | S3 버킷의 객체가 삭제되지 않도록 객체 잠금 활성화할지 여부를 나타내는 플래그입니다. | |||||||||
경로 스타일 액세스 활성화 | 부울 | 이 엔드포인트의 스타일을 나타내는 플래그입니다.
S3호환 저장 버킷 URL 규칙을 검토 하려면 Amazon Web Services S3 설명서를참조하세요. | |||||||||
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) 승인 수준에 학습 보려면 쓰기 고려를 참조하세요 . |
v2.0 리소스 다음 키 볼트 필드 추가합니다.
이름 | 유형 | 설명 |
|---|---|---|
keyVault | 객체 | 이 S3호환 스냅샷 저장소 의 볼트 지원 자격 증명 소스입니다. Ops Manager 스냅샷 저장소 키 볼트에서 자격 증명 읽을 때만 이 객체 반환합니다. |
keyVault.vaultId | 문자열 | 자격 증명 저장하는 키 볼트 구성의 고유 식별자입니다. |
keyVault.awsAccessKeyPath | 문자열 | 키 볼트에 있는 AWS 액세스 키의 경로입니다. |
keyVault.awsSecretKeyPath | 문자열 | 키 볼트에 있는 AWS 비밀 키의 경로입니다. |
요청 예시
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST 'https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs?pretty=true' \ --data '{ "id": "{S3-BLOCKSTORE-CONFIG-ID}", "assignmentEnabled": true, "pathStyleAccessEnabled": false, "acceptedTos": true, "encryptedCredentials": false, "loadFactor": 1, "s3AuthMethod": "KEYS", "s3BucketEndpoint": "s3.amazonaws.com", "s3BucketName": "bucketname", "s3MaxConnections": 50, "sseEnabled": true, "uri": "mongodb://127.0.0.1:27017", "ssl": false, "writeConcern": "ACKNOWLEDGED", "keyVault": { "vaultId": "{KEY-VAULT-ID}", "awsAccessKeyPath": "path/to/awsAccessKey", "awsSecretKeyPath": "path/to/awsSecretKey" } }'
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST 'https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs?pretty=true' \ --data '{ "id": "{S3-BLOCKSTORE-CONFIG-ID}", "assignmentEnabled": true, "pathStyleAccessEnabled": false, "awsAccessKey": "<access>", "awsSecretKey": "<secret>", "acceptedTos": true, "encryptedCredentials": false, "loadFactor": 1, "s3AuthMethod": "KEYS", "s3BucketEndpoint": "s3.amazonaws.com", "s3BucketName": "bucketname", "s3MaxConnections": 50, "sseEnabled": true, "uri": "mongodb://127.0.0.1:27017", "ssl": false, "writeConcern": "ACKNOWLEDGED" }'
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST 'https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs?pretty=true' \ --data '{ "id": "{S3-BLOCKSTORE-CONFIG-ID}", "assignmentEnabled": true, "pathStyleAccessEnabled": false, "acceptedTos": true, "encryptedCredentials": false, "loadFactor": 1, "s3AuthMethod": "IAM_ROLE", "s3BucketEndpoint": "s3.amazonaws.com", "s3BucketName": "bucketname", "s3MaxConnections": 50, "sseEnabled": true, "uri": "mongodb://127.0.0.1:27017", "ssl": false, "writeConcern": "ACKNOWLEDGED" }'
응답 예시
응답 헤더
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}
응답 본문
{ "acceptedTos": true, "assignmentEnabled": true, "encryptedCredentials": false, "id": "{S3-BLOCKSTORE-CONFIG-ID}", "keyVault": { "vaultId": "{KEY-VAULT-ID}", "awsAccessKeyPath": "path/to/awsAccessKey", "awsSecretKeyPath": "path/to/awsSecretKey" }, "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs", "rel": "self" } ], "loadFactor": 1, "pathStyleAccessEnabled": false, "s3AuthMethod": "KEYS", "s3BucketEndpoint": "s3.amazonaws.com", "s3BucketName": "bucketname", "s3MaxConnections": 50, "sseEnabled": true, "ssl": false, "uri": "mongodb://127.0.0.1:27017", "writeConcern": "ACKNOWLEDGED" }