调用DescribeDBProxyEndpoint接口查询RDS实例数据库代理的连接地址信息。
已调用ModifyDBProxy接口开通数据库代理。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBProxyEndpoint |
系统规定参数。取值:DescribeDBProxyEndpoint。 |
DBInstanceId | String | 是 | rm-bp1ja4f56s7us**** |
RDS实例ID。可调用DescribeDBInstances接口查询。 |
DBProxyEndpointId | String | 否 | keaxncrjluwu0gue**** |
代理终端名称。可调用DescribeDBProxy接口查询。 |
DBProxyConnectString | String | 否 | testproxy****.rwlb.rds.aliyuncs.com |
代理连接地址。可调用DescribeDBProxy接口查询。 |
RegionId | String | 是 | cn-hangzhou |
地域ID,可以通过接口DescribeRegions查看地域ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBProxyConnectStringNetType | String | InnerString |
代理连接地址的网络类型,取值:
|
DBProxyFeatures | String | TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1 |
代理终端的设置信息,格式为JSON,包含下述参数:
|
RequestId | String | 847BA085-B377-4BFA-8267-F82345ECE1D2 |
请求ID。 |
ReadOnlyInstanceWeight | String | [{\"Availability\":\"Available\",\"DBInstanceId\":\"rr-bp176984qewd8****\",\"DBInstanceType\":\"ReadOnly\",\"Weight\":400},{\"Availability\":\"Available\",\"DBInstanceId\":\"rm-bp1ja4f56s7us****\",\"DBInstanceType\":\"Master\",\"Weight\":0}] |
读权重分配信息,即传入主实例和只读实例的读请求权重,格式为JSON,包含下述参数:
说明 如果该实例下没有只读实例,本参数返回null。
|
ReadOnlyInstanceDistributionType | String | Standard |
读权重分配模式,详情请参见读权重分配。取值:
|
ReadOnlyInstanceMaxDelayTime | String | 30 |
读写分离的延迟阈值,当只读实例延迟时间超过该阈值时,读取流量不发往该实例,单位:秒。 |
DbProxyEndpointReadWriteMode | String | ReadWrite |
代理终端的读写类型,取值:
|
DbProxyEndpointAliases | String | proxyterminal-test |
代理终端的备注信息。 |
DBProxyEndpointId | String | keaxncrjluwu0gue**** |
代理连接地址ID。 |
DBProxyConnectStringPort | String | 3306 |
代理连接地址端口。 |
DBProxyConnectString | String | testproxy****.rwlb.rds.aliyuncs.com |
代理连接地址。 |
EndpointConnectItems | Array of EndpointConnectItems |
代理连接地址的详细信息列表。 |
|
EndpointConnectItems | |||
DbProxyEndpointPort | String | 3306 |
服务端口,默认为3306。 |
DbProxyEndpointConnectString | String | testproxy****.rwlb.rds.aliyuncs.com |
代理连接地址。 |
DbProxyEndpointNetType | String | 2 |
网络类型,取值:
|
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeDBProxyEndpoint
&DBInstanceId=rm-bp1ja4f56s7us****
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBProxyEndpointResponse>
<DbProxyEndpointReadWriteMode>ReadWrite</DbProxyEndpointReadWriteMode>
<ReadOnlyInstanceDistributionType>Standard</ReadOnlyInstanceDistributionType>
<DBProxyConnectString>testproxy****.rwlb.rds.aliyuncs.com</DBProxyConnectString>
<RequestId>336E33D5-8C02-4265-9627-704BF9F3954B</RequestId>
<DBProxyEndpointId>keaxncrjluwu0guehzae</DBProxyEndpointId>
<DbProxyEndpointAliases>proxyterminal-test</DbProxyEndpointAliases>
<DBProxyFeatures>TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1;PinPreparedStmt:0</DBProxyFeatures>
<ReadOnlyInstanceWeight>[{"Availability":"Available","DBInstanceId":"rr-bp176984qewd8****","DBInstanceType":"ReadOnly","Weight":400},{"Availability":"Available","DBInstanceId":"rm-bp1ja4f56s7us****","DBInstanceType":"Master","Weight":0}]</ReadOnlyInstanceWeight>
<ReadOnlyInstanceMaxDelayTime>30</ReadOnlyInstanceMaxDelayTime>
<DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
<EndpointConnectItems>
<EndpointConnectItems>
<DbProxyEndpointNetType>2</DbProxyEndpointNetType>
<DbProxyEndpointPort>3306</DbProxyEndpointPort>
<DbProxyEndpointConnectString>testproxy****.rwlb.rds.aliyuncs.com</DbProxyEndpointConnectString>
</EndpointConnectItems>
<EndpointConnectItems>
<DbProxyEndpointNetType>0</DbProxyEndpointNetType>
<DbProxyEndpointPort>3306</DbProxyEndpointPort>
<DbProxyEndpointConnectString>test****.rwlb.rds.aliyuncs.com</DbProxyEndpointConnectString>
</EndpointConnectItems>
</EndpointConnectItems>
<DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
</DescribeDBProxyEndpointResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"DbProxyEndpointReadWriteMode" : "ReadWrite",
"ReadOnlyInstanceDistributionType" : "Standard",
"DBProxyConnectString" : "testproxy****.rwlb.rds.aliyuncs.com",
"RequestId" : "336E33D5-8C02-4265-9627-704BF9F3954B",
"DBProxyEndpointId" : "keaxncrjluwu0guehzae",
"DbProxyEndpointAliases" : "proxyterminal-test",
"DBProxyFeatures" : "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1;PinPreparedStmt:0",
"ReadOnlyInstanceWeight" : "[{\"Availability\":\"Available\",\"DBInstanceId\":\"rr-bp176984qewd8****\",\"DBInstanceType\":\"ReadOnly\",\"Weight\":400},{\"Availability\":\"Available\",\"DBInstanceId\":\"rm-bp1ja4f56s7us****\",\"DBInstanceType\":\"Master\",\"Weight\":0}]",
"ReadOnlyInstanceMaxDelayTime" : "30",
"DBProxyConnectStringNetType" : "InnerString",
"EndpointConnectItems" : {
"EndpointConnectItems" : [ {
"DbProxyEndpointNetType" : "2",
"DbProxyEndpointPort" : "3306",
"DbProxyEndpointConnectString" : "testproxy****.rwlb.rds.aliyuncs.com"
}, {
"DbProxyEndpointNetType" : "0",
"DbProxyEndpointPort" : "3306",
"DbProxyEndpointConnectString" : "test****.rwlb.rds.aliyuncs.com"
} ]
},
"DBProxyConnectStringPort" : "3306"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidEndPoint.Format | The specified EndPoint is not valid. | 独享代理连接地址ID(DBProxyEndpointId)未传,查询不存在, 请检查Endpoint参数。 |
400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | 指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。 |
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. | 当前数据库实例类型不支持此操作。 |
404 | Endpoint.NotFound | Specified endpoint is not found. | 未找到指定独享代理连接地址的端口。 |
访问错误中心查看更多错误码。