docs
api
Cloud Database(UDB)
SetUDBRWSplitting

Set up Read-Write Splitting - SetUDBRWSplitting

Overview

Set the read-write separation mode

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is SetUDBRWSplitting.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListYes
MasterDBIdstringDB Instance ID (master)Yes
ReadModelstringRead-Write Splitting StrategyYes
DBIds.NstringDBIds.0 represents the UDB master node, DBIds.1 to DBIds.n represent 1 to N slave nodes.Yes
ReadPercents.NstringThe read ratio of the UDB master-slave nodes. ReadPercents.0 represents the read ratio of the master node, ReadPercents.1 represents the read-write ratio of slave node 1, and so on.No
DelayThresholdintTime ThresholdNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No

Example

Request Example

https://api.surfercloud.com/?Action=SetUDBRWSplitting
&Region=cn-zj
&Zone=cn-zj-01
&MasterDBId=KeQskOid
&DelayThreshold=50
&ReadModel=Uniform
&ReadPercentInfo=ocTIdTxW

Response Example

{
  "Action": "SetUDBRWSplittingResponse",
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved