Modifies the SSL settings of an ApsaraDB for MongoDB instance.
Operation description
Usage
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 3.4 or 4.0.
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.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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:ModifyDBInstanceSSL | update | *Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The ID of the instance. | dds-bp2235**** |
| SSLAction | string | Yes | The operation on the SSL feature. Valid values:
| Open |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "6D806B11-078F-4154-BF9F-844F56D08964"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 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. | The character type of the current instance does not allow the current 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. | The current database instance locking mode does not support this operation. |
| 404 | EnabledSSLNotSupport | Specified region does not support enable ssl. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|
No change history