DescribeDBProxyEndpoint - 查询数据库代理的连接地址信息 - 云数据库 RDS

该接口用于查询RDS实例数据库代理的连接地址信息。

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeDBProxyEndpoint	get	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。可调用 DescribeDBInstances 获取。	rm-bp1ja4f56s7us****
DBProxyEndpointId	string	否	代理终端名称。可调用 DescribeDBProxy 接口查询。	keaxncrjluwu0gue****
DBProxyConnectString	string	否	代理连接地址。可调用 DescribeDBProxy 接口查询。	testproxy****.rwlb.rds.aliyuncs.com
RegionId	string	是	地域 ID。可调用 DescribeRegions 获取。	cn-hangzhou
DBProxyEngineType	string	否	预留参数，无需配置。	normal

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
DBProxyConnectString	string	代理连接地址。	testproxy****.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetType	string	代理连接地址的网络类型，取值： InnerString：内网地址。 OuterString：外网地址。	InnerString
DBProxyConnectStringPort	string	代理连接地址端口。	3306
DBProxyEndpointId	string	代理连接地址 ID。	keaxncrjluwu0gue****
DBProxyEngineType	string	内部参数，无需关注。	normal
DBProxyFeatures	string	代理终端的设置信息，格式为 JSON，包含下述参数： TransactionReadSqlRouteOptimizeStatus：事务拆分设置，取值为 0（关闭）或 1（开启）。 ConnectionPersist：连接池设置：取值为 0（关闭）、1（会话级连接池）或 2（事务级连接池）。 ReadWriteSpliting：读写分离设置，取值为 0（关闭）或 1（开启）。 AZProximityAccess：就近访问，取值为 0（关闭）或 1（开启）。 PinPreparedStmt：仅 RDS PostgrSQL 可见，内部参数。说明 RDS PostgreSQL 仅支持修改 ReadWriteSpliting，TransactionReadSqlRouteOptimizeStatus 和 PinPreparedStmt 默认为 1。	TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
DBProxyNodes	array<object>	代理终端下关联的代理节点列表。
DBProxyNodes	object	代理节点详情。
cpuCores	string	节点 CPU 核数。	2
nodeId	string	可用区中代理节点 ID。	pn-xxxxxxx01
zoneId	string	节点所在的可用区 ID。	cn-hangzhou-c
DbProxyEndpointAliases	string	代理终端的备注信息。	proxyterminal-test
DbProxyEndpointReadWriteMode	string	代理终端的读写类型，取值： ReadWrite：读写模式。 ReadOnly：只读模式。	ReadWrite
DbProxyEndpointVswitchId	string	代理终端的交换机 ID。	vsw-****
DbProxyEndpointZoneId	string	代理终端的可用区信息。	cn-hangzhou-c
EndpointConnectItems	array<object>	代理连接地址的详细信息列表。
EndpointConnectItems	object	代理连接地址的详细信息
DbProxyEndpointConnectString	string	代理连接地址。	testproxy****.rwlb.rds.aliyuncs.com
DbProxyEndpointNetType	string	网络类型，取值： 0：公网 1：经典网络 2：专有网络	2
DbProxyEndpointPort	string	服务端口，默认为 3306。	3306
ReadOnlyInstanceDistributionType	string	读权重分配模式，详情请参见读权重分配。取值： Standard：按规格权重自动分配。 Custom：自定义分配权重。	Standard
ReadOnlyInstanceMaxDelayTime	string	读写分离的延迟阈值，当只读实例延迟时间超过该阈值时，读取流量不发往该实例，单位：秒。	30
ReadOnlyInstanceWeight	string	读权重分配信息，即传入主实例和只读实例的读请求权重，格式为 JSON，包含下述参数： DBInstanceId：实例 ID。 DBInstanceType：实例类型，取值为 Master（主实例）或 ReadOnly（只读实例）。 NodeID：集群系列中主实例主节点和备节点的节点 ID。 NodeType：集群系列中的节点类型，取值为 Primary（主实例-主节点）或 Secondary（主实例-备节点）。 Weight：读请求权重，以 100 递增，最大值为 10000。	[{\"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}]]
RequestId	string	请求 ID。	847BA085-B377-4BFA-8267-F82345ECE1D2

示例

正常返回示例

JSON格式

{
  "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-****",
  "DbProxyEndpointZoneId": "cn-hangzhou-c",
  "EndpointConnectItems": {
    "EndpointConnectItems": [
      {
        "DbProxyEndpointConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
        "DbProxyEndpointNetType": "2",
        "DbProxyEndpointPort": "3306"
      }
    ]
  },
  "ReadOnlyInstanceDistributionType": "Standard",
  "ReadOnlyInstanceMaxDelayTime": "30",
  "ReadOnlyInstanceWeight": "[{\\\"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}]]",
  "RequestId": "847BA085-B377-4BFA-8267-F82345ECE1D2"
}

错误码

HTTP status code	错误码	错误信息	描述
400	MaxscaleNotSupport	Current custins can not support Maxscale.	带有maxscale的实例不支持此操作。
400	InvalidEndPoint.Format	The specified EndPoint is not valid.	独享代理连接地址ID（DBProxyEndpointId）未传，查询不存在，请检查Endpoint参数。
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	指定的实例名称（DBInstanceName）无效，请检查参数值是否为null或空字符串。
400	Endpoint.NotFound	The specified EndPoint is not valid.	指定的代理终端不存在
400	InvalidParameter	The specified parameter is invalid.	参数无效。
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	套餐实例不允许单独操作。
400	Price.PricingPlanResultNotFound	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.	您还未通过实名认证，不符合购买条件，请登录费用与成本进行实名认证。
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	您的账户可用额度小于0，请先充值后再尝试购买。
400	CommodityServiceCalling.Exception	Failed to call commodity service.	调用商品服务返回失败。
400	RegionDissolvedEOM	Dear 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.	客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	您购买的模块不合法，请重新购买。
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
400	Price.CommoditySys	Commodity system call exception.	商品系统调用异常。
400	Pay.InsufficientBalance	Insufficient available balance.	可用金不足。
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	您选购的周期有问题，请重新选购。
400	pay.noCreditCard	Account not bound to credit card.	账户未绑定信用卡。
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	您选购的服务存在未支付订单，请支付或作废后再下单。
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	您的基本信息未完善，请在操作前先完善您的基本信息。
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	您的账户出现异常，详情请联系客服。
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	您的信息不完整，请在操作前填写您的信息。
400	Api.NotSupport	Specified api is not supported.	当前接口不支持。
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	存在禁止下单的标签，请联系您的分销商处理
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	提供的DBInstanceId不存在。
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	当前实例规格不支持该存储类型。
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为replica。
400	KmsApiError	User secret key invalid.	用户密钥失效。
400	System.SaleValidateFailed	Sales expression validation system error.	销售表达式校验系统错误。
400	Abs.InvalidAccount.NotFound	account is not found.	账户不存在。
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	sql命令执行失败或执行超时
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	当前实例引擎版本不支持归档冷数据。
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	当前内核版本不支持归档冷数据。
400	IncorrectTargetClasscode	The current instance type does not support this operation.	当前规格不支持此操作。
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	链接地址名重复，请重新设置连接字符串。
400	RequiredParam.NotFound	Required input param is not found.	没有传入必要的参数。
400	Parameters.Invalid	Parameter error, please check the parameters.	参数错误，请检查参数。
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	数据归档不支持跨地域备份和秒级快照，请检查备份策略。
400	InvalideStatus.Format	The instance status does not support this operation.	实例状态不支持此操作。
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	实例释放后的归档备份保留策略无效。
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	DB实例引擎类型不支持此操作。
400	Pay.NoCreditCard	No credit cards.	无信用卡。
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	vpc网络类型实例不支持此操作。
400	MirrorInsExists	Specified DB instance mirror ins already existed.	当前数据库实例镜像已存在。
400	UnsupportedClassCode	The specified DB instance class stops selling.	实例规格停止售卖。
400	InvalidBackupSet	The specified database does not exist in the backup set.	备份集中没有指定的数据库。
400	OrdTCommodityQueryError	Failed to query for product.	查询产品失败。
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	实例已释放，请核实后下单。
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	指定的地域无效。
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.	当前数据库实例类型不支持此操作。
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	操作失败，数据库引擎不支持。
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	实例当前存在未支付订单，请支付后重试。
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	缩容目标容量不能小于当前存储空间使用量
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	SSD盘不支持此操作，请升级至ESSD。
403	InvalidUserOperatorPermission	The user permission does not support this operation.	用户权限不支持此操作。
403	InvalidVswitchId	Specified conn vswitch id is not valid.	指定的VSwitchId格式不正确或为空
403	IncorrectMinorVersion	Current engine minor version does not support operations.	当前引擎小版本不支持此操作。
403	OperationDenied.ZoneResource	There is no available zone for inventory.	没有可用的库存区域。
403	NotInFlowController	Sorry,no permission.	非集团上云用户不可用，无权限。
403	InvalidKmsKey	Kms key is disabled.	Kms key已禁用。
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	当前数据库实例级别不支持此操作。
403	InvalidVpcInfo.NotFound	Specified VPC info does not exist.	指定的VPC信息不存在。
404	Endpoint.NotFound	Specified endpoint is not found.	未找到指定独享代理连接地址的端口。
404	Maxscale.NotFound	The relative maxscale instance is not found.	操作失败，未找到关联的maxscale实例。
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	当前实例未授权访问密钥管理服务。
404	Request.NotFound	The requested resource is not available.	请求的资源不可用。
404	HostInfo.NotFound	The specified host info is not found.	指定的主机信息不存在。
500	ExternalFailure	The request processing has failed due to external service failure.	请求服务失败，请稍后重试。
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	请求服务失败，请稍后再试或联系服务人员。
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	由于rds api服务失败，请求处理失败。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-31	OpenAPI 错误码发生变更	查看变更详情
2024-10-15	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-01-22	OpenAPI 错误码发生变更	查看变更详情
2023-12-19	OpenAPI 错误码发生变更	查看变更详情
2022-09-01	OpenAPI 错误码发生变更	查看变更详情
2022-06-08	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情