You can call this operation to query the SSL settings of a MongoDB instance.

Before you call this operation, make sure that the following requirements are met:

  • The instance must be in the Running state.
  • The instance type is replica set.
  • The database version of the instance is 3.4 or 4.0 version.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBInstanceSSL

The operation that you want to perform. Set the value to DescribeDBInstanceSSL.

DBInstanceId String Yes dds-bpxxxxxxxx

The ID of the instance.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.

AccessKeyId String No LTAIgbTGpxxxxxx

The AccessKey ID that Alibaba Cloud provides for you to access services.

Response parameters

Parameter Type Example Description
SSLExpiredTime String 2020-03-11T02:28:25Z

The expiration time of the SSL Certificates Service in the format of yyyy-MM-dd T HH:mm:ss z(UTC time).

RequestId String 36BB1BC2-789C-4BBA-A519-C5B388E4B0D4

The ID of the request.

SSLStatus String Open

The status of the SSL function.

  • Open
  • Closed
CertCommonName String dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com

The name of the SSL certificate.

Examples

Sample requests


http(s)://mongodb.aliyuncs.com/? Action=DescribeDBInstanceSSL
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>

Successful response examples

XML format

<DescribeDBInstanceSSLResponse>
	  <SSLExpiredTime>2020-03-11T02:28:25Z</SSLExpiredTime>
	  <RequestId>36BB1BC2-789C-4BBA-A519-C5B388E4B0D4</RequestId>
	  <SSLStatus>Open</SSLStatus>
	  <CertCommonName>dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com</CertCommonName>
</DescribeDBInstanceSSLResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.