文档首页/ 文档数据库服务 DDS/ API参考（联盟区域）/ API v3（推荐）/ 实例管理/ 切换SSL开关
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

切换SSL开关

接口说明

切换实例的SSL开关。

约束说明

  • 冻结实例，异常实例不支持该操作。
  • 切换SSL后，后台会重启实例，请谨慎操作。

URI

  • URI格式

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

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。
表3 参数说明

名称

参数类型

是否必选

描述

ssl_option

String

是

SSL开关选项。

取值：

  • 取“0”，表示DDS实例默认不启用SSL连接。
  • 取“1”，表示DDS实例默认启用SSL连接。
  • 请求示例 
    {
    "ssl_option": "0"
}

响应参数

表4 参数说明

名称

参数类型

是否必选

描述

job_id

String

是

工作流ID。

ssl_option

String

是

SSL开关选项。

取值：

  • 取“0”，表示DDS实例不启用SSL连接。
  • 取“1”，表示DDS实例启用SSL连接。
  • 响应示例 
    {
    "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5",
    "ssl_option": "0"  
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 实例管理