全部产品
Search
文档中心

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

更新时间:May 22, 2024

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

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeDBProxyEndpointRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

rm-bp1ja4f56s7us****
DBProxyEndpointIdstring

代理终端名称。可调用 DescribeDBProxy 接口查询。

keaxncrjluwu0gue****
DBProxyConnectStringstring

代理连接地址。可调用 DescribeDBProxy 接口查询。

testproxy****.rwlb.rds.aliyuncs.com
RegionIdstring

地域 ID。可调用 DescribeRegions 获取。

cn-hangzhou
DBProxyEngineTypestring

预留参数,无需配置。

normal

返回参数

名称类型描述示例值
object

返回参数详情。

DBProxyConnectStringNetTypestring

代理连接地址的网络类型,取值:

  • InnerString:内网地址。
  • OuterString:外网地址。
InnerString
DBProxyFeaturesstring

代理终端的设置信息,格式为 JSON,包含下述参数:

  • TransactionReadSqlRouteOptimizeStatus:事务拆分设置,取值为 0(关闭)或 1(开启)。
  • ConnectionPersist:连接池设置:取值为 0(关闭)、1(会话级连接池)或 2(事务级连接池)。
  • ReadWriteSpliting:读写分离设置,取值为 0(关闭)或 1(开启)。
  • PinPreparedStmt:仅 RDS PostgrSQL 可见,内部参数。
说明 RDS PostgreSQL 仅支持修改 ReadWriteSplitingTransactionReadSqlRouteOptimizeStatusPinPreparedStmt 默认为 1。
TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
RequestIdstring

请求 ID。

847BA085-B377-4BFA-8267-F82345ECE1D2
ReadOnlyInstanceWeightstring

读权重分配信息,即传入主实例和只读实例的读请求权重,格式为 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}]]
ReadOnlyInstanceDistributionTypestring

读权重分配模式,详情请参见读权重分配。取值:

  • Standard:按规格权重自动分配。
  • Custom:自定义分配权重。
Standard
ReadOnlyInstanceMaxDelayTimestring

读写分离的延迟阈值,当只读实例延迟时间超过该阈值时,读取流量不发往该实例,单位:秒。

30
DbProxyEndpointReadWriteModestring

代理终端的读写类型,取值:

  • ReadWrite:读写模式。
  • ReadOnly:只读模式。
ReadWrite
DbProxyEndpointAliasesstring

代理终端的备注信息。

proxyterminal-test
DBProxyEndpointIdstring

代理连接地址 ID。

keaxncrjluwu0gue****
DBProxyConnectStringPortstring

代理连接地址端口。

3306
DBProxyConnectStringstring

代理连接地址。

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

内部参数,无需关注。

normal
EndpointConnectItemsobject []

代理连接地址的详细信息列表。

DbProxyEndpointPortstring

服务端口,默认为 3306

3306
DbProxyEndpointConnectStringstring

代理连接地址。

testproxy****.rwlb.rds.aliyuncs.com
DbProxyEndpointNetTypestring

网络类型,取值:

  • 0:公网
  • 1:经典网络
  • 2:专有网络
2

示例

正常返回示例

JSON格式

{
  "DBProxyConnectStringNetType": "InnerString",
  "DBProxyFeatures": "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1",
  "RequestId": "847BA085-B377-4BFA-8267-F82345ECE1D2",
  "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}]]",
  "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"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400MaxscaleNotSupportCurrent custins can not support Maxscale.带有maxscale的实例不支持此操作。
400InvalidEndPoint.FormatThe specified EndPoint is not valid.独享代理连接地址ID(DBProxyEndpointId)未传,查询不存在, 请检查Endpoint参数。
400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。
400Endpoint.NotFoundThe specified EndPoint is not valid.指定的代理终端不存在
400InvalidParameterThe specified parameter is invalid.参数无效。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing 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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear 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.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud 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
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
400Api.NotSupportSpecified api is not supported.当前接口不支持。
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
400KmsApiErrorUser secret key invalid.用户密钥失效。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
403IncorrectKindCodeThe current KindCode of the custins does not support the operation.操作失败,当前实例所属环境类型不支持,请检查接口支持的实例类型。
403IncorrectDBInstanceTypeThe current database instance type does not support the operation.当前数据库实例类型不支持此操作。
403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.操作失败,数据库引擎不支持。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
404Endpoint.NotFoundSpecified endpoint is not found.未找到指定独享代理连接地址的端口。
404Maxscale.NotFoundThe relative maxscale instance is not found.操作失败,未找到关联的maxscale实例。
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。

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

变更历史

变更时间变更内容概要操作
2024-01-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
    删除错误码:403
2023-12-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
    删除错误码:404
2022-09-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2022-06-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:DBProxyEngineType
出参OpenAPI 返回结构发生变更