ModifyDBInstanceSSL - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Operation description

Before you call this operation, ensure that the following requirements are met:

The instance is in the Running state.
The instance is a replica set or sharded cluster instance.
- If the instance is a replica set instance, the instance must run MongoDB 3.4 or later.
- If the instance is a sharded cluster instance, the instance must use Enterprise SSDs (ESSDs).

Note

During the process of enabling, updating, or disabling SSL, the instance will restart once. We recommend that you perform these operations during off-peak hours.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

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 support 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:ModifyDBInstanceSSL

update

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bp2235****
SSLAction	string	Yes	The SSL-related operation that you want to perform. Valid values: Open: enables SSL encryption. Close: disables SSL encryption. Update: updates the SSL certificate.	Open
SwitchMode	string	No

Response parameters

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

Examples

Success response

JSON format

{
  "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.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.