調用AllocateReadWriteSplittingConnection介面申請讀寫分離地址。

對擁有唯讀執行個體的主執行個體,可以申請讀寫分離訪問地址。申請該地址後,不影響原主執行個體、唯讀執行個體的已有訪問地址,以及正常的內外網申請。

調用該介面時,執行個體必須滿足以下條件,否則將操作失敗:

  • 執行個體狀態為運行中;
  • 執行個體擁有唯讀執行個體;
  • 執行個體沒有正在執行的遷移任務;
  • 執行個體為如下版本:
    • MySQL 5.7高可用版(本地SSD盤)
    • MySQL 5.6
    • SQL Server 2017叢集版

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String AllocateReadWriteSplittingConnection

系統規定參數,取值:AllocateReadWriteSplittingConnection

DBInstanceId String rm-uf6wjk5xxxxxxx

主執行個體ID。

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

讀寫分離地址首碼名,不可重複,由小寫字母和中劃線組成,需以字母開頭,長度不超過30個字元。

说明 預設以“執行個體名+rw”字串組成首碼。
Port String 3306

讀寫分離連接埠,取值:

  • MySQL:範圍為3001~3999,預設為3306;
  • SQL Server:範圍為1000~5999,預設為1433。
MaxDelayTime String 30

延遲閾值,範圍是0~7200,單位:秒,預設為30。

说明 當唯讀執行個體延遲超過該閾值時,讀取流量不發往該執行個體。
NetType String Intranet

讀寫分離串連串的網路類型,取值:

  • Internet:外網;
  • Intranet:內網。

預設為內網,且內網類型與主執行個體保持一致。

DistributionType String Standard

讀權重分配模式,取值:

  • Standard:按規格權重自動分配;
  • Custom:自訂分配權重。
Weight String {“Instanceid1“:”100”,”Instanceid2”:”200”}

讀權重分配,即傳入主執行個體和唯讀執行個體的讀請求比例。以100進行遞增,最大值為10000,格式:{“Instanceid1“:”Weight”,”Instanceid2”:”Weight”...}。

说明
  • 當DistributionType為Custom時,必須傳入該參數;
  • 當DisrtibutionType為Standard時,傳入該參數無效。
AccessKeyId String LTAIfCxxxxxxx

阿里雲頒發給使用者的訪問服務所用的密鑰ID。

返回資料

名稱 類型 樣本值 描述
RequestId String 4C467B38-3910-447D-87BC-AC049166F216

請求ID 。

樣本

請求樣本


http(s)://rds.aliyuncs.com/?Action=AllocateReadWriteSplittingConnection
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公用請求參數>

正常返回樣本

XML 格式

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

JSON 格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。