Describe Read-Write Splitting Function - DescribeUDBSplittingInfo

Overview

Details of the read-write separation function

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUDBSplittingInfo`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
Zone	string	Availability Zone. See Availability Zone List	Yes
MasterDBId	string	DB Instance ID	Yes

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
Zone	string	Availability Zone	No
MasterDBId	string	DB Instance ID	No
RWIP	string	Read-Write Separation IP	No
DelayThreshold	int	Time Threshold	No
Port	int	Port Number	No
ReadModel	string	Read-Write Splitting Strategy	No
DBTypeId	string	Database Version	No
RWState	string	Read-Write Splitting Status	No
DataSet	array[UDBRWSplittingSet]	Read-Write Separation Slave Information	No

Data Model

UDBRWSplittingSet

Field Name	Type	Description Information	Required
DBId	string	DB Instance ID	No
Role	string	Master/Slave	No
VirtualIP	string	UDBIP	No
ReadWeight	int	Read-Write Separation Weight	No
State	string	DB Status	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeUDBSplittingInfo
&Region=cn-zj
&Zone=cn-zj-01
&MasterDBId=NzgZOTgz

Response Example

{
  "Action": "DescribeUDBSplittingInfoResponse",
  "DBTypeId": "HZxiDykq",
  "DataSet": [
    {
      "DBId": "BpCreBes",
      "ReadWeight": 50,
      "Role": "master",
      "State": "iGyPHLGk",
      "VirtualIP": "FmcvWPOS"
    },
    {
      "DBId": "jBgxHUVS",
      "ReadWeight": 50,
      "Role": "master",
      "State": "aVUODePQ",
      "VirtualIP": "oisTbHGm"
    },
    {
      "DBId": "HBCtruVq",
      "ReadWeight": 50,
      "Role": "master",
      "State": "XPYHDmkt",
      "VirtualIP": "yfTsRDrt"
    },
    {
      "DBId": "BUXZmWJM",
      "ReadWeight": 50,
      "Role": "master",
      "State": "KkfYLRyo",
      "VirtualIP": "AwEZlxqz"
    }
  ],
  "DelayThreshold": 50,
  "MasterDBId": "fplVHdTl",
  "Port": 2,
  "RWIP": "LsGqmDqU",
  "RWState": "zBvozXGk",
  "ReadModel": "vFwGkIve",
  "Region": "cn-zj",
  "RetCode": 0,
  "Zone": "cn-zj-01"
}

DescribeUDBInstanceUpgradePrice GetUDBClientConnNum