全部产品
Search

搜索本产品

    云数据库 RDS：ModifyDBProxyEndpoint - 配置数据库代理连接地址访问策略

    文档中心

    云数据库 RDS：ModifyDBProxyEndpoint - 配置数据库代理连接地址访问策略

    更新时间：Aug 27, 2026

    该接口用于配置RDS实例数据库代理连接地址的访问策略。

    接口说明

    适用引擎

    • RDS MySQL

    • RDS PostgreSQL

    相关功能文档

    重要 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    rds:ModifyDBProxyEndpoint

    update

    *DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    • rds:ResourceTag
    • rds:ResourceTag
    		 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    DBInstanceId

    string

    是

    实例 ID。可调用 DescribeDBInstances 获取。

    rm-bp145737x5bi6****
    DBProxyEndpointId

    string

    否

    代理连接地址 ID。可以通过接口 DescribeDBProxyEndpoint 查看。

    说明

    • MySQL：当 DbEndpointOperator 取值为 Delete 或 Modify 时，本参数必须传入。

    • PostgreSQL：当 DbEndpointOperator 取值为 Delete、Modify 或 Create 时，本参数必须传入。

    gos787jog2wk0y****
    ConfigDBProxyFeatures

    string

    否

    设置代理连接地址想要开通的代理功能，各功能之间以英文分号（;）隔开。格式：功能 1:开通情况;功能 2:开通情况;... ，末尾不加英文分号（;）。

    功能取值：

    • ReadWriteSpliting：读写分离

    • ConnectionPersist：连接池

    • TransactionReadSqlRouteOptimizeStatus：事务拆分

    • AZProximityAccess：就近访问

    • CausalConsistRead：读一致性

    • HtapFilter：HTAP 行列自动分流

    开通情况取值：

    • 1：功能已开通

    • 0：功能未开通

    说明

    • RDS PostgreSQL 仅支持设置 ReadWriteSpliting。

    • 就近访问功能仅支持 MySQL 独享型代理。

    ReadWriteSpliting:1;ConnectionPersist:0
    RegionId

    string

    否

    地域 ID。可调用 DescribeRegions 获取。

    cn-hangzhou
    ReadOnlyInstanceMaxDelayTime

    string

    否

    读写分离中只读实例的最大延迟阈值，当只读实例延迟时间超过该值时，读取流量不发往该实例，单位：秒。不传该参数则保持原值。取值：0~3600。

    说明

    • 开通读写分离时才需要传入该参数。

    • 默认值：读写属性为读写（读写分离）时默认 30 秒，读写属性为只读时默认 -1 (关闭)。

    30
    CausalConsistReadTimeout

    string

    否

    一致性读超时时间，单位：毫秒。默认为 10 毫秒，取值：0～60000

    10
    ReadOnlyInstanceDistributionType

    string

    否

    读权重分配模式。取值：

    • Standard：默认值，按规格权重自动分配。

    • Custom：自定义分配权重。

    说明

    开通读写分离时才需要传入该参数。权限分配模式的详细信息，MySQL 请参见读权重分配，PostgreSQL 请参见开通并配置数据库代理服务。

    Standard
    ReadOnlyInstanceWeight

    string

    否

    自定义读权重分配，即传入主实例和只读实例的读请求权重。以 100 递增，最大值为 10000，格式：

    • 常规实例：{"主实例 ID":"权重","只读实例 ID":"权重"...}

      示例：{"rm-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...}

    • RDS MySQL 集群版实例：{"只读实例 ID":"权重","DBClusterNode":{"主节点 ID":"权重","备节点 ID":"权重","备节点 ID":"权重"...}}

      示例：{"rr-tfhfgk5****":"200","DBClusterNode":{"rn-2z****":"0","rn-2z****":"400","rn-2z****":"400"...}}

      说明

      DBClusterNode 为集群版独有的请求信息，包含主备节点的 NodeID 以及权重。

    {"rm-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...}
    DBInstanceId

    string

    是

    实例 ID。可调用 DescribeDBInstances 获取。

    rm-bp145737x5bi6****
    DbEndpointOperator

    string

    否

    操作类型，取值：

    • Modify：默认值，修改代理终端。

    • Create：新建代理终端。

    • Delete：删除代理终端。

    Modify
    DbEndpointAliases

    string

    否

    代理终端的备注信息。

    test-proxy
    DbEndpointType

    string

    否

    代理终端的类型，保留参数，无需设置。

    RWSplit
    DbEndpointReadWriteMode

    string

    否

    读写类型，取值：

    • ReadWrite：连接主实例，可接受写请求。

    • ReadOnly：默认值，不连接主实例，无法接受写请求。

    说明

    • 当 DbEndpointOperator 取值为 Create 时，本参数必须传入。

    • RDS MySQL 实例中，本参数的取值从 ReadWrite 更换为 ReadOnly 时，会关闭事务拆分功能。

    ReadWrite
    DBProxyEngineType

    string

    否

    废弃参数，无需配置。

    normal
    VSwitchId

    string

    否

    指定代理连接地址的可用区对应的交换机 ID。默认为代理实例默认终端对应的交换机 ID。可通过调用 DescribeVSwitches 接口查询已创建的交换机。

    vsw-uf6adz52c2p****
    EffectiveTime

    string

    否

    生效时间，取值：

    • Immediate：立即生效。

    • MaintainTime：在可运维时间段内生效，请参见 ModifyDBInstanceMaintainTime。

    • SpecificTime：指定时间生效。

    默认值：MaintainTime。

    MaintainTime
    EffectiveSpecificTime

    string

    否

    指定时间生效。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    说明

    EffectiveTime 为 SpecificTime 时，该参数必传。

    2023-05-06T07:08:09Z
    DbEndpointMinSlaveCount

    string

    否

    最小保留实例数。

    2
    DbEndpointCostThresholdForDuckdb

    string

    否

    VpcId

    string

    否

    指定代理连接地址的可用区对应的 VPC ID。默认为代理实例默认终端对应的 VPC ID。可通过调用 DescribeDBInstanceAttribute 接口查询实例默认 VPC。

    vpc-2zeusejj******

    返回参数

    名称

    类型

    描述

    示例值

    object

    返回参数详情。

    RequestId

    string

    请求 ID。

    6B50D92C-1960-4D4F-A290-AFADD6B1A5C8

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "6B50D92C-1960-4D4F-A290-AFADD6B1A5C8"
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    400 InvalidVpcInstanceId The specified VPC instance ID is invalid. 操作失败，当前VPC instance ID无效。
    400 InvalidEndPoint.Format The specified EndPoint is not valid. 独享代理连接地址ID（DBProxyEndpointId）未传，查询不存在， 请检查Endpoint参数。
    400 InvalidEndpointType.Format The specified EndpointType is invalid. 指定的EndpointType无效，请检查参数正确性。
    400 IncorrectDBInstanceNetType The current database instance network type does not support the operation. 操作失败，数据库实例网络类型不支持此操作。
    400 EndpointNum.Error The number of endpoint is invalid. 当前终端数量不符合要求，请检查支持的终端数量。
    400 EndpointTypeOperation.NotSupport The endpoint type does not support the operation. 当前终端类型不支持此操作，请检查代理终端类型。
    400 InvalidDBInstanceName Specified parameter DBInstanceName is not valid. 指定的实例名称（DBInstanceName）无效，请检查参数值是否为null或空字符串。
    400 ClusterEndpoint.StatusNotValid The cluster endpoint status is invalid. 集群endpoint 状态无效。
    400 MaxscaleNotSupport Current custins can not support Maxscale. 带有maxscale的实例不支持此操作。
    400 InvalidAvZone.Format Specified AvZone is not valid. 指定的AvZone不合法，请检查该参数的正确性。
    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. 客户您好，该地域已裁撤。
    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 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. 指定的地域无效。
    400 APICallingFailed Api calling failed. 后端API内部调用失败
    400 InvalidVSwitchId.Format The specified vswitch Id format is incorrect. 指定的vswitch Id格式不正确。
    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服务失败，请求处理失败。
    403 MaxScaleLevel.NotSupport The current maxscale ins_num does not support this operation. 操作失败，当前数据库代理规格不支持此操作。
    403 ReadDBInstance.NotFound The current database instance does not contain any read only instance. 当前数据库实例没有只读实例。
    403 IncorrectKindCode The current KindCode of the custins does not support the operation. 操作失败，当前实例所属环境类型不支持，请检查接口支持的实例类型。
    403 IncorrectDBInstanceState The current database instance state does not support the operation. 操作失败，数据库状态不支持此操作。请查看数据库信息，确保数据库状态为运行中。
    403 IncorrectDBInstanceEngine Current DB Instance engine does not support this operation. 操作失败，数据库引擎不支持。
    403 IncorrectDBInstanceType Current DB instance type 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. 当前数据库实例级别不支持此操作。
    404 EndpointConfig.Invalid Please check the endpoint config parameter. 代理终端配置不正确。请检查参数是否正确。
    404 Readins.NotFound The current instance does not contain any read only instance. The operation is not supported. 操作失败，当前实例不存在只读实例。
    404 Endpoint.NotFound Specified endpoint is not found. 未找到指定独享代理连接地址的端口。
    404 EndpointType.NotFound The specified endpoint type is not found. 操作失败，未知的代理终端类型，请检查终端类型。
    404 InvalidReadDBInstance.NotFound The specified read only database instance does not exist. 只读实例未创建或请求实例参数有误。
    404 InvalidParam The specified Weight is invalid. 权重无效。
    404 Maxscale.NotFound The related maxscale instance is not found. 操作失败，未找到关联的maxscale实例。
    404 IncorrectVswitchId The specified parameter VSwitchId is not valid. 交换机参数无效。
    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. 指定的主机信息不存在。

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

    变更历史

    更多信息，参考变更详情。