All Products
Search

This Product

    ApsaraDB RDS:DescribeDBProxyEndpoint

    Document Center

    ApsaraDB RDS:DescribeDBProxyEndpoint

    Last Updated:Apr 24, 2025

    Queries the information about the database proxy endpoints of an instance.

    Operation description

    Supported database engines

    • RDS MySQL
    • RDS PostgreSQL

    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:
      • For mandatory resource types, indicate with a prefix of * .
      • 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:DescribeDBProxyEndpointget
    *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-bp1ja4f56s7us****
    DBProxyEndpointIdstringNo

    The name of the proxy terminal. You can call the DescribeDBProxy interface to query the name of the proxy terminal.

    		keaxncrjluwu0gue****
    DBProxyConnectStringstringNo

    The proxy endpoint that you want to query. You can call the DescribeDBProxy interface to query the proxy endpoint.

    		testproxy****.rwlb.rds.aliyuncs.com
    RegionIdstringYes

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

    		cn-hangzhou
    DBProxyEngineTypestringNo

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

    		normal

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    DBProxyConnectStringstring

    The proxy endpoint queried.

    		testproxy****.rwlb.rds.aliyuncs.com
    DBProxyConnectStringNetTypestring

    The network type of the proxy endpoint. Valid values:

    • InnerString: internal network
    • OuterString: Internet
    		InnerString
    DBProxyConnectStringPortstring

    The port number that is associated with the proxy endpoint.

    		3306
    DBProxyEndpointIdstring

    The ID of the proxy endpoint.

    		keaxncrjluwu0gue****
    DBProxyEngineTypestring

    An internal parameter. You can ignore this parameter.

    		normal
    DBProxyFeaturesstring

    The configuration of the proxy terminal. The value of this parameter is a JSON string that consists of the following parameters:

    • TransactionReadSqlRouteOptimizeStatus: the status of the transaction splitting feature. Valid values: 0 and 1. The value 0 indicates that the feature is disabled. The value 1 indicates that the feature is enabled.
    • ConnectionPersist: the status of the connection pooling feature. Valid values: 0, 1, and 2. The value 0 indicates that the connection pooling feature is disabled. The value 1 indicates that the session-level connection pooling feature is enabled. The value 2 indicates that the transaction-level connection pooling feature is enabled.
    • ReadWriteSpliting: the status of the read/write splitting feature. Valid values: 0 and 1. The value 0 indicates that the feature is disabled. The value 1 indicates that the feature is enabled.
    • AZProximityAccess: the status of the nearest access feature. Valid values: 0 and 1. The value 0 indicates that the feature is disabled. The value 1 indicates that the feature is enabled.
    • CausalConsistRead: the read consistency settings. Valid values: 0, 1, and 2. The value 0 indicates eventual consistency. The value 1 indicates session consistency. The value 2 indicates global consistency.
    • PinPreparedStmt: an internal parameter that is available only for ApsaraDB RDS for PostgrSQL instances.
    Note If the instance runs PostgreSQL, you can change only the value of the ReadWriteSpliting field. The TransactionReadSqlRouteOptimizeStatus and PinPreparedStmt fields are set to their default values 1.
    		TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
    DBProxyNodesarray<object>

    The proxy nodes that are associated with the proxy terminal.

    DBProxyNodesobject

    The details of the proxy node.

    cpuCoresstring

    The number of CPU cores of the node.

    		2
    nodeIdstring

    The ID of the node in the zone.

    		pn-xxxxxxx01
    zoneIdstring

    The zone ID of the node.

    		cn-hangzhou-c
    DbProxyEndpointAliasesstring

    The description of the proxy terminal.

    		proxyterminal-test
    DbProxyEndpointReadWriteModestring

    The read and write attributes of the proxy terminal. Valid values:

    • ReadWrite: The proxy terminal supports read and write requests.
    • ReadOnly: The proxy terminal supports only read requests.
    		ReadWrite
    DbProxyEndpointVswitchIdstring

    The vSwitch ID of the proxy terminal.

    		vsw-****
    DbProxyEndpointVpcIdstring

    The virtual private cloud (VPC) ID of the proxy.

    		vpc-****
    DbProxyEndpointZoneIdstring

    The zone ID of the proxy terminal.

    		cn-hangzhou-c
    EndpointConnectItemsarray<object>

    An array that consists of the information about the proxy endpoint.

    EndpointConnectItemsobject
    DbProxyEndpointConnectStringstring

    The proxy endpoint queried.

    		testproxy****.rwlb.rds.aliyuncs.com
    DbProxyEndpointNetTypestring

    The network type of the instance. Valid values:

    • 0: Internet
    • 1: classic network
    • 2: virtual private cloud (VPC)
    		2
    DbProxyEndpointPortstring

    The port number that is associated with the proxy endpoint. Default value: 3306.

    		3306
    ReadOnlyInstanceDistributionTypestring

    The method that is used to assign read weights. For more information, see Modify the latency threshold and read weights of ApsaraDB RDS for MySQL instances. Valid values:

    • Standard: The system automatically assigns read weights to the instance and its read-only instances based on the specifications of these instances.
    • Custom: You must manually assign read weights to the instance and its read-only instances.
    		Standard
    ReadOnlyInstanceMaxDelayTimestring

    The latency threshold that is allowed for read/write splitting. If the latency on a read-only instance exceeds the specified threshold, ApsaraDB RDS no longer forwards read requests to the read-only instance.

    		30
    CausalConsistReadTimeoutstring

    The consistency read timeout period. Unit: milliseconds. Default value: 10 Unit: milliseconds. Valid values: 0 to 60000

    		10
    ReadOnlyInstanceWeightstring

    The read weights of the instance and its read-only instances. The value of this parameter is a JSON string that consists of the following parameters:

    • DBInstanceId: the ID of the instance.
    • DBInstanceType: the role of the instance. Valid values: Master and ReadOnly.
    • NodeID: The IDs of the primary and secondary nodes of the cluster. An instance that runs RDS Cluster Edition refers to a cluster.
    • NodeType: The node type. Valid values: Primary and Secondary.
    • Weight: the read weight of the instance. The read weight increases in increments of 100 and cannot exceed 10000.
    		[{\"Availability\":\"Available\",\"DBInstanceId\":\"rr-bp176984qewd8****\",\"DBInstanceType\":\"ReadOnly\",\"Weight\":400},{\"Availability\":\"Available\",\"DBInstanceId\":\"rm-bp1ja4f56s7us****\",\"DBInstanceType\":\"Master\",\"Weight\":0}]
    RequestIdstring

    The request ID.

    		847BA085-B377-4BFA-8267-F82345ECE1D2
    DBProxyEndpointMinSlaveCountstring

    The minimum number of reserved instances.

    		2

    Examples

    Sample success responses

    JSONformat

    {
  "DBProxyConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
  "DBProxyConnectStringNetType": "InnerString",
  "DBProxyConnectStringPort": 3306,
  "DBProxyEndpointId": "keaxncrjluwu0gue****",
  "DBProxyEngineType": "normal",
  "DBProxyFeatures": "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1",
  "DBProxyNodes": {
    "DBProxyNodes": [
      {
        "cpuCores": 2,
        "nodeId": "pn-xxxxxxx01",
        "zoneId": "cn-hangzhou-c"
      }
    ]
  },
  "DbProxyEndpointAliases": "proxyterminal-test",
  "DbProxyEndpointReadWriteMode": "ReadWrite",
  "DbProxyEndpointVswitchId": "vsw-****",
  "DbProxyEndpointVpcId": "vpc-****",
  "DbProxyEndpointZoneId": "cn-hangzhou-c",
  "EndpointConnectItems": {
    "EndpointConnectItems": [
      {
        "DbProxyEndpointConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
        "DbProxyEndpointNetType": 2,
        "DbProxyEndpointPort": 3306
      }
    ]
  },
  "ReadOnlyInstanceDistributionType": "Standard",
  "ReadOnlyInstanceMaxDelayTime": 30,
  "CausalConsistReadTimeout": 10,
  "ReadOnlyInstanceWeight": "[{\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rr-bp176984qewd8****\\\",\\\"DBInstanceType\\\":\\\"ReadOnly\\\",\\\"Weight\\\":400},{\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-bp1ja4f56s7us****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"Weight\\\":0}]",
  "RequestId": "847BA085-B377-4BFA-8267-F82345ECE1D2",
  "DBProxyEndpointMinSlaveCount": 2
}

    Error codes

    HTTP status codeError codeError messageDescription
    400MaxscaleNotSupportCurrent custins can not support Maxscale.This operation is not supported for instances with maxscale.
    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.
    400Endpoint.NotFoundThe specified EndPoint is not valid.The specified proxy terminal does not exist.
    400InvalidParameterThe specified parameter is invalid.The values of some parameters are invalid.
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
    400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
    400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
    400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
    400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Hello customer, this area has been abolished.
    400Price.CommoditySysCommodity system call exception.Commodity system call exception.
    400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
    400pay.noCreditCardAccount not bound to credit card.-
    400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
    400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.No payment method has been specified for your account. We recommend that you add a payment method.
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
    400Api.NotSupportSpecified api is not supported.The current interface does not support.
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
    400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
    400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
    400KmsApiErrorUser secret key invalid.The user key is invalid.
    400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
    400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
    400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.SQL command execution failed or timed out
    400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.The current instance engine version not support coldDataEnabled.
    400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.The current instance minor version not support coldDataEnabled.
    400IncorrectTargetClasscodeThe current instance type does not support this operation.This operation is not supported by the instance type.
    400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.The link address name is duplicate. Please reset the connection string.
    400RequiredParam.NotFoundRequired input param is not found.-
    400Parameters.InvalidParameter error, please check the parameters.Parameter error, please check the parameters.
    400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
    400InvalideStatus.FormatThe instance status does not support this operation.-
    400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.Specified Released Keep Policy is not valid.
    400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
    400Pay.NoCreditCardNo credit cards.No credit cards.
    400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.The vpc network type instance does not support this operation.
    400MirrorInsExistsSpecified DB instance mirror ins already existed.Specified DB instance mirror ins already existed.
    400UnsupportedClassCodeThe specified DB instance class stops selling.The specified DB instance class stops selling.
    400InvalidBackupSetThe specified database does not exist in the backup set.The specified database does not exist in the backup set.
    400OrdTCommodityQueryErrorFailed to query for product.Failed to query product.
    400ProductInstanceReleasedThe instance has been released. Please check before placing the order.The instance has been released, please verify and place an order.
    400RegionEndTimeDissolvedIndiaThe region is no longer supported.The region is no longer supported.
    403IncorrectKindCodeThe current KindCode of the custins does not support the operation.-
    403IncorrectDBInstanceTypeThe current database instance type does not support the operation.This operation is not supported for the database engine of the current instance.
    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.
    403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
    403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
    403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
    403InvalidVswitchIdSpecified conn vswitch id is not valid.-
    403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
    403OperationDenied.ZoneResourceThere is no available zone for inventory.There is no available zone for inventory.
    403NotInFlowControllerSorry,no permission.Sorry,no permission.
    403InvalidKmsKeyKms key is disabled.-
    403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.The specified database instance type does not support this operation.
    403InvalidVpcInfo.NotFoundSpecified VPC info does not exist.The specified VPC does not exist.
    404Endpoint.NotFoundSpecified endpoint is not found.The port that is associated with the dedicated proxy endpoint cannot be found.
    404Maxscale.NotFoundThe relative maxscale instance is not found.No associated maxscale instance is found.
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
    404Request.NotFoundThe requested resource is not available.The requested resources are unavailable.
    404HostInfo.NotFoundThe specified host info is not found.-
    500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.
    500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.The service request failed. Please try again later or contact service personnel.
    500InvokeProxyFailureThe request processing has failed due to service failure of rds api.The request failed to be processed due to an RDS API failure.

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

    Change history

    Change timeSummary of changesOperation
    2025-02-27The Error code has changed. The response structure of the API has changedView Change Details
    2024-11-27The Error code has changed. The response structure of the API has changedView Change Details
    2024-10-31The Error code has changedView Change Details
    2024-10-15The Error code has changed. The response structure of the API has changedView Change Details
    2024-01-22The Error code has changedView Change Details
    2023-12-19The Error code has changedView Change Details
    2022-09-01The Error code has changedView Change Details
    2022-06-08The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details