文档首页/云数据库 RDS/API参考/API v3（推荐）/实例管理/开启实例TDE（SQL Server） - UpdateTdeStatus
更新时间：2026-02-04 GMT+08:00
查看PDF
分享

开启实例TDE（SQL Server） - UpdateTdeStatus

功能介绍

开启实例的TDE功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:tde

permission_management

-

g:EnterpriseProjectId g:ResourceTag/<tag-key>

-

-

接口约束

  • 该接口仅支持RDS for SQL Server实例。
  • 开启TDE后无法关闭，且无法重复开启。
  • 支持的版本：所有版本的企业版、2019标准版、2022标准版。

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/tde

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

    获取方法请参见获取项目ID。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

    该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。

    默认取值：

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

rotate_day

否

Integer

参数解释：

轮转天数。

约束限制：

仅支持SQL Server引擎。如需使用TDE轮转功能，需要配置该参数，请提交工单申请。

取值范围：

1~100000内的正整数。

默认取值：

为空，表示不使用TDE轮转。

secret_id

否

String

参数解释：

密钥ID。

约束限制：

仅支持SQL Server引擎。如需使用TDE轮转功能，需要配置该参数，请提交工单申请。

取值范围：

不涉及。

默认取值：

为空，表示不使用TDE轮转。

secret_name

否

String

参数解释：

密钥名称。

约束限制：

仅支持SQL Server引擎。如需使用TDE轮转功能，需要配置该参数，请提交工单申请。

取值范围：

不涉及。

默认取值：

为空，表示不使用TDE轮转。

secret_version

否

String

参数解释：

密钥版本。

约束限制：

仅支持SQL Server引擎。如需使用TDE轮转功能，需要配置该参数，请提交工单申请。

取值范围：

不涉及。

默认取值：

为空，表示不使用TDE轮转。

请求示例

  • 开启实例TDE（不使用TDE轮转）。 
    PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin04/tde
{}
  • 开启实例TDE（使用TDE轮转）。 
    {
"rotate_day": 365,
"secret_id":"d0964270-2716-405b-bc3a-12a942451716",
"secret_name":"test",
"secret_version":"v10"
}

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    job_id

    String

    参数解释：

    任务流ID。

    取值范围：

    不涉及。

  • 正常响应样例 
    {
"job_id":"2b414788a6004883a02390e2eb0ea227"
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题：实例管理