You need to enable JavaScript to run this app.
导航
文档数据库 MongoDB 版
  • 文档首页
    • /
  • 文档数据库 MongoDB 版

DescribeDBInstanceSSL

最近更新时间：2023.03.14 20:29:42

首次发布时间：2022.11.04 10:42:22

我的收藏

调用 DescribeDBInstanceSSL 接口查询指定实例的 SSL 加密设置，包括功能是否已开通、SSL 证书到期时间等信息。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述

InstanceId

String

是

mongo-shard-f9e5d782****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。

返回数据

名称类型示例值描述
InstanceIdStringmongo-shard-f9e5d782****实例 ID。

SSLEnable

Boolean

SSL 加密功能是否已开通。取值范围如下：

  • true：已开通。
  • false：已关闭。

IsValid

Boolean

false

SSL 证书是否有效。取值范围如下：

  • true：有效。
  • false：无效。

SSLExpiredTime

String

2023-10-20T08:50:22Z

SSL 证书过期时间，格式为 yyyy-MM-ddTHH:mmZ（UTC 时间）。

说明

仅当 SSL 证书有效（即 IsValid 取值为 true）时，会返回该参数。

请求示例

POST https://mongodb.volcengineapi.com/?Action=DescribeDBInstanceSSL&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId":"mongo-shard-f9e5d782****"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202210201651430101742552020534****",
        "Action": "DescribeDBInstanceSSL",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "mongo-shard-f9e5d782****",
        "IsValid": true,
        "SSLEnable": true,
        "SSLExpiredTime": "2023-10-20T08:50:22Z"
    }
}