---
title: "ssl_external_kms_info - OceanBase 数据库 V4.1.0 | OceanBase 文档中心"
description: ssl_external_kms_info ssl_external_kms_info 配置项用于记录 OceanBase 数据库 SSL 功能运行依赖的一些信息，通过 json 字符串方式记录不同 SSL 使用方式下依赖的相关配置，json 中至少包含类型 ssl_mode 字段。 属性 描述 参数类型 字符串 默…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*P8CuR4UJ_FkAAAAAAAAAAAAADiGDAQ/original) OceanBase 数据库分布式版 - V 4.1.0

# ssl_external_kms_info

更新时间：2023-10-11 16:02:10

[编辑](https://github.com/oceanbase/oceanbase-doc/edit/V4.1.0/zh-CN/700.reference/500.system-reference/100.system-configuration-items/300.cluster-level-configuration-items/19500.ssl_external_kms_info.md)  

ssl_external_kms_info 配置项用于记录 OceanBase 数据库 SSL 功能运行依赖的一些信息，通过 json 字符串方式记录不同 SSL 使用方式下依赖的相关配置，json 中至少包含类型 ssl_mode 字段。

| 属性 | 描述 |
| --- | --- |
| 参数类型 | 字符串 |
| 默认值 | 空字符串 |
| 取值范围 | 无 |
| 是否重启 OBServer 节点生效 | 否 |

使用说明：

- 该配置项的默认值为空字符串。当 SSL 开关打开后，SSL 使用密钥将取值默认路径下的默认文件。
 - 该配置项取值必须为有效 json，否则配置项设置会检查失败。
 - 该配置项当前仅支持两种取值：file 和 bkmi，用于指定 ssl_mode。

     - 指定为 file 时， json 字符串中不需要其他内容。
     - 指定为 bkmi 时，运行时向 bkmi 获取 SSL 文件，本地不持久化存储。同时，json 字符串还需要提供完整的应用名、bkmi url、bkmi 根证书、身份秘钥、身份秘钥口令、SSL 私钥名称、SSL 私钥版本号、SSL 证书名称等。并且这些信息确实有效可用，即能通过这些从 bkmi 中获取私钥和证书，否则会报响应错误码。

为了支持外部其他各自的证书颁发体系，ssl_external_kms_info 还可以定制扩展为其他内容 json 串。

示例如下：

```sql
obclient> ALTER SYSTEM SET ssl_external_kms_info = '
{
"ssl_mode":"file"
}';
```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线
