All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeDBInstanceSSL

Last Updated:Feb 20, 2023

Queries the 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.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
dds:DescribeDBInstanceSSLREAD
  • MongoDB
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance.

dds-bpxxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
SSLExpiredTimestring

The time when the SSL certificate expires. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2020-03-11T02:28:25Z
SSLStatusstring

The status of the SSL feature. Valid values:

  • Open: The SSL feature is enabled.
  • Closed: The SSL feature is disabled.
Open
RequestIdstring

The ID of the request.

36BB1BC2-789C-4BBA-A519-C5B388E4B0D4
CertCommonNamestring

The name of the SSL certificate.

dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com

Example

Normal return example

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 API error center.