DescribeDBInstanceSSL - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the Secure Sockets Layer (SSL) settings of an ApsaraDB for MongoDB instance.

Operation description

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 instance runs MongoDB 3.4 or later.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dds:DescribeDBInstanceSSL	READ	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bpxxxxxxxx

Response parameters

Parameter	Type	Description	Example
	object
SSLExpiredTime	string	The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in Coordinated Universal Time (UTC).	2020-03-11T02:28:25Z
SSLStatus	string	The status of the SSL feature. Valid values: Open: The SSL feature is enabled. Closed: The SSL feature is disabled.	Open
RequestId	string	The request ID.	36BB1BC2-789C-4BBA-A519-C5B388E4B0D4
CertCommonName	string	The name of the SSL certificate.	dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history