文档中心

云数据库 SQL Server 版

数据安全

ModifyDBInstanceSSL - 修改实例SSL配置

调用 ModifyDBInstanceSSL 接口修改实例的 SSL 配置。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ModifyDBInstanceSSL

要执行的操作，取值：ModifyDBInstanceSSL。

Version string 必选示例值：2022-01-01

API的版本，取值：2022-01-01。

InstanceId string 必选示例值：mssql-6474c9******

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询实例 ID。

Type string 必选示例值：Enable

设置 SSL 加密功能。取值如下：

Enable：表示开启 SSL 加密功能。

Disable：表示关闭 SSL 加密功能。

Renew：表示刷新 SSL 证书。

Change：表示修改 SSL 配置。

ForceEncryption boolean 可选示例值：true

是否为实例开启强制 SSL 加密，取值：

true：表示开启。

false：（默认值）表示不开启。

说明

当 Type 取值为 Change 时，该参数为必选。

当 Type 取值为 Enable 或 Renew 时，该参数为可选。

当 Type 为其他取值时，该参数无效。

Certificate string 可选示例值：tos-cn-beijing.volces.com:mssql-test**:cert/ssl_***.pfx

若不填入此参数，则使用火山自动生成的证书；若填入此参数，需指定存放自定义 SSL 证书（ .pfx格式）的 TOS 地址，格式为 <endpoint>:<bucket>:<object>。

Password string 可选示例值：*********

自定义 SSL 证书（ .pfx格式）的密码。密码应满足以下规则：

长度为 8~32 个字符。

至少包含大写字母、小写字母、数字、特殊字符中的三种。

特殊字符为 !@#$%^&\*()_+-=。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=ModifyDBInstanceSSL&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mssql.volcengineapi.com​
X-Date: 20230131T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
​
{​
    "InstanceId":"mssql-6474c9******",​
    "Type":"Enable"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20230823153339243D5B69711EB6******",​
        "Action": "ModifyDBInstanceSSL",​
        "Version": "2022-01-01",​
        "Service": "rds_mssql",​
        "Region": "cn-beijing"​
    },​
    "Result": null​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is not valid.	参数 {parameter1} 值无效。
400	InstanceIsNotRunning	The specified instance is not running.	当前实例状态不在运行中。
404	InstanceNotFound	The specified instance does not exist.	未找到该实例。

最近更新时间：2026.07.17 17:52:59

这个页面对您有帮助吗？

有用

无用