ModifyDBInstanceTDE--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

ModifyDBInstanceTDE

最近更新时间：2025.06.26 21:06:33首次发布时间：2024.01.05 16:55:48

调用 ModifyDBInstanceTDE 接口开启实例的透明数据加密 TDE 功能。

请求类型

异步请求。

注意事项

开启透明数据加密 TDE 功能需要重启实例。
透明数据加密 TDE 功能开启后不可关闭。
仅双节点实例支持 TDE 功能。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-d759ceaf****	实例 ID。
TDEStatus	String	是	Enable	透明数据加密功能的设置状态，取值为 `Enable`。
KeyringName	String	否	demo_keyring_name	自定义密钥环名称。说明如需使用自定义密钥，需同时传入 KeyringName 和 KeyName。只传入一个字段或不传时，会使用自动生成的密钥。
KeyName	String	否	demo_key_name	自定义密钥名称。
SwitchType	String	否	MaintainTime	执行时间，取值： `Immediate`：立即切换（默认）。 `MaintainTime`：可维护时间段内进行切换。 `SpecifiedTime`：指定时间段内进行切换。说明可调用 DescribeDBInstanceDetail 接口查询实例的可维护时间段。取值为 `SpecifiedTime` 时，需要在参数 SpecifiedSwitchStartTime 和 SpecifiedSwitchEndTime 中设定时间段的起止时间。
SpecifiedSwitchStartTime	String	否	2024-12-25T14:00:00Z	指定时间段执行时时间段的起始时间。时间格式为 `yyyy-MM-ddTHH:mm:ssZ`。说明仅在 SwitchType 取值为 `SpecifiedTime` 时有效。需为整点时间。
SpecifiedSwitchEndTime	String	否	2024-12-25T15:59:00Z	指定时间段执行时时间段的结束时间。时间格式为 `yyyy-MM-ddTHH:mm:ssZ`。说明指定时间段的最短时长为一小时五十九分钟。

返回参数

null

示例

请求示例

POST /?Action=ModifyDBInstanceTDE&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-d759ceaf****",
    "TDEStatus": "Enable",
    "KeyringName": "demo_keyring_name",
    "KeyName": "demo_key_name"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202401051447533171AB8F9C34F1250857",
        "Action": "ModifyDBInstanceTDE",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情，请参见错误码。