All Products
Search

This Product

    ApsaraDB RDS:ModifyDbProxyInstanceSsl

    Document Center

    ApsaraDB RDS:ModifyDbProxyInstanceSsl

    Last Updated:Apr 17, 2024

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

    Operation description

    Supported database engines

    RDS MySQL

    References

    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

    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
    rds:ModifyDbProxyInstanceSslWrite
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

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

    		cn-hangzhou
    DbInstanceIdstringYes

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

    		rm-t4n3axxxxx
    DbProxyEndpointIdstringYes

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

    		ta9um4xxxxx
    DbProxyConnectStringstringYes

    The dedicated proxy endpoint of the instance.

    		test123456.rwlb.rds.aliyuncs.com
    DbProxySslEnabledstringYes

    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.
    		1
    DBProxyEngineTypestringNo

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

    		normal

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    		BF46A62B-3717-4397-9338-36BB95C898B3

    Examples

    Sample success responses

    JSONformat

    {
  "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.
    400MaxscaleNotSupportCurrent custins can not support Maxscale.This operation is not supported for instances with maxscale.
    403RDSCategoryNotSupportThe specified instance category does not support this operation.-
    403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
    403IncorrectKindCodeCurrent custins kindCode does not support this operation.The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
    403IncorrectDBInstanceTypeCurrent DB instance engine and type does not support operations.The operation failed. The operation is not supported for the database engine of the RDS instance.
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    403ConnectionStringLengthExceededConnection String is too long.The endpoint is exceedingly long. Modify the endpoint and try again.
    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.
    404InvalidDBInstanceName.NotFoundThe database instance does not exist.The name of the RDS instance cannot be found. Check the name of the RDS instance.
    404EndpointType.NotFoundThe specified endpoint type is not found.The operation failed. Unknown types of proxy terminals are detected.
    404EndpointConfig.InvalidPlease check the endpoint config parameter.Please check the endpoint configuration parameter.
    404InvalidMaxscaleConnectionString.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
    2023-12-19API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 403 change
      Error Codes 404 change
    2022-06-23API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    2022-06-08The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: DBProxyEngineType