备案控制台
文档
产品文档
输入文档关键字查找
首页 云数据库 RDS 开发参考 API参考 API目录 数据库代理 DescribeDBProxy - 查询数据库代理详情

DescribeDBProxy - 查询数据库代理详情

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

该接口用于查询RDS实例的数据库代理设置详情。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL

调试

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

授权信息

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

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

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-bp1ja4f56s7us****
RegionIdstring否

地域 ID。可调用 DescribeRegions 获取。

cn-hangzhou
DBProxyEngineTypestring否

废弃参数，无需配置。

normal
ResourceGroupIdstring否

资源组 ID。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

DBProxyInstanceLatestMinorVersionstring

代理实例最新版本。

1.13.12
RequestIdstring

请求 ID。

909A69EE-71C8-4417-A0B9-FF085407E1E3
DBProxyInstanceCurrentMinorVersionstring

代理实例当前版本。

1.13.11
DBProxyInstanceNuminteger

开通的代理实例数量。

1
DBProxyInstanceTypestring

代理服务类型。

  • 1：共享型代理
  • 2：独享型代理
  • 3：通用型代理
说明 RDS PostgreSQL 不支持共享型代理。
2
DBProxyPersistentConnectionStatusstring

连接保持状态。取值：

  • Enabled：开启
  • Disabled：关闭
  • Unsupported：实例不支持开启连接保持
Disabled
DBProxyInstanceStatusstring

代理实例的运行状态。

  • DBInstanceClassChanging：变配中
  • Creating：创建中
  • Running：运行中
  • Deleting：删除中
Running
DBProxyServiceStatusstring

数据库代理功能开关状态。

  • Shutdown：关闭
  • Startup：开启
Startup
DBProxyInstanceNamestring

代理实例名称。

gos787jog2wk0ye1****
DBProxyInstanceSizestring

该参数仅 RDS PostgreSQL 支持。表示代理实例规格实际大小。

格式：CPU/内存。

例如：4/8 表示 4 核 CPU 8GB 内存。

4/8
DBProxyEngineTypestring

内部参数，无需关注。

normal
DBProxyConnectStringItemsobject []

数据库代理的连接地址信息列表。

DBProxyConnectStringNetWorkTypestring

代理网络类型。

  • 0：公网
  • 1：经典网络
  • 2：专有网络
2
DBProxyConnectStringNetTypestring

代理连接地址的网络类型。

  • OuterString：外网
  • InnerString：内网
InnerString
DBProxyVpcInstanceIdstring

代理的实例 ID。

rm-bp145737x5****131161274792****
DBProxyEndpointNamestring

代理终端名称，真实服务的代理终端 ID。

gos787jog2wk0ye1****
DBProxyEndpointIdstring

后端代理终端 ID。

20****
DBProxyConnectStringPortstring

代理连接地址的端口。

3306
DBProxyConnectStringstring

代理终端连接地址。

gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com
DBProxyVpcIdstring

代理服务地址的 VPC。

vpc-uf6oobt****
DBProxyVswitchIdstring

代理服务地址的 vSwitch。

vsw-uf6l0pic17****
DbProxyEndpointItemsobject []

代理终端信息列表。

DbProxyEndpointAliasesstring

代理终端的备注信息。

proxy-test
DbProxyEndpointNamestring

代理终端 ID。

gos787jog2wk0ye1****
DbProxyEndpointTypestring

代理终端类型。

  • Custom：自定义代理终端
  • RWSplit：默认代理终端
RWSplit
DbProxyReadWriteModestring

代理终端模式。

  • ReadOnly：只读模式
  • ReadWrite：读写模式
ReadWrite
ResourceGroupIdstring

资源组 ID。

rg-acfmy****
DBProxyAVZonesarray

代理服务所在的可用区列表。

string

代理服务所在的可用区。

cn-shanghai-e

示例

正常返回示例

JSON格式

{
  "DBProxyInstanceLatestMinorVersion": "1.13.12",
  "RequestId": "909A69EE-71C8-4417-A0B9-FF085407E1E3",
  "DBProxyInstanceCurrentMinorVersion": "1.13.11",
  "DBProxyInstanceNum": 1,
  "DBProxyInstanceType": "2",
  "DBProxyPersistentConnectionStatus": "Disabled",
  "DBProxyInstanceStatus": "Running",
  "DBProxyServiceStatus": "Startup",
  "DBProxyInstanceName": "gos787jog2wk0ye1****",
  "DBProxyInstanceSize": "4/8",
  "DBProxyEngineType": "normal",
  "DBProxyConnectStringItems": {
    "DBProxyConnectStringItems": [
      {
        "DBProxyConnectStringNetWorkType": "2",
        "DBProxyConnectStringNetType": "InnerString",
        "DBProxyVpcInstanceId": "rm-bp145737x5****131161274792****",
        "DBProxyEndpointName": "gos787jog2wk0ye1****",
        "DBProxyEndpointId": "20****",
        "DBProxyConnectStringPort": "3306",
        "DBProxyConnectString": "gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com",
        "DBProxyVpcId": "vpc-uf6oobt****",
        "DBProxyVswitchId": "vsw-uf6l0pic17****"
      }
    ]
  },
  "DbProxyEndpointItems": {
    "DbProxyEndpointItems": [
      {
        "DbProxyEndpointAliases": "proxy-test",
        "DbProxyEndpointName": "gos787jog2wk0ye1****",
        "DbProxyEndpointType": "RWSplit",
        "DbProxyReadWriteMode": "ReadWrite"
      }
    ]
  },
  "ResourceGroupId": "rg-acfmy****",
  "DBProxyAVZones": {
    "DBProxyAVZones": [
      "cn-shanghai-e"
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400RWSplitNetTypeNotExistsSpecified rw split net type is not eixsts.-
400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.指定的实例名称（DBInstanceName）无效，请检查参数值是否为null或空字符串。
400InvalidInstanceLevelExtraInfoSpecified class code has error extra info.指定的类代码包含错误额外信息。
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.您的信息不完整，请在操作前填写您的信息。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
403IncorrectKindCodeCurrent custins kindCode does not support this operation.操作失败，当前实例所属环境类型不支持，请检查接口支持的实例类型。
403IncorrectDBInstanceTypeThe 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.实例当前存在未支付订单，请支付后重试。
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。

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

变更历史

变更时间变更内容概要操作
2023-12-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    错误码 403 变更
    新增错误码：404
2023-12-12OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
    删除错误码：403
出参OpenAPI 返回结构发生变更。
2023-11-23OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
    删除错误码：403
出参OpenAPI 返回结构发生变更。
2023-03-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
    删除错误码：403
出参OpenAPI 返回结构发生变更。
2022-06-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
    删除错误码：403
入参OpenAPI 入参发生变更。
    新增入参：DBProxyEngineType
出参OpenAPI 返回结构发生变更。
文档推荐
  • 本页导读 （1）
文档反馈