文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 数据库安全性/ 设置SSL数据加密 - SwitchSsl
更新时间：2025-11-21 GMT+08:00
查看PDF
分享

设置SSL数据加密 - SwitchSsl

功能介绍

为实例设置SSL数据加密。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:modifySSL

permission_management

-

-

-

-

接口约束

实例在创建、重启、数据库升级、变更规格、创建用户、删除用户等状态下不能设置SSL数据加密。

仅支持RDS for MySQL实例。

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/ssl

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一Region下的项目ID。

    获取方法请参见获取项目ID。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

ssl_option

是

boolean

参数解释：

SSL数据加密开关设置。

约束限制：

不涉及。

取值范围：

  • true：表示开启SSL数据加密。
  • false：表示关闭SSL数据加密。

默认取值：

不涉及。

请求示例

  • 开启SSL数据加密。 
    PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ssl
{
     "ssl_option": true
}
  • 关闭SSL数据加密。 
    {
     "ssl_option": false
}

响应消息

  • 正常响应要素说明

    名称

    说明

    job_id

    参数解释：

    任务ID。

    取值范围：

    不涉及。
  • 正常响应样例 
    {
      "job_id":"83abc7bc-2c70-4534-8565-351187b37715"
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 数据库安全性

相关文档