/ /

/ /

모든 키 보안 구성 가져오기

모든 Key Vault의 구성을 검색합니다.

필수 역할

다음과 같은 할당된 역할을 사용하여 이 엔드포인트를 성공적으로 호출할 수 있습니다.

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

Resource

GET /keyVault

요청 경로 매개변수

이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.

요청 쿼리 매개변수

이름	유형	필요성	설명	기본값
pageNum	숫자	옵션	결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.	`1`
itemsPerPage	숫자	옵션	페이지당 반환할 항목 수. 최대 500개까지 가능합니다.	`100`
pretty	부울	옵션	응답 본문이 예쁜 인쇄 형식이어야 하는지 여부를 나타내는 플래그입니다.	`false`
envelope	부울	옵션	응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 `envelope : true` 을(를) 설정합니다. 결과 목록을 반환하는 엔드포인트의 경우 `content` 객체는 엔벨로프입니다. Ops Manager가 응답 본문에 `status` 필드를 추가합니다.	`false`

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답

응답 문서

응답 JSON 문서에는 result 객체 배열, link 객체 배열 및 조회된 result 객체의 총 개수가 포함되어 있습니다.

이름	유형	설명
`results`	배열	배열에는 내장된 `results` 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체 포함됩니다.
`links`	배열	배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
`totalCount`	숫자	결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다.

`results` embeddedDocument

각 결과 는 하나의 키 보안 자결세 구성입니다.

이름	유형	설명
id	문자열	MongoDB Ops Manager가 이 키 보관소 구성에 대해 생성하는 고유 식별자입니다. 이 키 보관소를 사용하도록 S3호환 저장 스냅샷 저장소를 구성할 때 이 값을 `vaultId` 으로 사용합니다.
friendlyName	문자열	이 키 보관 구성을 식별하는 인간 가독형 레이블입니다.
유형	문자열	키 보고소 제공자 유형. MongoDB Ops Manager는 HashiCorp Vault를 나타내는 `HASHI_CORP`을 반환합니다.
URL	문자열	MongoDB Ops Manager가 연결하는 HashiCorp Vault 서버의 주소입니다.
인증	객체	MongoDB Ops Manager가 HashiCorp Vault에 연결하는 데 사용되는 인증 세부 정보
auth.mechanism	문자열	MongoDB Ops Manager HashiCorp Vault 연결하는 데 사용하는 인증 방법입니다. MongoDB Ops Manager는 다음 값 중 하나를 반환합니다. `TOKEN` `JWT`
auth.secret	문자열	MongoDB Ops Manager가 HashiCorp Vault에 인증하는 데 사용하는 자격 증명입니다. MongoDB Ops Manager는 이 값을 유휴 시 암호화하고 저장된 값 대신 `[REDACTED]` 을 반환합니다.
auth.jwtClaims	객체	HashiCorp Vault에 JSON web token 로그인을 요청할 때 MongoDB Ops Manager가 보내는 주장입니다. MongoDB Ops Manager는 `auth.mechanism` 가 `JWT`일 경우에만 이 객체를 반환합니다.
customCertificates	배열	MongoDB Ops Manager가 HashiCorp Vault 서버에 연결할 때 TLS 확인에 사용하는 사용자 지정 인증서 목록.
customCertificates[n].filename	문자열	인증 기관 PEM 파일을 식별하는 이름입니다.
customCertificates[n].certString	문자열	인증 기관 PEM 파일의 내용입니다. MongoDB Ops Manager는 저장된 값 대신 `[REDACTED]` 를 반환합니다.
링크	객체 배열	하위 리소스 또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에 설명되어 있습니다.

요청 예시

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault?pretty=true'

응답 예시

응답 헤더

HTTP/1.1 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

HTTP/1.1 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}

응답 본문

{
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault?pretty=true&pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "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"
        }
      ]
    }
  ],
  "totalCount": 1
}

돌아가기

ID 로 가져오기

만들기

모든 키 보안 구성 가져오기

필수 역할

Resource

요청 경로 매개변수

요청 쿼리 매개변수

요청 본문 매개변수

응답

응답 문서

results embeddedDocument

요청 예시

응답 예시

응답 헤더

응답 본문

`results` embeddedDocument