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