DescribeDBInstanceSSL -

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

The instance is in the running state.
The instance is a replica set instance.
The database version of the instance is 3.4 or 4.0.

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 an instance.
AccessKeyId	String	No	LTAIgbTGpxxxxxx	The AccessKey ID provided to you by Alibaba Cloud.

Response parameters


Parameter	Type	Example	Description
SSLExpiredTime	String	2020-03-11T02:28:25Z	The time when the SSL certificate expires. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
RequestId	String	36BB1BC2-789C-4BBA-A519-C5B388E4B0D4	The ID of the request.
SSLStatus	String	Open	The status of the SSL feature. Valid values: Open: The SSL feature is enabled. Closed: The SSL feature is disabled.
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>

Sample success responses

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

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

Error codes

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