1개의 S3 블록 저장소 구성 업데이트

s3 블록 저장소 한 개의 구성을 업데이트합니다.

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

Resource

PUT /snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}

요청 경로 매개변수

이름	유형	설명
S3-블록 저장소-CONFIG-ID	문자열	이 S3 블록 저장소 구성에 레이블을 지정하는 고유한 이름입니다.

요청 쿼리 매개변수

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

이름	유형	필요성	설명	기본값
pretty	부울	옵션	응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다.	`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 에 지정된 S 호환 저장 버킷에 액세스할 수 있는 Amazon Web Services 액세스 키 ID입니다.3 `"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 사용 여부를 나타냅니다. MongoDB Ops Manager가 HTTP proxy를 사용하도록 구성하지 않은 경우에도 S3호환 저장 블록 저장소를 생성하거나 업데이트하는 모든 요청에 이 필드를 포함해야 합니다.
암호화된 자격증명	부울	옵션	이 S3 호환 저장소 블록 저장소의 사용자 이름과 비밀번호가 credentialstool을 사용하여 암호화되었는지 여부를 나타내는 플래그입니다.
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 버킷의 객체가 삭제되지 않도록 객체 잠금 활성화할지 여부를 나타내는 플래그입니다.
objectRetentionDays	integer	옵션	MongoDB Ops Manager가 이 S3호환 저장 블록 저장소의 객체를 객체 잠금으로 보호하는 일수입니다. 이 값을 S3호환 저장 버킷에 구성된 기본값 보존 기간과 일치하도록 설정합니다. `assignmentEnabled`을(를) `true`(으)로 설정하여 저장을 저장하면 MongoDB Ops Manager는 임시 테스트 객체를 사용하여 버킷의 객체 잠금 동작을 확인합니다. 그러나 MongoDB Ops Manager는 버킷의 객체 잠금 구성을 읽지 않으므로 이 값과 버킷의 보존 설정 간의 불일치를 감지할 수 없습니다.
objectRetentionMode	문자열	옵션	MongoDB Ops Manager가 이 S3호환 저장 블록 저장소의 객체에 적용하는 객체 잠금 (Object Lock) 보존 모드입니다. S3호환 저장 버킷에 구성된 보존 모드와 일치하도록 이 값을 설정합니다. `assignmentEnabled`을(를) `true`(으)로 설정하여 저장을 저장하면 MongoDB Ops Manager는 임시 테스트 객체를 사용하여 버킷의 객체 잠금 동작을 확인합니다. 그러나 MongoDB Ops Manager는 버킷의 객체 잠금 구성을 읽지 않으므로 이 값과 버킷의 보존 설정 간의 불일치를 감지할 수 없습니다. MongoDB Ops Manager는 이 옵션에 대해 다음 값을 허용합니다. `GOVERNANCE` `COMPLIANCE`
OIDC	객체	옵션	선택 사항. 이 저장의 OIDC 인증 설정. `oidc` 객체는 다음 필드를 허용합니다. `enabled`: 불리언. 이 저장의 OIDC 인증을 지원합니다. `method`: string. `callback`, `azure`, `gcp` 또는 `k8s` 중 하나. `tokenUri`: string. 자격 증명 공급자 토큰 엔드포인트. `method`이 `callback`인 경우 필수입니다. `clientId`: string. 자격 증명 공급자에 등록된 클라이언트 ID. `method`이 `callback`이면 필수이고, `method`이 `azure`이면 선택 사항입니다. `clientSecret`: string. 자격 증명 공급자에 등록된 클라이언트 시크릿. `method`이 `callback`인 경우 필수입니다. 기존 저장소를 편집하고 이 필드를 생략하거나 이전 `GET` 요청에서 반환된 수정된 값을 제출하면 MongoDB Ops Manager가 기존 시크릿을 유지합니다. `scope`: string. 자격 증명 공급자에서 요청된 OAuth2 스코프. `method`이 `callback`인 경우에만 사용됩니다. `tokenResource`: string. 워크로드 인증 토큰의 대상 또는 리소스 식별자입니다. `method`이 `azure` 또는 `gcp`인 경우 필수입니다. 이 값은 대상 MongoDB 배포서버의 `oidcIdentityProviders` 설정에서 이 자격 증명 공급자에 구성된 `audience`에 해당해야 합니다. `callback`, `azure`, `gcp` 및 `k8s` 메서드에 모든 동일한 필드가 필요하지는 않습니다. `azure`, `gcp` 및 `k8s` 메서드에는 `clientSecret`가 필요하지 않습니다. `oidc.enabled`이 `true`인 경우, 저장소의 `uri` 필드에만 호스팅과 연결 옵션을 제공합니다. MongoDB Ops Manager는 URI에 포함된 사용자 이름 또는 비밀번호를 무시합니다. 저장소를 OIDC에서 다른 인증 메커니즘으로 전환하려면 `oidc` 객체를 생략하는 대신 요청에서 `oidc: {enabled: false}`을(를) 제출합니다. 이 저장을 업데이트하고 요청에서 `oidc` 객체를 생략하면 MongoDB Ops Manager가 기존 OIDC 구성을 제거합니다. 기존 구성을 유지하려면 모든 업데이트 요청에 현재 `oidc` 객체를 포함하세요. `clientSecret` 이 유일한 예외입니다. `oidc` 객체에서 `clientSecret`을 생략하거나 이전 `GET` 요청에서 반환된 수정된 값을 제출하면 MongoDB Ops Manager가 기존 시크릿을 유지합니다. 시크릿을 변경하려면 새 평문 값을 제출하세요.
경로 스타일 액세스 활성화	부울	필수 사항	이 엔드포인트의 스타일을 나타내는 플래그입니다. `true`: 경로 스타일 URL 엔드포인트. 예시: `s3.amazonaws.com/<bucket>`. `false`: 가상 호스트 스타일 URL 엔드포인트. 예시: `<bucket>.s3.amazonaws.com`. S3호환 저장 버킷 URL 규칙을 검토 하려면 AWS S3 문서를 참조하세요.
s3AuthMethod	문자열	옵션	s3BucketName 에 지정된 S3 호환 스토리지 버킷에 대한 액세스 권한을 부여하는 데 사용되는 메서드입니다. Ops Manager는 다음 값을 허용합니다. `KEYS` 또는 없음: MongoDB Ops Manager는 awsAccessKey와 awsSecretKey를 사용하여 s3BucketName에 지정된 S3호환 저장 버킷에 대한 액세스를 승인합니다. `IAM_ROLE`: Ops Manager uses an AWS IAM role to authorize access to S3-compatible storage bucket specified in s3BucketName. awsAccessKey and awsSecretKey fields are ignored. To learn more, see the AWS documentation
s3BucketEndpoint	문자열	필수 사항	URL 이 이 S3호환 저장 버킷에 액세스하는 데 사용되는 입니다.
S3 버킷 이름	문자열	필수 사항	S3 호환 스토리지 블록 저장소를 호스팅하는 S3 호환 스토리지 버킷의 이름입니다.
S3 최대 연결	숫자	필수 사항	이 S3 호환 저장소 블록 저장소에 대한 최대 연결 수를 나타내는 양의 정수입니다.
s3RegionOverride	문자열	조건부	S3 호환 스토리지 버킷이 있는 리전입니다. 이 필드는 S3-호환 저장 호환 저장소의 3BucketEndpoint 가 리전 범위 지정을 지원하지 않는 경우에만 사용합니다. 이 필드를 AWS S3 버킷에는 사용하지 마십시오.
sseEnabled	부울	필수 사항	이 S3호환 저장 블록 저장소 서버 측 암호화활성화하는지 여부를 나타내는 플래그입니다.
uri	문자열	필수 사항	이 S3 호환 스토리지 블록 저장소에 액세스할 수 있는 `<hostname:port>` 형식의 쉼표로 구분된 호스트 목록입니다.
ssl	부울	옵션	이 S3호환 저장 블록 저장소가 TLS 를 사용하여 암호화된 연결만 허용하는지 여부를 나타내는 플래그입니다.
쓰기 고려	문자열	옵션	이 블록 저장소에 사용되는 쓰기 고려 (write concern)입니다. Ops Manager는 다음 값을 허용합니다. `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` MongoDB 의 쓰기 (write) 승인 수준에 학습 보려면 쓰기 고려를 참조하세요 .

