All Products
Search

This Product

    ApsaraDB for MongoDB:ModifyDBInstanceSSL

    Document Center

    ApsaraDB for MongoDB:ModifyDBInstanceSSL

    Last Updated:Sep 03, 2024

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    dds:ModifyDBInstanceSSLupdate
    • Instance
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance.

    		dds-bp2235****
    SSLActionstringYes

    The operation on the SSL feature. Valid values:

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

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    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 codeError codeError messageDescription
    400InvalidParamSpecified parameters is not valid.-
    400SSLAlreadyEnabledSSL have already been enabled.-
    400SSLAlreadyDisabledSSL have already been disabled.-
    403SSLNotEnabledSSL not enabled.-
    403IncorrectCharacterTypeCurrent DB instance CharacterType does not support this operation.-
    403IncorrectEngineVersionCurrent engine version does not support operations.-
    403IncorrectDBInstanceStateCurrent 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.
    403IncorrectDBInstanceLockModeCurrent 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.
    404EnabledSSLNotSupportSpecified region does not support enable ssl.-

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history