Overview
external_kms_info is used to store key management information.
Privilege requirements
Query parameters
Both the
systenant and all user tenants can query this parameter using theSHOW PARAMETERSstatement or theGV$OB_PARAMETERSview.Modify parameters
This parameter can be modified by both the
systenant and user tenants.
Attributes
Attribute |
Description |
|---|---|
| Parameter type | String |
| Default Value | "" indicates an empty string. |
| Modifiable | Yes, you can use the following methods:ALTER SYSTEM SETStatement modification. |
| Whether to restart the OBServer node for the change to take effect | No, the setting takes effect immediately. |
Usage instructions
When using an external Key Management Service, you can configure the external_kms_info parameter to store key management information. The specific format is as follows:
{
"KMS_HOST": "TEST_SERVER", // KMS address
"ROOT_CERT": "TEST_CERT", // Certificate public key
"PRIVATE_KEY": "TEST_PKEY", // The private key of the certificate.
"PRIVATE_KEY_PHRASE": "TEST_PHRASE", // Certificate private key phrase
"SCENE": "HK", // The scenario. Valid values: HK, ANT, HK_SM, and ANT_SM.
"KEY_NAME": "TEST_NAME", // The name of the key.
"CALLER": "TEST_CALLER" // Application name
}
Configuration example
Create a key named ob_cluster_key in KMS and configure it using the external_kms_info parameter.
obclient> ALTER SYSTEM SET external_kms_info = '
{
"KMS_HOST": "kms.ob.com:443",
"ROOT_CERT": "******",
"PRIVATE_KEY": "******",
"PRIVATE_KEY_PHRASE": "ob2025",
"SCENE": "ANT",
"KEY_NAME": "ob_cluster_key",
"CALLER": "oceanbase_admin"
}';