응답

이름	유형	설명
acceptTos	부울	MongoDB Ops Manager에서 S3호환 저장을 사용하기 위한 서비스 약관에 동의했는지 여부를 나타내는 플래그입니다. S3호환 저장 스토어를 만들려면 이것을 `true`로 설정해야 합니다.
AssignmentEnabled	부울	이 데이터 저장소에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그.
AWS 액세스 키	문자열	s3BucketName 에 지정된 S 호환 저장 버킷에 액세스할 수 있는 Amazon Web Services 액세스 키 ID입니다.3
AWS 비밀 키	문자열	AWS 비밀 액세스 키입니다. s3BucketName에 지정된 S3호환 저장 버킷에 액세스할 수 있습니다.
customCertificates	배열	연결된 S3 호환 저장소 버킷에 적용되는 유효한 인증 기관 인증서 목록입니다.
customCertificates[n].filename	문자열	인증 기관 PEM 파일을 식별하는 이름입니다.
customCertificates[n].certString	문자열	인증 기관 체인을 구성하는 인증 기관 PEM 파일의 콘텐츠입니다.
disableProxyS3	부울	S3호환 저장소에 연결할 때 HTTP proxy를 사용해야 하는지 여부를 나타내는 플래그입니다.
암호화된 자격증명	부울	이 S3 호환 저장소 블록 저장소의 사용자 이름과 비밀번호가 credentialstool을 사용하여 암호화되었는지 여부를 나타내는 플래그입니다.
id	문자열	이 S3 호환 저장소 블록 저장소를 고유하게 식별하는 이름입니다.
labels	문자열 배열	MongoDB Ops Manager가 어떤 S3 블록 저장소 에 할당할 수 있는 백업 작업 을 관리하기 위한 태그 배열입니다.
링크	객체 배열	하위 리소스 또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에 설명되어 있습니다.
부하 계수	integer	이 스냅샷 저장소 가 다른 스냅샷 저장소와 비교하여 수행하는 백업 작업의 양을 나타내는 0이 아닌 양의 정수입니다. 이 옵션은 둘 이상의 스냅샷 저장소를 사용 중인 경우에만 필요합니다. Load Factor 에 학습 보려면 기존 블록 저장소 1개 편집을 참조하세요.
objectLockEnabled	부울	S3 버킷의 객체가 삭제되지 않도록 객체 잠금 활성화할지 여부를 나타내는 플래그입니다.
objectLockEnabledAt	timestamp	이 S3호환 저장 블록 저장소에 대해 객체 잠금이 활성화된 날짜와 시간입니다. MongoDB Ops Manager는 `GET` 요청에 대한 응답으로만 이 필드를 반환합니다.
objectRetentionDays	integer	MongoDB Ops Manager가 객체 잠금을 사용하여 이 S3호환 저장 블록 저장소의 객체를 보호하는 일수입니다.
objectRetentionMode	문자열	Ops Manager가 이 S3호환 블록 저장소의 객체에 적용하는 객체 잠금 (Object Lock) 보존 모드입니다. Ops Manager는 다음 값 중 하나를 반환합니다. `GOVERNANCE` `COMPLIANCE`
OIDC	객체	이 저장의 OIDC 인증 설정. `oidc` 객체에는 다음 필드가 포함되어 있습니다. `enabled`: 불리언. 이 저장에 대해 OIDC 인증이 활성화되어 있는지 여부를 표시합니다. `method`: string. `callback`, `azure`, `gcp` 또는 `k8s` 중 하나. `tokenUri`: string. 자격 증명 공급자 토큰 엔드포인트. `method`이 `callback`인 경우에만 표시됩니다. `clientId`: string. 자격 증명 공급자에 등록된 클라이언트 ID. `clientSecret`: string. MongoDB Ops Manager는 응답에서 이 값을 수정하며 원본 클라이언트 시크릿을 반환하지 않습니다. `scope`: string. 자격 증명 공급자에서 요청된 OAuth2 스코프. `method`가 `callback`일 때만 표시됩니다. `tokenResource`: string. 워크로드 인덴티티 토큰의 대상 또는 리소스 식별자입니다. `method`이 `azure` 또는 `gcp`인 경우에만 제시됩니다.
경로 스타일 액세스 활성화	부울	이 엔드포인트의 스타일을 나타내는 플래그입니다. `true`: 경로 스타일 URL 엔드포인트. 예시: `s3.amazonaws.com/<bucket>` `false`: 가상 호스트 스타일 URL 엔드포인트. 예시: `<bucket>.s3.amazonaws.com` S3호환 저장 버킷 URL 규칙을 검토 하려면 AWS S3 문서를 참조하세요.
s3AuthMethod	문자열	`s3BucketName` 에 지정된 S3 호환 스토리지 버킷에 대한 액세스 권한을 부여하는 데 사용되는 메서드입니다. 이 옵션에 허용되는 값은 `KEYS`, `IAM_ROLE` 입니다. `KEYS` 또는 None: MongoDB Ops Manager는 `awsAccessKey` 및 `awsSecretKey`를 사용하여 `s3BucketName`에 지정된 S3호환 저장 버킷에 대한 액세스 권한을 부여합니다. `IAM_ROLE`: Ops Manager uses an AWS IAM role to authorize access to S3-compatible storage bucket specified in `s3BucketName`. `awsAccessKey` and `awsSecretKey` fields are ignored. To learn more, see the AWS documentation
s3BucketEndpoint	문자열	MongoDB Ops Manager가 이 S3호환 저장 버킷에 액세스할 때 사용하는 URL 입니다.
S3 버킷 이름	문자열	S3 호환 스토리지 블록 저장소를 호스팅하는 S3 호환 스토리지 버킷의 이름입니다.
S3 최대 연결	integer	이 S3 호환 저장소 블록 저장소에 대한 최대 연결 수를 나타내는 양의 정수입니다.
s3RegionOverride	문자열	S3 호환 스토리지 버킷이 있는 리전입니다. 이 필드는 S3 호환 스토리지 저장소의 s3BucketEndpoint 가 리전 범위를 지원하지 않는 경우에만 적용됩니다. Ops Manager는 이 S3 호환 스토리지 블록 저장소를 생성 하거나 업데이트 할 때 포함한 경우에만 이 필드를 반환합니다.
sseEnabled	부울	이 S3호환 저장 블록 저장소 서버 측 암호화활성화하는지 여부를 나타내는 플래그입니다.
ssl	부울	이 S3호환 저장 블록 저장소가 TLS 를 사용하여 암호화된 연결만 허용하는지 여부를 나타내는 플래그입니다.
uri	문자열	이 S3호환 저장 블록 저장소의 메타데이터 데이터베이스에 연결하는 연결 문자열 입니다. 이 데이터베이스는 Amazon Web Services S3호환 저장 버킷에 블록의 위치를 저장합니다.
쓰기 고려	문자열	이 블록 저장소에 사용되는 쓰기 고려 (write concern)입니다. Ops Manager는 다음 값 중 하나를 반환합니다. `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` MongoDB 의 쓰기 (write) 승인 수준에 학습 보려면 쓰기 고려를 참조하세요 .

