---
title: "ssl_external_kms_info - OceanBase 数据库 V4.6.0 | OceanBase 文档中心"
description: ssl_external_kms_info 说明 该配置项从 V2.2.77 版本开始引入。 功能描述 ssl_external_kms_info 配置项用于记录 OceanBase 数据库 SSL 功能运行依赖的一些信息，通过 Json 字符串方式记录不同 SSL 使用方式下依赖的相关配置，Json 中至少包含类型…
---
切换语言

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

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

# ssl_external_kms_info

更新时间：2026-06-01 09:46:46

[编辑](https://github.com/oceanbase/oceanbase-doc/edit/V4.6.0/zh-CN/700.reference/800.configuration-items-and-system-variables/100.system-configuration-items/300.cluster-level-configuration-items/20900.ssl_external_kms_info.md)

#### 说明

该配置项从 V2.2.77 版本开始引入。

## 功能描述

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

## 权限要求

- 查询配置项

  `sys` 租户和所有用户租户均可以使用 `SHOW PARAMETERS` 语句或视图 `GV$OB_PARAMETERS` 查询该配置项。
 - 修改配置项

  仅 `sys` 租户可以修改该配置项，用户租户不能修改该配置项。

## 属性说明

| **属性** | **描述** |
| --- | --- |
| 参数类型 | String |
| 默认值 | ""，表示空字符串 |
| 是否可修改 | 是，支持通过 `ALTER SYSTEM SET` 语句修改。 |
| 是否重启 OBServer 节点生效 | 否，设置后立即生效。 |

## 使用说明

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

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

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

## 配置示例

设置 SSL 证书配置采用 file 模式。

```shell
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) 咨询热线