调用AllocateReadWriteSplittingConnection接口申请读写分离地址。

对拥有只读实例的SQL Server主实例,可以创建统一只读地址。创建该地址后,不影响原主实例、只读实例的已有访问地址,以及正常的内外网申请。

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

  • MySQL实例使用的是共享代理。
  • 实例状态为运行中。
  • 实例拥有只读实例。
  • 实例没有正在执行的DTS迁移任务。
  • 实例为如下版本:
    • SQL Server集群版。
    • MySQL 5.7高可用版(本地SSD盘)
    • MySQL 5.6

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String AllocateReadWriteSplittingConnection

系统规定参数。取值:AllocateReadWriteSplittingConnection

DBInstanceId String rm-uf6wjk5xxxxxxx

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

ConnectionStringPrefix String rr-m5exxxxx-rw.mysql.rds.aliyuncs.com

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

说明 默认以“实例名+rw”字符串组成前缀。
Port String 1433

只读地址端口,取值为1000~5999,默认为1433。

MaxDelayTime String 30

延迟阈值,范围是0~7200,单位:秒,默认为30。

说明 当只读实例延迟超过该阈值时,读取流量不发往该实例。
NetType String Intranet

只读地址的网络类型,取值:

  • Internet:外网
  • Intranet:内网
说明 默认为内网,且内网类型与主实例保持一致。
DistributionType String Standard

读权重分配模式,取值:

  • Standard:按规格权重自动分配
  • Custom:自定义分配权重
Weight String {"rm-bp1**********":800,"master":400,"slave":400}

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

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

返回数据

名称 类型 示例值 描述
RequestId String 4C467B38-3910-447D-87BC-AC049166F216

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=AllocateReadWriteSplittingConnection
&DBInstanceId=rm-uf6wjk5xxxxxxx
&ConnectionStringPrefix=rr-m5exxxxx-rw.mysql.rds.aliyuncs.com
&Port=1433
&MaxDelayTime=30
&NetType=Intranet
&DistributionType=Standard
&Weight={"rm-bp1**********":800,"master":400,"slave":400}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<AllocateReadWriteSplittingConnectionResponse>
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
</AllocateReadWriteSplittingConnectionResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4C467B38-3910-447D-87BC-AC049166F216"
}

错误码

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