DocsICP FilingConsole
Documentation

DescribeDBInstanceSSL

Updated at:
Copy as MD
Product
My Favorites

Queries the details of the SSL configuration for a MongoDB instance.

Operation description

The instance must meet the following requirements:

  • The instance status is Running.

  • The instance is a replica set instance or a sharded cluster instance.

    • The replica set instance must be version 3.4 or later.

    • The sharded cluster instance must use Enhanced SSDs (ESSDs).

Try it now

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

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeDBInstanceSSL

get

*Instance

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

None

None

Request parameters

Parameter

Type

Required

Description

Example

DBInstanceId

string

Yes

The instance ID.

dds-bpxxxxxxxx

Response elements

Element

Type

Description

Example

object

SSLExpiredTime

string

The expiration time of the SSL certificate. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.

2020-03-11T02:28:25Z

SSLStatus

string

The status of the SSL feature.

  • 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

ForceEncryption

string

Specifies whether connections must be encrypted using SSL. Valid values:

  • 1: Connections must be encrypted using SSL.

  • 0: Connections do not need to be encrypted using SSL.

Valid values:

  • 0 :

    0

  • 1 :

    1

0

Examples

Success response

JSON format

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

Error codes

See for a complete list.

Release notes

See 变更详情 for a complete list.