ListKeyProvidersKmip

ListKeyProvidersKmipメソッドを使用すると、既存のすべてのKey Management Interoperability Protocol(KMIP)キー プロバイダのリストを取得できます。追加のパラメータを指定することで、リストをフィルタリングできます。

パラメータ

このメソッドの入力パラメータは次のとおりです。

名前 説明 タイプ デフォルト値 必須
keyProviderIsActive アクティブかどうかでフィルタリングしたKMIPキー サーバ オブジェクトを返します。有効な値は次のとおりです。
  • true:アクティブな(現在使用中のキーを提供している)KMIPキー プロバイダのみを返します。
  • false:非アクティブな(いずれのキーも提供せず、削除可能な)KMIPキー プロバイダのみを返します。
省略すると、返されるKMIPキー プロバイダは、アクティブかどうかでフィルタリングされません。
ブーリアン なし ×
kmipKeyProviderHasServerAssigned 割り当てられたKMIPキー サーバがあるかどうかでフィルタリングされたKMIPキー プロバイダが返されます。有効な値は次のとおりです。
  • true:割り当てられたKMIPキー サーバがあるKMIPキー プロバイダのみを返します。
  • false:割り当てられたKMIPキー サーバがないKMIPキー プロバイダのみを返します。
省略すると、返されるKMIPキー プロバイダは、割り当てられたKMIPキー サーバがあるかどうかでフィルタリングされません。
ブーリアン なし ×

戻り値

このメソッドの戻り値は次のとおりです。

名前 説明 タイプ
kmipKeyProviders 作成されたKMIPキー プロバイダのリスト。 KeyProviderKmipの配列

要求例

このメソッドの要求例を次に示します。

{
  "method": "ListKeyProvidersKmip",
  "params": {},
"id": 1
}

応答例

このメソッドの応答例を次に示します。

{
   "id": 1,
   "result": 
    {
    "kmipKeyProviders": [
        {
            "keyProviderID": 15,
            "kmipCapabilities": "SSL",
            "keyProviderIsActive": true,
            "keyServerIDs": [
                1
            ],
            "keyProviderName": "KeyProvider1"
        }
    ]
}
}

新規導入バージョン

11.7