ListKeyServersKmip

ListKeyServersKmipメソッドを使用すると、作成されたすべてのKey Management Interoperability Protocol(KMIP)キー サーバをリストできます。追加のパラメータを指定することで、結果をフィルタリングできます。

パラメータ

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

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

戻り値

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

名前 説明 タイプ
kmipKeyServers 作成されたKMIPキー サーバの全リスト。 KeyServerKmipの配列

要求例

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

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

応答例

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

{
    "kmipKeyServers": [
        {
            "kmipKeyServerName": "keyserverName",
            "kmipClientCertificate": "dKkkirWmnWXbj9T/UWZYB2oK0z5...",
            "keyServerID": 15,
            "kmipAssignedProviderIsActive": true,
            "kmipKeyServerPort": 5696,
            "kmipCaCertificate": "MIICPDCCAaUCEDyRMcsf9tAbDpq40ES/E...",
            "kmipKeyServerHostnames": [
                "server1.hostname.com", "server2.hostname.com"
            ],
            "keyProviderID": 1
        }
    ]
}

新規導入バージョン

11.7