# Enable read-write separation function - EnableUDBRWSplitting

## Overview

Enable the read-write separation function of DB






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `EnableUDBRWSplitting`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region. See [List of Regions and Availability Zones](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | Availability Zone. See [Availability Zone List](/docs/api/summary/regionlist) |**Yes**|
| **MasterDBId** | string | DB Instance ID (Master) |**Yes**|
| **BackupZone** | string | The available zone for backup. It is used to create a node for read-write separation across available zones, and cross-IDC read-write separation must have this parameter. |No|

### 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|
| **MasterDBId** | string | DB Instance ID (Master) |No|
| **RWIp** | string | Read-Write Splitting Access IP |No|




## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=EnableUDBRWSplitting
&Region=cn-zj
&Zone=cn-zj-01
&MasterDBId=DMfqCmki
```

### Response Example
    
```json
{
  "Action": "EnableUDBRWSplittingResponse",
  "MasterDBId": "WGLtSDkR",
  "RWIP": "VaaMPTNO",
  "RetCode": 0
}
```