ModifyDBInstanceSSL - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

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

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:ModifyDBInstanceSSL	WRITE	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	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: enables SSL encryption. Close: disables SSL encryption. Update: updates the SSL certificate.	Open

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	6D806B11-078F-4154-BF9F-844F56D08964

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.	-
403	IncorrectEngineVersion	Current engine version does not support operations.	-
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	This operation is not supported while the instance is in the current state. Wait until the instance state changes to running and try again.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	The specified instance is locked and no operations are allowed on this instance. Unlock this instance and try again.
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