All Products
Search

This Product

    ApsaraDB RDS:DeleteDBProxyEndpointAddress

    Document Center

    ApsaraDB RDS:DeleteDBProxyEndpointAddress

    Last Updated:Dec 05, 2024

    Deletes the endpoint that is used to connect to the dedicated proxy of an instance.

    Operation description

    Supported database engines

    • MySQL
    • PostgreSQL

    References

    Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling 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.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    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-t4n3a****
    DBProxyEndpointIdstringYes

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

    		ta9um4****
    DBProxyConnectStringNetTypestringYes

    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.

    		343356C6-64B2-4245-ADEB-C9BD165EDD11

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "343356C6-64B2-4245-ADEB-C9BD165EDD11"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidVpcInstanceIdSpecified vpc instance id is not valid.The specified VPC ID is invalid.
    400IncorrectDBInstanceNetTypeCurrent DB instance net type does not support this operation.The operation failed. The operation is not supported for the network type of the RDS instance.
    400AtLeastOneNetTypeExistsThe current database instance network type does not support the operationThe operation failed. The operation is not supported for the network type of the RDS instance.
    400InvalidEndPoint.FormatThe specified EndPoint is not valid.-
    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.
    403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    403IncorrectKindCodeThe current KindCode of the custins does not support the 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.
    404Endpoint.NotFoundSpecified endpoint is not found.The port that is associated with the dedicated 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.
    404Maxscale.NotFoundThe related maxscale instance is not found.The operation failed. No associated MaxScale instances can be found.
    404InvalidDBInstanceNetType.NotFoundSpecified DB instance net type is not found.The operation failed. The network type of the RDS instance is invalid. Specify a valid network type.

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

    Change history

    Change timeSummary of changesOperation
    2023-12-19The Error code has changedView Change Details
    2022-06-08The Error code has changed. The request parameters of the API has changedView Change Details