Docs
api
Cloud Database(UDB)
UpdateUDBInstanceBackupStrategy

Modify UDB Auto Backup Strategy - UpdateUDBInstanceBackupStrategy

Overview

Modify UDB Auto Backup Strategy

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is UpdateUDBInstanceBackupStrategy.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
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, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
DBIdstringMaster Node’s IdYes
BackupTimeintThe whole point of time for backup, range [0,23]No
BackupDatestringBackup date marker bit. There are 7 bits in total, each representing the backup status for one day of the week, 0 indicates that the backup for the day is turned off, 1 indicates that the backup for the day is turned on. The rightmost bit is the backup switch for Sunday, and the rest from right to left are the backup configuration switches for Monday to Saturday, respectively. At least two days of backup must be set each week. For example, 1100000 means that the backup function for Saturday and Friday is turned on.No
ForceDumpbooleanWhen encountering problems exporting certain data, should the remaining data be forcibly exported?
The default is false.
The BackupDate field needs to be set at the same time.
No
BackupMethodstringSelect the default backup method, where ‘nobackup’ means no backup, ‘snapshot’ means using snapshot backup, and ‘logic’ means using logical backup. The ‘BackupDate’ field must also be set. (Snapshot backup is equivalent to physical backup. SSD version of mysql instance supports setting to ‘snapshot’, NVMe version of mysql instance supports setting to ‘xtrabackup’)No
UserTokenIDstringTokenID for automatic backup transfer to the user’s own bucket, the user needs to set the permissions themselves.No
UserBucketstringAutomatic backup transferred to the user’s own bucket name, must include the corresponding token idNo
EnableBinlogBackupbooleanWhether to enable binlog backup, default is not enabledNo
BinlogRemoteSaveDaysintRemote binlog retention period (days)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.spark.ucloud.cn/?Action=UpdateUDBInstanceBackupStrategy  
&Region=cn-bj2
&ProjectId=7                          
&DBId=udb-xxx
&BackupTime=5
&BackupDate=0011111
&BackupMethod=rjlwkIlW
&UserTokenID=hCBIvgmm
&UserBucket=eInaAosL
&EnableBinlogBackup=true
&BinlogRemoteSaveDays=4

Response Example

{
  "Action": "UpdateUDBInstanceBackupStrategyResponse",
  "RetCode": 0
}