하나의 키 보관의 구성을 조회합니다.
필수 역할
다음과 같은 할당된 역할을 사용하여 이 엔드포인트를 성공적으로 호출할 수 있습니다.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin
Resource
GET /keyVault/{KEY-VAULT-ID}
요청 경로 매개변수
이름 | 유형 | 설명 |
|---|---|---|
KEY-VAULT-ID | 문자열 | 조회할 키 볼트 구성의 고유 식별자입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
이름 | 유형 | 설명 |
|---|---|---|
id | 문자열 | MongoDB Ops Manager가 이 키 보관소 구성에 대해 생성하는 고유 식별자입니다. 이 키 보관소를 사용하도록 S3호환 저장 스냅샷 저장소를 구성할 때 이 값을 |
friendlyName | 문자열 | 이 키 보관 구성을 식별하는 인간 가독형 레이블입니다. |
유형 | 문자열 | 키 보고소 제공자 유형. MongoDB Ops Manager는 HashiCorp Vault를 나타내는 |
URL | 문자열 | MongoDB Ops Manager가 연결하는 HashiCorp Vault 서버의 주소입니다. |
인증 | 객체 | MongoDB Ops Manager가 HashiCorp Vault에 연결하는 데 사용되는 인증 세부 정보 |
auth.mechanism | 문자열 | MongoDB Ops Manager HashiCorp Vault 연결하는 데 사용하는 인증 방법입니다. MongoDB Ops Manager는 다음 값 중 하나를 반환합니다.
|
auth.secret | 문자열 | MongoDB Ops Manager가 HashiCorp Vault에 인증하는 데 사용하는 자격 증명입니다. MongoDB Ops Manager는 이 값을 유휴 시 암호화하고 저장된 값 대신 |
auth.jwtClaims | 객체 | Ops Manager 가 HashiCorp Vault에서 JWT 로그인을 요청할 때 보내는 클레임입니다. Ops Manager |
customCertificates | 배열 | Ops Manager HashiCorp Vault 서버 에 연결할 때 TLS 확인에 사용하는 사용자 지정 인증 기관 인증서 목록입니다. |
customCertificates[n].filename | 문자열 | 인증 기관 PEM 파일을 식별하는 이름입니다. |
customCertificates[n].certString | 문자열 | 인증 기관 PEM 파일 의 내용입니다. Ops Manager 저장된 값 대신 |
링크 | 객체 배열 | 하위 리소스 또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
요청 예시
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault/{KEY-VAULT-ID}?pretty=true'
응답 예시
응답 헤더
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}
응답 본문
{ "id": "{KEY-VAULT-ID}", "friendlyName": "myVault", "type": "HASHI_CORP", "url": "https://localhost:8200/", "auth": { "mechanism": "TOKEN", "secret": "[REDACTED]" }, "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault/{KEY-VAULT-ID}", "rel": "self" } ] }