Skip to main content
Element Software
简体中文版经机器翻译而成,仅供参考。如与英语版出现任何冲突,应以英语版为准。

ListKeyProvidersKmip

贡献者

您可以使用 ListKeyProvidersKmip 方法检索所有现有密钥管理互操作性协议( Key Management Interoperability Protocol , KMIP )密钥提供程序的列表。您可以通过指定其他参数来筛选此列表。

Parameters

此方法具有以下输入参数:

Name Description Type 默认值 Required

密钥提供程序 IsActive

根据返回的 KMIP 密钥服务器对象是否处于活动状态对其进行筛选。可能值:

  • true :仅返回处于活动状态的 KMIP 密钥提供程序(提供当前正在使用的密钥)。

  • false :仅返回处于非活动状态的 KMIP 密钥提供程序(未提供任何密钥且可删除)。

如果省略此参数,则不会根据返回的 KMIP 密钥提供程序是否处于活动状态对其进行筛选。

boolean

kmipKeyProviderHasServerAssigned

根据是否已分配 KMIP 密钥服务器筛选返回的 KMIP 密钥提供程序。可能值:

  • true :仅返回已分配 KMIP 密钥服务器的 KMIP 密钥提供程序。

  • false :仅返回未分配 KMIP 密钥服务器的 KMIP 密钥提供程序。

如果省略此参数,则不会根据是否已分配 KMIP 密钥服务器对返回的 KMIP 密钥提供程序进行筛选。

boolean

返回值

此方法具有以下返回值:

Name

Description

Type

kmipKeyProviders

已创建的 KMIP 密钥提供程序的列表。

请求示例

此方法的请求类似于以下示例:

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

响应示例

此方法返回类似于以下示例的响应:

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

自版本以来的新增功能

11.7