調(diào)用AllocateReadWriteSplittingConnection接口申請讀寫分離地址。

對擁有只讀實(shí)例的SQL Server主實(shí)例，可以創(chuàng)建統(tǒng)一只讀地址。創(chuàng)建該地址后，不影響原主實(shí)例、只讀實(shí)例的已有訪問地址，以及正常的內(nèi)外網(wǎng)申請。

調(diào)用該接口時(shí)，實(shí)例必須滿足以下條件，否則將操作失敗：

  • MySQL實(shí)例使用的是共享代理。
  • 實(shí)例狀態(tài)為運(yùn)行中。
  • 實(shí)例擁有只讀實(shí)例。
  • 實(shí)例沒有正在執(zhí)行的DTS遷移任務(wù)。
  • 實(shí)例為如下版本：
    • SQL Server集群版。
    • MySQL 5.7高可用版（本地SSD盤）
    • MySQL 5.6

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 AllocateReadWriteSplittingConnection

系統(tǒng)規(guī)定參數(shù)。取值：AllocateReadWriteSplittingConnection。

DBInstanceId String 是 rm-uf6wjk5xxxxxxx

主實(shí)例ID。可調(diào)用DescribeDBInstances獲取。

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

只讀地址前綴名，不可重復(fù)，由小寫字母和中劃線組成，需以字母開頭，長度不超過30個(gè)字符。

說明 默認(rèn)以“實(shí)例名+rw”字符串組成前綴。
Port String 否 1433

只讀地址端口，取值為1000~5999，默認(rèn)為1433。
MaxDelayTime String 否 30

延遲閾值，范圍是0~7200，單位：秒，默認(rèn)為30。

說明 當(dāng)只讀實(shí)例延遲超過該閾值時(shí)，讀取流量不發(fā)往該實(shí)例。
NetType String 否 Intranet

只讀地址的網(wǎng)絡(luò)類型，取值：

  • Internet：外網(wǎng)
  • Intranet：內(nèi)網(wǎng)
說明 默認(rèn)為內(nèi)網(wǎng)，且內(nèi)網(wǎng)類型與主實(shí)例保持一致。
DistributionType String 否 Standard

讀權(quán)重分配模式，取值：

  • Standard：按規(guī)格權(quán)重自動(dòng)分配
  • Custom：自定義分配權(quán)重
Weight String 否 {"rm-bp1**********":800,"master":400,"slave":400}

讀權(quán)重分配，即傳入主實(shí)例和只讀實(shí)例的讀請求比例。以100進(jìn)行遞增，最大值為10000。

  • RDS實(shí)例格式：{"<只讀實(shí)例ID>":<權(quán)重>,"master":<權(quán)重>,"slave":<權(quán)重>}
  • MyBASE實(shí)例格式：[{"instanceName":"<主實(shí)例ID>","weight":<權(quán)重>,"role":"master"},{"instanceName":"<主實(shí)例ID>","weight":<權(quán)重>,"role":"slave"},{"instanceName":"<只讀實(shí)例ID>","weight":<權(quán)重>,"role":"master"}]
說明
  • 當(dāng)DistributionType為Custom時(shí)，必須傳入該參數(shù)。
  • 當(dāng)DisrtibutionType為Standard時(shí)，傳入該參數(shù)無效。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
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}
&公共請求參數(shù)

正常返回示例

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"
}

錯(cuò)誤碼

訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。