DescribeDBInstanceSSL--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstanceSSL

最近更新时间：2025.01.22 12:04:47首次发布时间：2023.08.14 13:15:55

调用 DescribeDBInstanceSSL 接口查询指定 MySQL 实例的 SSL 设置。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-d4942fd7****	实例 ID。

返回参数

参数	类型	示例值	描述
SSLEnable	Boolean	true	SSL 开关，取值： `true` ：开启。 `false` ：关闭。
IsValid	Boolean	false	证书是否有效，取值： `true`：有效。 `false`：无效。
SSLExpireTime	String	2024-08-10T03:47:37.000Z	证书过期时间，格式： yyyy-MM-dd HH:mm:ss（UTC 时间）。
TLSVersion	String	TLSv1.1,TLSv1.2	支持的 TLS 版本。多个版本之间使用英文逗号（,）分隔。
InstanceId	String	mysql-d4942fd7****	实例 ID。
Address	String	mysqld4942fd7****.rds-boe.ivolces.com	受保护地址。

示例

请求示例

POST /?Action=DescribeDBInstanceSSL&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-d4942fd7****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308101148194C92693AD273B64DDD92",
        "Action": "DescribeDBInstanceSSL",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "Address": "mysqld4942fd7****.rds.ivolces.com",
        "InstanceId": "mysql-d4942fd7****",
        "IsValid": true,
        "SSLEnable": true,
        "SSLExpireTime": "2024-08-10T03:47:37.000Z",
        "TLSVersion": "TLSv1,TLSv1.1,TLSv1.2"
    }
}

错误码

更多详情，请参见错误码。