云数据库 SQL Server 版
云数据库 SQL Server 版
文档指南
请输入
- 文档首页
云数据库 SQL Server 版API 参考数据安全ModifyDBInstanceTDE - 修改实例的 TDE 配置
复制全文
下载 pdfModifyDBInstanceTDE - 修改实例的 TDE 配置
文档反馈
问问助手调用 ModifyDBInstanceTDE 接口修改实例的 TDE 配置。
请求说明
异步请求
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：ModifyDBInstanceTDE
要执行的操作，取值：ModifyDBInstanceTDE。
Version string 必选 示例值：2022-01-01
API的版本，取值：2022-01-01。
InstanceId string 必选 示例值：mssql-123abc******
实例 ID。
TDEStatus string 必选 示例值：Enable
是否开启实例的 TDE 加密。当前仅支持取值为 Enable。
TDEMode string 必选 示例值：MSSQL_Default
实例的 TDE 加密模式。
- MSSQL_Default：由火山 SQL Server 内核自动生成。
- User_Default：用户上传自定义证书。
DBStatus object[] 可选 示例值：[ {"DBName":"db1", "Enable": true}, {"DBName":"db2", "Enable": false} ]
需要加密或者解密的数据库状态描述。
DBName string 必选 示例值：db1
数据库名称。
Enable boolean 必选 示例值：true
是否开启加密。取值为：
- true：数据库为加密状态。
- false：数据库为解密状态。
Certificate string 可选 示例值：tos-cn-beijing.volces.com:mssql-test:my.cer
用于 TDE 加密的证书文件，可使用 TOS 路径输入，格式为 <endpoint>:<bucket>:<xxx.cer>。证书长度受证书主体（Subject）字段内容复杂度的影响，请控制在 1,866 ~ 2,922 字节范围内。
说明
仅在 TDEMode 参数取值为 User_Default 时有效。
PrivateKey string 可选 示例值：tos-cn-beijing.volces.com:mssql-test:mycert.pvk
用于 TDE 加密的证书私钥，可使用 TOS 路径输入，格式为 <endpoint>:<bucket>:<xxx.pvk>。私钥必须与已配置的证书公钥匹配。
说明
仅在 TDEMode 参数取值为 User_Default 有效。
Password string 可选 示例值：Key*******
用于 TDE 加密的证书私钥密码。请确保证书的私钥密码符合以下要求：
- 只能为大小写字母、数字及以下特殊字符 ~!@#$%^&\*()-_+=?。
- 长度需要在 8~32 个字符内。
- 至少包含大写字母、小写字母、数字或特殊字符中的 3 种。
说明
仅在 TDEMode参数取值为 User_Default 有效。
返回参数
请求示例
返回示例
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidParameter | The specified parameter %s is not valid. | 参数 {parameter1} 值无效。 |
最近更新时间：2026.07.17 17:52:59
这个页面对您有帮助吗？
有用
有用
无用
无用