# 切换实例SSL开关 - EnablingorDisablingSSL
#### 功能介绍
切换实例的SSL开关。
#### 接口约束
- 该接口支持如下数据库实例：
  - GeminiDB Cassandra
  
  
  
  - GeminiDB Mongo
  
  - GeminiDB Influx
  
  - GeminiDB Redis
   
- 冻结实例，异常实例不支持该操作。
- 切换SSL后，后台会重启实例，请谨慎操作。
 
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=SwitchSsl)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                             | 别名                       | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbfornosql:instance:switchSSL | Write | instance \* | - g:ResourceTag/\<tag-key\>  - g:EnterpriseProjectId   | nosql:instance:switchSSL | -      |
     
  
 
#### URI
POST /v3/{project_id}/instances/{instance_id}/ssl-option
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| project_id  | 是    | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。     |
| instance_id | 是    | String | **参数解释：** 实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表3请求Body参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| ssl_option | 是    | String | **参数解释：** ssl开关选项。 **约束限制：** 不涉及。 **取值范围：** - on：表示实例默认开启SSL连接。  - off：表示实例默认不启用SSL连接。   **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码： 202**
表4响应Body参数 
| 参数     | 参数类型   | 描述                                                                                                                        |
|:---|:---|:---|
| job_id | String | **参数解释：** 任务ID。 **取值范围：** 不涉及。 |
   
#### 请求示例
- 开启SSL开关
  ```
  POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option 
  { 
    "ssl_option" : "on" 
  }
  ```
  
- 关闭SSL开关
  ```
  POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option 
  { 
    "ssl_option" : "off" 
  }
  ```
  
 
#### 响应示例
**状态码： 202**
Accepted
```
{ 
  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae" 
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。