KMIP マスターキー ID の取得

項目一覧

Resource

Request Parameters
リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。

注意

グループとプロジェクトは同義語です。あなたの {PROJECT-ID}はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。このページでは、説明を参照するときに、より一般的な用語のグループを使用します。エンドポイントはドキュメントに記載されているままです。

重要

このエンドポイントは、FCV 4.0またはそれ以前のバージョンを実行している MongoDB データベースのバックアップで動作します。 FCV 4.2以降を実行している MongoDB データベースのバックアップは、配置の暗号化設定を使用します。

現在の KMIP マスター GETキーの ID を取得するには、同じエンドポイントで HTTP メソッドを使用します。

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

Resource

GET /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/encryptionKey

Request Parameters

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

名前	タイプ	必要性	説明
`{GROUP-ID}`	string	必須	暗号化のキーが属するプロジェクトの一意の識別子。
`{CLUSTER-ID}`	string	必須	暗号化のキーが属するクラスターのユニーク識別子。

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

次のクエリパラメータは任意です。

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
状態	HTTPレスポンスコード
envelope	期待される応答本体

false

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

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

応答

名前	タイプ	説明
`groupId`	string	暗号化のキーが属するプロジェクトの一意の識別子。
`clusterId`	string	暗号化のキーが属するクラスターのユニーク識別子。
`encryptionKeyUUID`	string	KMIPマスターキーの一意の識別子です。このキーは、暗号化されたバックアップのヘッドデータベースを暗号化し、復元します。 FCV `4.2` 以降では、ヘッドデータベースの代わりにバックアップカーソルを使用します。詳細については、「バックアップデーモンサービス」を参照してください。 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"

応答例

応答ヘッダー

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}

レスポンス本体

{
  "clusterId" : "{CLUSTER-ID}",
  "groupId" : "{PROJECT-ID}",
  "encryptionKeyUUID": "1234-3456-4567-abcd-def0"
}

戻る

バックアップ暗号化キー

KMIP マスターキー ID のローテーション

注意

重要