Backup UDB - BackupUDBInstance
Overview
Backup UDB Instance
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is BackupUDBInstance. | 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 | DB Instance Id, this value can be obtained through DescribeUDBInstance | Yes |
| BackupName | string | Backup Name | Yes |
| UseBlacklist | boolean | Use blacklist backup, default is false | No |
| BackupMethod | string | The backup method used. By default, logical backup is used (Snapshot backup is physical backup. SSD version of mysql/mongodb instances support setting to snapshot, NVMe version of mysql instances support setting to xtrabackup) | No |
| Blacklist | string | Backup blacklist, separated by ;. Note: The backup blacklist only takes effect under logical backup, and is invalid under snapshot backup. | No |
| ForceBackup | boolean | true indicates that the --force parameter is used during logical backup, false indicates that the --force parameter is not used. This parameter is invalid for physical backup. | 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.surfercloud.com/?Action=BackupUDBInstance
&Region=cn-bj2
&DBId=udbha-xxxx
&BackupName=master-backup
&BackupMethod=snapshot
&Blacklist=ZScuaauv
&ForceBackup=falseResponse Example
{
"Action": "BackupUDBInstanceResponse",
"RetCode": 0
}