Modify UDB Auto Backup Strategy - UpdateUDBInstanceBackupStrategy
Overview
Modify UDB Auto Backup Strategy
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is UpdateUDBInstanceBackupStrategy . | 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 | No |
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
DBId | string | Master Node's Id | Yes |
BackupTime | int | The whole point of time for backup, range [0,23] | No |
BackupDate | string | Backup 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 |
ForceDump | boolean | When 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 |
BackupMethod | string | Select 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 |
UserTokenID | string | TokenID for automatic backup transfer to the user's own bucket, the user needs to set the permissions themselves. | No |
UserBucket | string | Automatic backup transferred to the user's own bucket name, must include the corresponding token id | No |
EnableBinlogBackup | boolean | Whether to enable binlog backup, default is not enabled | No |
BinlogRemoteSaveDays | int | Remote binlog retention period (days) | 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 |
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
}