Get Backup List - DescribeUDBBackup

Overview

List UDB instance backup information. If 'Zone' is not filled in, it means multiple availability zones, if filled, it represents a single availability zone.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUDBBackup`.	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
Offset	int	The starting offset for pagination display, specified for list operations.	Yes
Limit	int	The number of items displayed per page, specified by the list operation.	Yes
DBId	string	DB instance Id, if specified, only the backup information of this db will be obtained. This value can be obtained through DescribeUDBInstance.	No
BackupType	int	Backup type, value is 0 or 1, 0 means automatic, 1 means manual	No
BeginTime	int	Filter condition: Start time (Unix timestamp)	No
EndTime	int	Filter Condition: End Time (Unix Timestamp)	No
ClassType	string	If GroupId is not specified, you can optionally choose the configuration of a specific DB type (sql, nosql, postgresql, sqlserver).	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
DataSet	array[UDBBackupSet]	Backup Information Refer to UDBBackupSet	No
TotalCount	int	The total number of backups that meet the conditions, if a specific dbid is specified, then it is the total number of backups for that db.	No

Data Model

UDBBackupSet

Field Name	Type	Description Information	Required
Zone	string	Backup Availability Zone	No
BackupId	int	Backup ID	No
BackupName	string	Backup Name	No
BackupTime	int	Backup Time (Unix Timestamp)	No
BackupSize	int	Backup File Size (Bytes)	No
BackupType	int	Backup type, value is 0 or 1, 0 means automatic, 1 means manual	No
State	string	Backup Status Backuping // Backing up Success // Backup Successful Failed // Backup Failed Expired // Backup Expired	No
ErrorInfo	string	Backup Error Information	No
DBId	string	dbid	No
DBName	string	Corresponding db name	No
BackupZone	string	Cross-IDC high-availability backup library availability zone	No
BackupEndTime	int	Backup Completion Time (Unix Timestamp)	No
MD5	string	The MD5 value of the backup file, displayed after the backup is completed, is empty during the backup or when the backup fails. Currently, only Mysql NVMe models and Mongo are supported.	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeUDBBackup
&Region=cn-bj2
&Offset=0
&Limit=20
&BackupId=1

Response Example

{
  "Action": "DescribeUDBBackupResponse",
  "DataSet": [
    {
      "BackupEndTime": 1329867185,
      "BackupId": 296133,
      "BackupName": "system backup",
      "BackupSize": 167066,
      "BackupTime": 1429867144,
      "BackupType": 0,
      "BackupZone": null,
      "DBId": "udbha-xxxxxx",
      "DBName": "frombf-hassd-56",
      "ErrorInfo": "",
      "State": "Success",
      "Zone": "cn-bj2-02"
    },
    {
      "BackupEndTime": 1429859800,
      "BackupId": 29534,
      "BackupName": "system backup",
      "BackupSize": 3105731,
      "BackupTime": 1429859724,
      "BackupType": 0,
      "BackupZone": null,
      "DBId": "udb-xxxxx",
      "DBName": "test_linshi",
      "ErrorInfo": "",
      "State": "Success",
      "Zone": "cn-bj2-02"
    }
  ],
  "RetCode": 0,
  "TotalCount": 180
}

DescribeUDBParamGroup UpdateUDBParamGroup