docs
api
Cloud Database(UDB)
UpdateUDBInstanceSlaveBackupSwitch

Enable or disable UDB slave backup - UpdateUDBInstanceSlaveBackupSwitch

Overview

Enable or disable UDB slave backup

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is UpdateUDBInstanceSlaveBackupSwitch.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 ListNo
ProjectIdstringProject ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface.No
MasterDBIdstringMaster database's IdYes
BackupSwitchintBackup switch for the slave database, range [0,1], 0 indicates the backup function of the slave database is turned off, 1 indicates the backup switch of the slave database is turned on.Yes
SlaveDBIdstringThe ID of the slave database. If the backup switch of the slave database is set to open, it must be assigned.No

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=UpdateUDBInstanceSlaveBackupSwitch 
&Region=cn-bj2
&ProjectId=7                          
&MasterDBId=udb-xxx
&SlaveDBId=udb-xxx
&BackupSwitch=1

Response Example

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