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

切换SSL开关

接口说明

切换实例的SSL开关。

约束说明

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

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/switch-ssl

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switch-ssl

表1 路径参数

名称

是否必选

类型

IN

描述

project_id

是

string

path

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

string

path

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求消息

表2 请求Header参数

名称

是否必选

类型

IN

描述

X-Auth-Token

是

string

header

参数解释：

从IAM服务获取的用户Token。请参考认证鉴权。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 参数说明

名称

参数类型

是否必选

描述

ssl_option

String

是

参数解释：

SSL开关选项。

约束限制：

不涉及。

取值范围：

  • 取“0”，表示DDS实例默认不启用SSL连接。
  • 取“1”，表示DDS实例默认启用SSL连接。

默认取值：

不涉及。

请求示例

关闭实例的SSL开关，默认不启用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"  
}

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 实例管理

相关文档