요청 예시

1curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \2     --header 'Accept: application/json' \3     --header 'Content-Type: application/json' \4     --include \5     --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \6     --data '{7       "assignmentEnabled": true,8       "awsAccessKey": "<access>",9       "awsSecretKey": "<secret>",10       "encryptedCredentials": false,11       "labels": [12         "l1",13         "l2"14       ],15       "loadFactor": 50,16       "pathStyleAccessEnabled": false,17       "s3BucketEndpoint": "http://example.com/backupbucket",18       "s3BucketName": "bucketname",19       "uri": "mongodb://localhost:27017",20       "ssl": true,21       "writeConcern": "W2"22     }'

1curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \2     --header 'Accept: application/json' \3     --header 'Content-Type: application/json' \4     --include \5     --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \6     --data '{7       "assignmentEnabled": true,8       "encryptedCredentials": false,9       "labels": [10         "l1",11         "l2"12       ],13       "loadFactor": 50,14       "pathStyleAccessEnabled": false,15       "s3AuthMethod": "IAM_ROLE",16       "s3BucketEndpoint": "http://example.com/backupbucket",17       "s3BucketName": "bucketname",18       "uri": "mongodb://localhost:27017",19       "ssl": true,20       "writeConcern": "W2"21     }'

응답 예시

