# 开启或者关闭UDB从库备份 - UpdateUDBInstanceSlaveBackupSwitch

## 简介

开启或者关闭UDB从库备份





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `UpdateUDBInstanceSlaveBackupSwitch`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.dezai.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Region** | string | 地域。 参见 [地域和可用区列表](api/summary/regionlist) |**Yes**|
| **Zone** | string | 可用区。参见 [可用区列表](api/summary/regionlist) |No|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](api/summary/get_project_list) |No|
| **MasterDBId** | string | 主库的Id |**Yes**|
| **BackupSwitch** | int | 从库的备份开关，范围[0,1],0表示从库备份功能关闭,1 表示从库备份开关打开。 |**Yes**|
| **SlaveDBId** | string | 从库的Id,如果从库备份开关设定为打开，则必须赋值。 |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|




## 示例

### 请求示例
    
```
https://api.dezai.com/?Action=UpdateUDBInstanceSlaveBackupSwitch 
&Region=cn-bj2
&ProjectId=7                          
&MasterDBId=udb-xxx
&SlaveDBId=udb-xxx
&BackupSwitch=1
```

### 响应示例
    
```json
{
  "Action": "UpdateUDBInstanceSlaveBackupSwitchResponse",
  "RetCode": 0
}
```