All Products
Document Center

ApsaraDB for MongoDB:ModifyDBInstanceSSL

Last Updated:Jan 17, 2023

Modifies 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 engine version of the instance is <ph props="intl">3.4 or 4.0</ph><ph props="china">3.4, 4.0, or 4.2</ph>.
Note When you enable or disable SSL encryption or update the SSL certificate, the instance restarts. We recommend that you call this operation during off-peak hours.

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.
Operate access level Resource type conditional keyword Association operation
dds:ModifyDBInstanceSSL WRITE
  • MongoDB

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of the instance.

SSLAction string Yes

The operation on the SSL feature. Valid values: Valid values:

  • Open: enables SSL encryption.
  • Close: disables SSL encryption.
  • Update: updates the SSL certificate.

Response parameters

Parameter Type Description Example
RequestId string

The ID of the request.



Normal return example


  "RequestId": "6D806B11-078F-4154-BF9F-844F56D08964"

Error codes

Http code Error code Error message
400 InvalidParam Specified parameters is not valid.
400 SSLAlreadyEnabled SSL have already been enabled.
400 SSLAlreadyDisabled SSL have already been disabled.
403 SSLNotEnabled SSL not enabled.
403 IncorrectCharacterType Current DB instance CharacterType does not support this operation.
403 IncorrectEngineVersion Current engine version does not support operations.
403 IncorrectDBInstanceState Current DB instance state does not support this operation.
403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation.
404 EnabledSSLNotSupport Specified region does not support enable ssl.

For a list of error codes, visit the API error center.