更新时间：2026-01-07 GMT+08:00
开启透明加密 - EnablingTransparentDataEncryption
调试
您可以在API Explorer中调试该接口。
接口约束
仅支持数据库版本大于等于V2.0-3.300的实例。
URI
PUT /v3/{project_id}/instances/{instance_id}/kms-tde/switch
名称 | 是否必选 | 说明 |
|---|---|---|
project_id | 是 | 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 |
instance_id | 是 | 参数解释： 实例ID，此参数是用户创建实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为36个字符。 默认取值： 不涉及。 |
请求参数
名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
kms_tde_key_id | 是 | String | 参数解释： KMS主密钥ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
kms_tde_status | 是 | String | 参数解释： 透明加密的状态。 约束限制： 不涉及。 取值范围： on：开启。 默认取值： 不涉及。 |
kms_project_name | 是 | String | 参数解释： GaussDB使用透明加密的KMS主密钥ID所在资源空间名称。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
参数 | 参数类型 | 描述 |
|---|---|---|
job_id | String | 参数解释： 异步任务ID。 取值范围： 不涉及。 |
请求示例
开启透明加密。
PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/d8e6ca5a624745bcb546a227aa3ae1cfin14/kms-tde/switch
{
"kms_tde_key_id":"ca0da073-20a4-451d-812d-67f35d4d91f1",
"kms_tde_status":"on",
"kms_project_name":"kms_project_name"
} 响应示例
开启透明加密成功。
{
"job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f"
} 状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
父主题：实例管理
