注意
グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
重要
MongoDBデータベースのバックアップでは、配置の暗号化設定が使用されます。
現在の KMIP マスター GETキーの ID を取得するには、同じエンドポイントで HTTP メソッドを使用します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/encryptionKeyRequest Parameters
リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
| string | 必須 | 暗号化のキーが属するプロジェクトの一意の識別子。 |
| string | 必須 | 暗号化のキーが属するクラスターのユニーク識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
| string | 暗号化のキーが属するプロジェクトの一意の識別子。 |
| string | 暗号化のキーが属するクラスターのユニーク識別子。 |
| string | KMIPマスター キーの一意の識別子です。 このキーは、暗号化されたバックアップのヘッドデータベースを暗号化し、復元します。 MongoDB Ops Manager は、バックアップカーソル を使用しています。以前使用していた ヘッドデータベース は使用していません。詳細については、「バックアップデーモン サービス」を参照してください。 バックアップの暗号化の詳細については、「暗号化されたバックアップスナップショット」を参照してください。 |
リクエストの例
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 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "clusterId" : "{CLUSTER-ID}", "groupId" : "{PROJECT-ID}", "encryptionKeyUUID": "1234-3456-4567-abcd-def0"}