You need to enable JavaScript to run this app.
文档中心
文档数据库 MongoDB 版

文档数据库 MongoDB 版

复制全文
下载 pdf
SSL 加密
DescribeDBInstanceSSL
复制全文
下载 pdf
DescribeDBInstanceSSL
调用 DescribeDBInstanceSSL 接口查询目标 MongoDB 实例的 SSL 加密设置,包括功能是否已开通、SSL 证书到期时间等信息。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
InstanceId String 必选 示例值:mongo-shard-f9e5d782****
实例 ID。
说明
您可以调用 DescribeDBInstances接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。
返回参数
InstanceId String 示例值:mongo-shard-f9e5d782****
实例 ID。
SSLEnable Boolean 示例值:true
SSL 加密功能是否已开通。取值范围如下:
  • true:已开通。
  • false:已关闭。
SSLExpiredTime String 示例值:2023-10-20T08:50:22Z
SSL 证书过期时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC)。
说明
仅当 SSL 证书有效(即 IsValid 取值为 true)时,会返回该参数。
IsValid Boolean 示例值:false
SSL 证书是否有效。取值范围如下:
  • true:有效。
  • false:无效。
示例
请求示例
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeDBInstanceSSL&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.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": "2022102016514301017425520205340534",
"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"
}
}
错误码
更多详情,请参见错误码
最近更新时间:2026.06.17 16:52:13
这个页面对您有帮助吗?
有用
有用
无用
无用