응답 헤더

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive

HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

응답 본문

1{2  "acceptedTos": true,3  "assignmentEnabled": true,4  "awsAccessKey": "<access>",5  "awsSecretKey": "<secret>",6  "encryptedCredentials": false,7  "id": "{S3-BLOCKSTORE-CONFIG-ID}",8  "labels": [9    "l1",10    "l2"11  ],12  "links": [13    {14      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",15      "rel": "self"16    }17  ],18  "loadFactor": 50,19  "pathStyleAccessEnabled": false,20  "s3AuthMethod": "KEYS",21  "s3BucketEndpoint": "http://example.com/backupbucket",22  "s3BucketName": "bucketname",23  "s3MaxConnections": 50,24  "sseEnabled": true,25  "ssl": false,26  "uri": "mongodb://127.0.0.1:27017",27  "writeConcern": "W2"28}

1{2  "acceptedTos": true,3  "assignmentEnabled": true,4  "encryptedCredentials": false,5  "id": "{S3-BLOCKSTORE-CONFIG-ID}",6  "labels": [7    "l1",8    "l2"9  ],10  "links": [11    {12      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",13      "rel": "self"14    }15  ],16  "loadFactor": 50,17  "pathStyleAccessEnabled": false,18  "s3AuthMethod": "IAM_ROLE",19  "s3BucketEndpoint": "http://example.com/backupbucket",20  "s3BucketName": "bucketname",21  "s3MaxConnections": 50,22  "sseEnabled": true,23  "ssl": false,24  "uri": "mongodb://127.0.0.1:27017",25  "writeConcern": "W2"26}

돌아가기

만들기

삭제