Queries the information about the database proxy endpoints of an instance.
Operation description
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-bp1ja4f56s7us**** |
DBProxyEndpointId | string | No | The name of the proxy terminal. You can call the DescribeDBProxy interface to query the name of the proxy terminal. | keaxncrjluwu0gue**** |
DBProxyConnectString | string | No | The proxy endpoint that you want to query. You can call the DescribeDBProxy interface to query the proxy endpoint. | testproxy****.rwlb.rds.aliyuncs.com |
RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
DBProxyEngineType | string | No | A reserved parameter. You do not need to specify this parameter. | normal |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 code | Error code | Error message | Description |
---|---|---|---|
400 | MaxscaleNotSupport | Current custins can not support Maxscale. | This operation is not supported for instances with maxscale. |
400 | InvalidEndPoint.Format | The specified EndPoint is not valid. | - |
400 | InvalidDBInstanceName | Specified 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. |
400 | Endpoint.NotFound | The specified EndPoint is not valid. | The specified proxy terminal does not exist. |
400 | InvalidParameter | The specified parameter is invalid. | The values of some parameters are invalid. |
400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | A package instance is not allowed to operate independently. |
400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | Pricing plan price result not found. |
400 | Order.NoRealNameAuthentication | 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. | 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. |
403 | IncorrectKindCode | The current KindCode of the custins does not support the operation. | - |
403 | IncorrectDBInstanceType | The current database instance type does not support the operation. | This operation is not supported for the database engine of the current instance. |
403 | IncorrectDBInstanceEngine | Current 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. |
404 | Endpoint.NotFound | Specified endpoint is not found. | The port that is associated with the dedicated proxy endpoint cannot be found. |
404 | Maxscale.NotFound | The 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 time | Summary of changes | Operation |
---|---|---|
2024-01-22 | The Error code has changed | View Change Details |
2023-12-19 | The Error code has changed | View Change Details |
2022-09-01 | The Error code has changed | View Change Details |
2022-06-08 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |