All Products
Search
Document Center

ApsaraDB RDS:DescribeDBProxyEndpoint

Last Updated:May 11, 2024

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

Operation description

Supported database engines

  • RDS MySQL
  • RDS PostgreSQL

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:DescribeDBProxyEndpointREAD
  • 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.

DBProxyConnectStringNetTypestring

The network type of the proxy endpoint. Valid values:

  • InnerString: internal network
  • OuterString: Internet
InnerString
DBProxyFeaturesstring

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

  • 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 connection pooling feature is enabled. The value 2 indicates that the transaction 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.
  • PinPreparedStmt: an internal field that is available only for ApsaraDB RDS for PostgreSQL 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
RequestIdstring

The request ID.

847BA085-B377-4BFA-8267-F82345ECE1D2
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}]
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
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
DbProxyEndpointAliasesstring

The description of the proxy terminal.

proxyterminal-test
DBProxyEndpointIdstring

The ID of the proxy endpoint.

keaxncrjluwu0gue****
DBProxyConnectStringPortstring

The port number that is associated with the proxy endpoint.

3306
DBProxyConnectStringstring

The proxy endpoint queried.

testproxy****.rwlb.rds.aliyuncs.com
DBProxyEngineTypestring

An internal parameter. You can ignore this parameter.

normal
EndpointConnectItemsobject []

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

DbProxyEndpointPortstring

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

3306
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

Examples

Sample success responses

JSONformat

{
  "DBProxyConnectStringNetType": "InnerString",
  "DBProxyFeatures": "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1",
  "RequestId": "847BA085-B377-4BFA-8267-F82345ECE1D2",
  "ReadOnlyInstanceWeight": "[{\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rr-bp176984qewd8****\\\",\\\"DBInstanceType\\\":\\\"ReadOnly\\\",\\\"Weight\\\":400},{\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-bp1ja4f56s7us****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"Weight\\\":0}]",
  "ReadOnlyInstanceDistributionType": "Standard",
  "ReadOnlyInstanceMaxDelayTime": "30",
  "DbProxyEndpointReadWriteMode": "ReadWrite",
  "DbProxyEndpointAliases": "proxyterminal-test",
  "DBProxyEndpointId": "keaxncrjluwu0gue****",
  "DBProxyConnectStringPort": "3306",
  "DBProxyConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
  "DBProxyEngineType": "normal",
  "EndpointConnectItems": {
    "EndpointConnectItems": [
      {
        "DbProxyEndpointPort": "3306",
        "DbProxyEndpointConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
        "DbProxyEndpointNetType": "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 user center for real-name authentication.
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.
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.

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

Change history

Change timeSummary of changesOperation
2024-01-22The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 404 change
    delete Error Codes: 400
    delete Error Codes: 403
2023-12-19The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Error Codes 403 change
    delete Error Codes: 404
2022-09-01The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403
    delete Error Codes: 404
2022-06-08The Error code has changed. The request parameters of the API has changed. The response structure 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
Output ParametersThe response structure of the API has changed.