文档

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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
    403ReadDBInstance.NotFoundThe current database instance does not contain any read only instance.当前数据库实例没有只读实例。

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

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