文档首页> 云数据库 GeminiDB> API参考> API v3（推荐）> 实例管理> 切换实例SSL开关
更新时间：2023-11-21 GMT+08:00
查看PDF

切换实例SSL开关

功能介绍

切换实例的SSL开关。

接口约束

  • 该接口支持如下数据库实例：
    • GeminiDB Mongo
    • GeminiDB Influx
    • GeminiDB Redis
  • 冻结实例，异常实例不支持该操作。
  • 切换SSL后，后台会重启实例，请谨慎操作。

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/ssl-option

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户在某一region下的project ID。获取方法请参见获取项目ID。

instance_id

是

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户token。
表3 请求Body参数

参数

是否必选

参数类型

描述

ssl_option

是

String

ssl开关选项。

  • “on”，表示实例默认开启SSL连接。
  • “off”，表示实例默认不启用SSL连接。

响应参数

状态码： 202

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

请求示例

  • 开启SSL开关
    • URI样例
      POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option
    • 开启SSL开关
      { 
  "ssl_option" : "on" 
}
  • 关闭SSL开关
    • URI样例
      POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option
    • 关闭SSL开关
      { 
  "ssl_option" : "off" 
}

响应示例

状态码： 202

Accepted

{ 
  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae" 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理