
# 开启实例TDE（SQL Server） - UpdateTdeStatus
#### 功能介绍
开启实例的TDE功能。
- 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。
- 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。
 
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=UpdateTdeStatus)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项              | 访问级别                  | 资源类型（\*为必须） | 条件键                                             | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| 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](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                 |
  | instance_id | 是    | **参数解释：** 实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
     
  
 
#### 请求消息
表2参数说明 
| 名称             | 是否必选 | 参数类型    | 说明                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| rotate_day     | 否    | Integer | **参数解释：** 轮转天数。 **约束限制：** 仅支持SQL Server引擎。如需使用TDE轮转功能，需要配置该参数，请[提交工单](https://console.huaweicloud.com/ticket/?locale=zh-cn#/ticketindex/createIndex)申请。 **取值范围：** 1\~100000内的正整数。 **默认取值：** 为空，表示不使用TDE轮转。 |
| secret_id      | 否    | String  | **参数解释：** 密钥ID。 **约束限制：** 仅支持SQL Server引擎。如需使用TDE轮转功能，需要配置该参数，请[提交工单](https://console.huaweicloud.com/ticket/?locale=zh-cn#/ticketindex/createIndex)申请。 **取值范围：** 不涉及。 **默认取值：** 为空，表示不使用TDE轮转。      |
| secret_name    | 否    | String  | **参数解释：** 密钥名称。 **约束限制：** 仅支持SQL Server引擎。如需使用TDE轮转功能，需要配置该参数，请[提交工单](https://console.huaweicloud.com/ticket/?locale=zh-cn#/ticketindex/createIndex)申请。 **取值范围：** 不涉及。 **默认取值：** 为空，表示不使用TDE轮转。               |
| secret_version | 否    | String  | **参数解释：** 密钥版本。 **约束限制：** 仅支持SQL Server引擎。如需使用TDE轮转功能，需要配置该参数，请[提交工单](https://console.huaweicloud.com/ticket/?locale=zh-cn#/ticketindex/createIndex)申请。 **取值范围：** 不涉及。 **默认取值：** 为空，表示不使用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"
  }
  ```
  
- 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。
  
 
#### 状态码
- 正常 202
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。
