DescribeDBProxyEndpoint_云数据库 RDS_API文档

2014-08-15不推荐

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称	字段详情
DBInstanceIdstring	实例 ID。可调用 DescribeDBInstances 获取。示例值:rm-bp1ja4f56s7us****参考取值来源: CloneDBInstance CreateDBInstance ReceiveDBInstance ModifyDBInstanceSpec RecoveryDBInstance DescribeDBInstances CalculateDBInstanceWeight MigrateDBNodes UpgradeDBInstanceMajorVersion TransformDBInstancePayType EvaluateLocalExtendDisk RestoreDdrTable RebuildReplicationLink
DBProxyEndpointIdstring	代理终端名称。可调用 DescribeDBProxy 接口查询。示例值:keaxncrjluwu0gue****参考取值来源: CreateDBProxyEndpointAddress DescribeDBProxy
DBProxyConnectStringstring	代理连接地址。可调用 DescribeDBProxy 接口查询。示例值:testproxy****.rwlb.rds.aliyuncs.com参考取值来源: CreateDBProxyEndpointAddress DescribeDBProxy
RegionIdstring	地域 ID。可调用 DescribeRegions 获取。示例值:cn-hangzhou参考取值来源: DescribeRegions
DBProxyEngineTypestring	预留参数，无需配置。示例值:normal参考取值来源: DescribeDBProxy

返回参数

字段名称	字段详情
DBProxyConnectStringstring	代理连接地址。示例值:testproxy****.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetTypestring	代理连接地址的网络类型，取值：展开详情示例值:InnerString
DBProxyConnectStringPortstring	代理连接地址端口。示例值:3306
DBProxyEndpointIdstring	代理连接地址 ID。示例值:keaxncrjluwu0gue****
DBProxyEngineTypestring	内部参数，无需关注。示例值:normal
DBProxyFeaturesstring	代理终端的设置信息，格式为 JSON，包含下述参数：展开详情示例值:TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
DBProxyNodesobject
DbProxyEndpointAliasesstring	代理终端的备注信息。示例值:proxyterminal-test
DbProxyEndpointReadWriteModestring	代理终端的读写类型，取值：展开详情示例值:ReadWrite
DbProxyEndpointVswitchIdstring	代理终端的交换机 ID。示例值:vsw-****
DbProxyEndpointVpcIdstring	代理终端的 VPC ID 示例值:vpc-****
DbProxyEndpointZoneIdstring	代理终端的可用区信息。示例值:cn-hangzhou-c
EndpointConnectItemsobject
ReadOnlyInstanceDistributionTypestring	读权重分配模式，详情请参见读权重分配。取值：展开详情示例值:Standard
ReadOnlyInstanceMaxDelayTimestring	读写分离的延迟阈值，当只读实例延迟时间超过该阈值时，读取流量不发往该实例，单位：秒。示例值:30
CausalConsistReadTimeoutstring	一致性读超时时间，单位：毫秒。默认为 10 毫秒，取值：0～60000 示例值:10
ReadOnlyInstanceWeightstring	读权重分配信息，即传入主实例和只读实例的读请求权重，格式为 JSON，包含下述参数：展开详情示例值:[{\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z**\"，\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-t2\",\"NodeType\":\"Primary\",\"Weight\":0}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z\"，\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-z9\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",,\"DBInstanceId\":\"rm-2z\"，\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-1c**\",\"NodeType\":\"Secondary\",\"Weight\":400}]]
RequestIdstring	请求 ID。示例值:847BA085-B377-4BFA-8267-F82345ECE1D2
DBProxyEndpointMinSlaveCountstring	最小保留实例数。示例值:2

返回示例

变更历史

	变更时间	变更内容概要	操作
	2025-02-27	变更返回参数
	2024-11-26	变更返回参数
	2024-10-31	变更错误码403
	2024-10-15	变更返回参数
	2024-01-22	变更错误码404
	2023-12-19	变更错误码400 变更错误码403
	2022-09-01	变更错误码400
	2022-06-08	新增请求参数DBProxyEngineType 变更返回参数
	2022-05-10	变更错误码400

相关示例

DescribeDBProxyEndpoint - 查询RDS实例独享代理的连接地址信息

2022-06-24

2024年08月20日