1 つのキーヴォールト構成を削除します。
注意
1 つ以上の S3 互換スナップ読み取りが使用するキーヴォールト構成は削除できません。 MongoDB Ops Manager は KEY_VAULT_CONFIG_IN_USE コードで 409 Conflict エラーを返します。構成を削除するには、まず、それを使用する S3 互換読み取りをアップデートまたは削除します。
必須のロール
このエンドポイントを呼び出す APIキーに Global Ownerロールが必要です。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin
Resource
DELETE /keyVault/{KEY-VAULT-ID}
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
KEY-VALT- ID | string | 削除するキーヴォールト構成の一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体が pretty-print 形式であるかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
このエンドポイントには、応答要素がありません。
リクエストの例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --include \ --request DELETE 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault/{KEY-VAULT-ID}'
応答例
このエンドポイントは、レスポンス本体を返しません。