All Products
Document Center

ApsaraDB RDS:ModifyDbProxyInstanceSsl

Last Updated:Nov 30, 2023

Configures SSL encryption for an dedicated proxy endpoint of an ApsaraDB RDS for MySQL instance.

Operation Description

Supported database engines



Note : Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation:

Configure SSL encryption for a proxy endpoint


You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.


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
  • DBInstance
  • rds:ResourceTag

Request parameters


The region ID. You can call the DescribeRegions operation to query the most recent region list.


The instance ID. You can call the DescribeDBInstances operation to query the instance ID.


The ID of the proxy endpoint. You can call the DescribeDBProxyEndpoint operation to query the ID of the proxy endpoint.


The dedicated proxy endpoint of the instance.

The SSL configuration setting that you want to apply on the instance. Valid values:

  • 0: disables SSL encryption.
  • 1: enables SSL encryption or modifies the endpoint that requires SSL encryption.
  • 2: updates the validity period of the SSL certificate.
Note This setting causes your instance to restart. Proceed with caution.

A reserved parameter. You do not need to specify this parameter.


Response parameters


The response parameters.


The ID of the request.



Sample success responses


  "RequestId": "BF46A62B-3717-4397-9338-36BB95C898B3"

Error codes

HTTP status codeError codeError messageDescription
400MinorVersionNotSupportThe current database minor version does not support the operation.The operation is not supported for the minor engine version of the instance.
400InvalidDbProxyStatusThe proxy status of the database is abnormal.The operation failed. The database proxy of the RDS instance is abnormal.
400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.
403RDSCategoryNotSupportThe specified instance category does not support this operation.-
404Endpoint.NotFoundThe specified endpoint is not found.-
404EnabledSSLNotSupportThe backend service does not support SSL.The backend does not support SSL encryption.
404InvalidDbProxyConnectionString.NotFoundThe specified database proxy connection string is not found.The operation failed. The database proxy endpoint cannot be found.

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

Change history

Change timeSummary of changesOperation
2022-06-23API Description Update,The error codes of the API operation change.see changesets
Change itemChange content
API DescriptionAPI Description Update
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
2022-06-08The error codes of the API operation change.,The input parameters of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: DBProxyEngineType