文档

ModifyReadWriteSplittingConnection - 修改读写分离链路的延迟阈值和各个实例的读权重

更新时间:

该接口用于修改读写分离链路的延迟阈值和各个实例的读权重。

接口说明

适用引擎

  • RDS MySQL
  • RDS SQL Server

前提条件

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

  • MySQL 实例使用的是共享代理。
  • MySQL 实例已开通读写分离。
  • 实例为如下版本:
    • MySQL 5.7 高可用系列(本地 SSD 盘)
    • MySQL 5.6
    • SQL Server 集群系列

调试

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

授权信息

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

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

请求参数

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

主实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
ConnectionStringPrefixstring

读写分离地址前缀名,不可重复,由小写字母和中划线组成,需以字母开头,长度不超过 30 个字符。

说明 默认以“实例名+rw”字符串组成前缀。
rm-m5****rw.mysql.rds.aliyuncs.com
Portstring

读写分离地址端口号。

3306
MaxDelayTimestring

延迟阈值,单位为秒。当只读实例延迟时间超过该阈值时,读取流量不发往该实例。不传该参数则保持原值。

说明
  • 参数 MaxDelayTime 不适用于 SQL Server 2017 集群版实例。
  • 至少传入 MaxDelayTimeDistributionType 中的一个。
  • 12
    DistributionTypestring

    读权重分配模式,取值:

    • Standard:按规格权重自动分配
    • Custom:自定义分配权重
    说明 至少传入 MaxDelayTimeDistributionType 中的一个。
    Standard
    Weightstring

    读权重分配,即传入主实例和只读实例的读请求权重。以 100 递增,最大值为 10000。

    • RDS 实例格式:{"<只读实例 ID>":<权重>,"master":<权重>,"slave":<权重>}
    • MyBASE 实例格式:[{"instanceName":"<主实例 ID>","weight":<权重>,"role":"master"},{"instanceName":"<主实例 ID>","weight":<权重>,"role":"slave"},{"instanceName":"<只读实例 ID>","weight":<权重>,"role":"master"}]
    说明
  • DistributionTypeCustom 时,必须传入该参数。
  • DisrtibutionTypeStandard 时,传入该参数无效。
  • { "rm-bp1****": 800, "master": 400, "slave": 400 }

    返回参数

    名称类型描述示例值
    object

    返回参数详情。

    RequestIdstring

    请求 ID。

    5A77D650-27A1-4E08-AD9E-59008EDB6927

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "5A77D650-27A1-4E08-AD9E-59008EDB6927"
    }

    错误码

    HTTP status code错误码错误信息描述
    400ReadUniformNetTypeNotExistsThe specified uniform read only network type does not exist.操作失败,指定统一只读网络类型不存在。
    400ReadDBInstance.NotFoundThe Current DB Instance has not read-only instance.操作失败,当前数据库实例没有只读实例。
    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.销售表达式校验系统错误。
    403ReadDBInstance.NotFoundThe current database instance does not contain any read only instance.当前数据库实例没有只读实例。
    403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。

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

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