/ /

/ /

すべてのKey Vault構成を取得する

すべてのキーボルトの構成を取得します。

必須のロール

割り当てられた次のいずれかのロールを使用して、このエンドポイントを正常に呼び出すことができます。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin

Resource

GET /keyVault

リクエストパスパラメーター

このエンドポイントは、HTTP リクエストパスパラメーターを使用しません。

リクエストクエリパラメータ

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print形式にするかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで`envelope : true`を設定します。結果のリストを返すエンドポイントの場合、 `content`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	`false`

リクエストボディパラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答ドキュメント

レスポンスJSONドキュメントには、result オブジェクトの配列、link オブジェクトの配列、および取得されたresult オブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	配列には、`results` 埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。URL間の関係は、Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

各結果は 1 つのキーボールト構成です。

名前	タイプ	説明
id	string	MongoDB Ops Manager がこのキーヴォールト構成に対して生成する一意の識別子。このキーヴォールトを使用するように S3 互換ストレージ読み取りを構成する場合は、この値を `vaultId` として使用します。
friendlyName	string	このキーボールト構成を識別する、人間が判読できるラベル。
タイプ	string	キーボルトプロバイダータイプ。MongoDB Ops Manager は `HASHI_CORP` を返します。これは HashiCorp Vault を表します。
URL	string	MongoDB Ops Manager が接続する HashiCorp Vault サーバーのアドレス。
認証	オブジェクト	MongoDB Ops Manager が HashiCorp Vault に接続するために使用する認証詳細。
auth.mechanism	string	MongoDB Ops Manager が HashiCorp Vault に接続するために使用する認証方法。MongoDB Ops Manager は、次のいずれかの値を返します。 `TOKEN` `JWT`
auth.secret	string	MongoDB Ops Manager が HashiCorp Vault への認証に使用する認証情報。MongoDB Ops Manager はこの値を保存時に暗号化し、保存された値の代わりに `[REDACTED]` を返します。
auth.jwtClaims	オブジェクト	MongoDB Ops Manager が HashiCorp Vault に JSON web token ログインをリクエストするときに送信するクレーム。MongoDB Ops Manager は、`auth.mechanism` が `JWT` の場合にのみこのオブジェクトを返します。
customCertificates	配列	MongoDB Ops Manager が HashiCorp Vault サーバーに接続する際に TLS 検証に使用するカスタム認証局証明書の一覧。
customCertificates[n].filename	string	認証局PEMファイルを識別する名前。
customCertificates[n].certString	string	証明機関PEMファイルの内容。MongoDB Ops Manager は保存された値の代わりに`[REDACTED]`を返します。
Links	オブジェクト配列	サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての `links` 配列には、`self` と呼ばれるリンクが少なくとも 1 つ含まれています。URLの関係は、Web リンク仕様で説明されています。

リクエストの例

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で取得

作成

すべてのKey Vault構成を取得する

必須のロール

Resource

リクエスト パス パラメーター

リクエスト クエリ パラメータ

リクエスト ボディ パラメータ

応答

応答ドキュメント

results embeddedDocument

リクエストの例

応答例

応答ヘッダー

レスポンス本体

リクエストパスパラメーター

リクエストクエリパラメータ

リクエストボディパラメータ

`results` embeddedDocument