참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
중요
이 엔드포인트는 FCV 4.0 이하 실행 MongoDB 데이터베이스의 백업과 함께 작동합니다. FCV 4.2 이상을 실행 MongoDB 데이터베이스의 백업은 배포서버의 암호화 설정을 사용합니다.
다음 엔드포인트와 함께 PUT HTTP 메서드를 사용하여 KMIP 마스터 키를 순환합니다. 각 샤드에 대해 PUT 요청을 하나씩 실행하고 config 서버 복제본 세트에 대해 또 다른 PUT 요청을 실행합니다.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PUT /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/encryptionKey
요청 매개변수
요청 경로 매개변수
이름 | 유형 | 필요성 | 설명 |
|---|---|---|---|
| 문자열 | 필수 사항 | 암호화 키가 속한 프로젝트의 고유 식별자입니다. |
| 문자열 | 필수 사항 | 암호화 키가 속한 cluster의 고유 식별자입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식이어야 하는지 여부를 나타내는 플래그입니다. |
| ||||||
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
이름 | 유형 | 설명 |
|---|---|---|
| 문자열 | 암호화 키가 속한 프로젝트의 고유 식별자입니다. |
| 문자열 | 암호화 키가 속한 cluster의 고유 식별자입니다. |
| 문자열 | KMIP 마스터 키의 고유 식별자입니다. 이 키는 암호화된 백업을 위해 헤드 데이터베이스를 암호화하고 복원합니다. FCV FCV 4.2 이상의 백업 암호화에 대한 자세한 내용은 암호화된 백업 스냅샷을 참조하세요. |
요청 예시
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request PUT "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/encryptionKey"
응답 예시
응답 헤더
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
201 Created 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}
응답 본문
이 엔드포인트는 빈 JSON 객체를 반환합니다.