文档中心

云数据库 SQL Server 版

数据安全

DescribeDBInstanceSSL - 查询实例SSL配置

调用 DescribeDBInstanceSSL 接口查看实例的 SSL 信息。

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeDBInstanceSSL

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

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

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

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

实例 ID。

说明

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

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InstanceId string 示例值：mssql-6474c95******

实例 ID。

SSLEnable boolean 示例值：true

SSL 加密功能状态，取值如下：

true：开启。

false：关闭。

ForceEncryption boolean 示例值：true

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

true：表示开启。

false：表示关闭。

IsValid boolean 示例值：false

证书是否有效，取值：

true：表示有效。

false：表示无效。

SSLExpireTime string 示例值：2026-02-10T12:45:48Z

证书过期时间，格式（RFC3339）： yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

TLSVersion string 示例值：1.2

支持的 TLS 版本。

Address string 示例值：mssql6474c95******.rds-mssql.ivolces.com

受保护的地址。

RequireUpdate boolean 示例值：false

是否需要更新，取值如下：

false：不需要更新。

true：需要更新。

CertType string 示例值：Volc_SSL

SSL 证书类型，取值如下:

Volc_SSL: 火山引擎自动生成的证书,

Custom_SSL: 用户上传的自定义证书。

请求示例

POST /?Action=DescribeDBInstanceSSL&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******"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "2025021020490168CA4D345CC3AC4D4BCA-******",​
        "Action": "DescribeDBInstanceSSL",​
        "Version": "2022-01-01",​
        "Service": "rds_mssql",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Address": "mssql6474c95******.rds-mssql.ivolces.com",​
        "ForceEncryption": false,​
        "InstanceId": "mssql-6474c95******",​
        "IsValid": true,​
        "RequireUpdate": false,​
        "SSLEnable": true,​
        "SSLExpireTime": "2026-02-10T12:45:48Z",​
        "TLSVersion": "1.2"​
    }​
}​

错误码

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

状态码	错误码	错误信息	说明
400	OperationDenied_ImportJobExists	The operation is not permitted due to exist running import job.	当前实例正在执行数据导入任务，无法执行该操作。
400	UserBackupAmountOverTheLimit	The operation is not permitted due to the user backup amount over the limit.	手动备份的数量超过上限。
400	OperationDenied_BackupJobExists	The operation is not permitted due to exist running backup job.	当前实例正在执行备份任务，无法执行该操作。
400	OperationUnsupported	The operation is unsupported for the specified instance.	操作不支持。
400	InstanceIsNotRunning	The specified instance is not running.	当前实例状态不在运行中。
400	OperationDenied_IncrBackupUnsupportRecovery	The operation is not permitted due to incr backup unsupport recovery.	增量备份无法执行该操作。
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	缺少 {parameter1} 参数。
400	InvalidDBName_Duplicate	The specified DBName already exists.	数据库已存在。
400	TosRestoreTaskDbVerifyFailed	db verify failed, reason:%s.	DB 校验失败，原因是 {parameter1}。
400	InvalidParameter	The specified parameter %s is not valid.	参数 {parameter1} 值无效。
400	InvalidParameterFormat	The input parameter is not valid.	异常参数。
403	QuotaExceeded_RestoreDB	The quota of restore db exceeds.	恢复数据库超过配额限制。
403	OperationDenied_ResourceSoldOut	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.	当前可用区资源不足。
404	BackupNotFound	The specified instance does not exist available backup records.	未找到可用的备份记录。
404	InstanceNotFound	The specified instance does not exist.	未找到该实例。
500	InternalError	The request has failed with internal server error.	内部错误。
500	TosRestoreTaskNumExceedLimit	Too many tasks are being executed. Please submit them later.	正在执行的任务数量过多，请稍后再提交。

最近更新时间：2026.05.28 17:23:07

这个页面对您有帮助吗？

有用

无用