文档

DescribeDBInstanceProxyConfiguration - 查看数据库代理设置

更新时间:

该接口用于查看数据库代理设置。

接口说明

适用引擎

  • RDS MySQL
  • RDS SQL Server

功能描述

该 API 查看的是 MySQL 共享代理或 SQL Server 读写分离的设置,如果要查询 RDS MySQL 数据库独享代理,请参见 DescribeDBProxy

前提条件

调用该接口时,实例必须满足以下条件,否则将操作失败:

  • 实例使用的是共享代理。
  • 实例已开通读写分离。

调试

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

授权信息

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

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

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****

返回参数

名称类型描述示例值
object

返回参数详情。

PersistentConnectionsConfigurationstring

是否开启短连接优化:

  • Enable:开启
  • Disable:关闭

返回值格式为 JSON 字符串,如:

{"status":"Disable"}。
{\"status\":\"Disable\"}
AttacksProtectionConfigurationstring

是否开启防暴力破解:

  • Enable:开启
  • Disable:关闭

返回值格式为 JSON 字符串,如:

{"status":"Disable", "check_interval_seconds": 60,
          "max_failed_login_attempts": 60, "blocking_seconds": 600}

参数说明及取值范围:

  • 对于每一个客户端,check_interval_seconds 秒内最多允许 max_failed_login_attempts 次错误密码登录,否则将对该客户端 IP 禁止登录 blocking_seconds 秒钟。
  • 取值范围:
    • check_interval_seconds:30-600,单位为秒。
    • max_failed_login_attempts:10-5000,单位为次。
    • blocking_seconds:30-3600,单位为秒。
{\"check_interval_seconds\":\"0\",\"max_failed_login_attempts\":\"0\",\"blocking_seconds\":\"0\",\"status\":\"Disable\"}
RequestIdstring

请求 ID。

E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34
TransparentSwitchConfigurationstring

是否开启透明切换:

  • Enable:开启
  • Disable:关闭

返回值格式为 JSON 字符串,如:

{"status":"Enable"}。
{\"status\":\"Enable\"}

示例

正常返回示例

JSON格式

{
  "PersistentConnectionsConfiguration": "{\\\"status\\\":\\\"Disable\\\"}",
  "AttacksProtectionConfiguration": "{\\\"check_interval_seconds\\\":\\\"0\\\",\\\"max_failed_login_attempts\\\":\\\"0\\\",\\\"blocking_seconds\\\":\\\"0\\\",\\\"status\\\":\\\"Disable\\\"}",
  "RequestId": "E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34",
  "TransparentSwitchConfiguration": "{\\\"status\\\":\\\"Enable\\\"}"
}

错误码

HTTP status code错误码错误信息描述
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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。

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

  • 本页导读 (1)
文档反馈