All Products
Search

This Product

    ApsaraDB RDS:ModifyDBProxyEndpointAddress

    Document Center

    ApsaraDB RDS:ModifyDBProxyEndpointAddress

    Last Updated:Nov 30, 2023

    Changes an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance.

    Operation Description

    Supported database engines

    • MySQL
    • PostgreSQL

    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.

    debugging

    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.

    debugging

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

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

    		rm-t4n3a****
    DBProxyEndpointIdstringYes

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

    		ta9um4****
    DBProxyNewConnectStringstringNo

    The new prefix of the proxy endpoint. Enter a prefix.

    Note You must specify at least one of the DBProxyNewConnectString and DBProxyNewConnectStringPort parameters.
    		test123456
    DBProxyNewConnectStringPortstringNo

    The port number that is associated with the proxy endpoint. Enter a port number.

    Note You must specify at least one of the DBProxyNewConnectString and DBProxyNewConnectStringPort parameters.
    		3307
    DBProxyConnectStringNetTypestringNo

    The network type of the proxy endpoint. Valid values:

    • Public: Internet
    • VPC: virtual private cloud (VPC)
    • Classic: classic network

    If the instance runs MySQL, the default value of this parameter is Classic.

    Note If the instance runs PostgreSQL, you must set this parameter to Public or VPC.
    		Public
    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.

    		50F6C32B-DD73-4DA1-ADA2-0EAF2B0FCD8A

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "50F6C32B-DD73-4DA1-ADA2-0EAF2B0FCD8A"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidConnectionString.FormatSpecified connection string is not valid.The endpoint of the RDS instance is invalid. The prefix of the endpoint must be 5 to 40 characters in length.
    400InvalidPort.MalformedSpecified port is not valid.The port number is invalid.
    400InvalidConnectionString.DuplicateSpecified connection string already exists in the Aliyun RDS.The endpoint is duplicate. Specify a different endpoint.
    400InvalidConnectionStringOrPort.DuplicateSpecified connection string or port want to be modified is the same with current net type.The endpoint or the port number is duplicate. Modify the endpoint or the port number.
    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.
    400OtherEndpoint.ExistOther endpoint already exist.-
    403ParameterLeastAssociateMust input at least one optional parameter.The point in time or the data backup file cannot be left unspecified. Specify a point in time or a data backup file and try again.
    403NetTypeChangeTimesExceededExceeding the daily net type change times of the DB instance.-
    404InvalidConnectionString.NotFoundSpecified connection string or net type is not found.The endpoint cannot be found. Check the endpoint.
    404InsufficientResourceCapacityThere is insufficient capacity available for the requested instance.-
    404Endpoint.NotFoundSpecified endpoint is not found.The port that is associated with the dedicated proxy endpoint cannot be found.

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

    Change history

    Change timeSummary of changesOperation
    2023-09-08The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      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