# 设置SSL数据加密 - SwitchSsl
#### 功能介绍
为实例设置SSL数据加密。
- 调用接口前，您需要了解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://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=RDS&api=SwitchSsl)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                    | 访问级别                  | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:modifySSL | permission_management | -           | -   | -  | -      |
   
#### 接口约束
实例在创建、重启、数据库升级、变更规格、创建用户、删除用户等状态下不能设置SSL数据加密。
仅支持RDS for MySQL实例。
#### URI
- URI格式 PUT /v3/{*project_id* }/instances/{*instance_id*}/ssl
  

- 参数说明
  表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参数说明 
| 名称         | 是否必选 | 参数类型    | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| ssl_option | 是    | boolean | **参数解释**： SSL数据加密开关设置。 **约束限制**： 不涉及。 **取值范围**： - true：表示开启SSL数据加密。  - false：表示关闭SSL数据加密。   **默认取值**： 不涉及。 |
   
#### 请求示例
- 开启SSL数据加密。
  ```
  PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ssl
  {
       "ssl_option": true
  }
  ```
  

- 关闭SSL数据加密。
  ```
  {
       "ssl_option": false
  }
  ```
  
 
#### 响应消息
- 正常响应要素说明
  
  | 名称     | 说明                                                                                                                          |
  |:---|:---|
  | job_id | **参数解释**： 任务ID。 **取值范围**： 不涉及。 |
     
  
- 正常响应样例
  ```
  {
        "job_id":"83abc7bc-2c70-4534-8565-351187b37715"
  }
  ```
  
- 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。
  
 
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。