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