使用DescribeDBInstanceSSL查询MongoDB实例的SSL设置-云数据库 MongoDB 版-阿里云-云数据库 MongoDB 版(MongoDB)-阿里云帮助中心

接口说明

调用该接口时，实例必须满足以下条件：

实例状态为运行中。
实例类型为副本集或分片集群实例。
- 副本集实例的版本需为 3.4 及以上版本。
- 分片集群实例的存储模式需要为 ESSD 云盘版。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeDBInstanceSSL

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。	dds-bpxxxxxxxx

返回参数

名称	类型	描述	示例值
	object
SSLExpiredTime	string	SSL 证书的过期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2020-03-11T02:28:25Z
SSLStatus	string	SSL 功能的状态。 Open：SSL 功能已开启。 Closed：SSL 功能已关闭。	Open
RequestId	string	请求 ID。	36BB1BC2-789C-4BBA-A519-C5B388E4B0D4
CertCommonName	string	SSL 证书名称。	dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com
ForceEncryption	string

示例

正常返回示例

JSON格式

{
  "SSLExpiredTime": "2020-03-11T02:28:25Z",
  "SSLStatus": "Open",
  "RequestId": "36BB1BC2-789C-4BBA-A519-C5B388E4B0D4",
  "CertCommonName": "dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
  "ForceEncryption": ""
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。