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

切换实例SSL开关 - EnablingorDisablingSSL

功能介绍

切换实例的SSL开关。

接口约束

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    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。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

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" 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理