Get Backup List - ListUPgSQLBackup

Overview

Get Backup List

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ListUPgSQLBackup`.	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	Yes
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
InstanceID	string	DB Instance Id	Yes
BackupType	int	Backup Type, the default value is 0 (0: represents all, 1: automatic backup, 2: manual backup)".	No
Offset	int	List start position offset, default is 0	No
Limit	int	Return data length, default is 20, maximum 100	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[UPgSQLBackup]	Backup Information List. Modify Parameters	Yes
TotalCount	int	Total Number	Yes

Data Model

UPgSQLBackup

Field Name	Type	Description Information	Required
Region	string	Backup Location	No
InstanceID	string	DB Instance Id	Yes
BackupID	string	Backup ID	Yes
BackupName	string	Backup Name	No
BackupStartTime	int	Backup Time (Unix Timestamp)	No
BackupSize	int	Backup File Size (Bytes)	No
BackupType	int	Backup type, manual or automatic	No
State	string	Backup Status (Backuping: Backup in progress, Success: Backup successful, Failed: Backup failed, Expired: Backup expired)	No
BackupEndTime	int	Backup Completion Time (Unix Timestamp)	No

Example

Request Example

https://api.surfercloud.com/?Action=ListUPgSQLBackup
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=hMtkKQzD
&InstanceID=LLtYwYlt
&BackupType=5
&Offset=2
&Limit=1

Response Example

{
  "Action": "ListUPgSQLBackupResponse",
  "Data": [
    {
      "BackupEndTime": 3,
      "BackupID": "jKlVVkmg",
      "BackupName": "qBNVHaRs",
      "BackupSize": 1,
      "BackupStartTime": 3,
      "BackupType": 3,
      "InstanceID": "SCsFwxvD",
      "Region": "fYoZJRsx",
      "State": "ciSlAoMG"
    }
  ],
  "Message": "hlvlRYaU",
  "RetCode": 0,
  "TotalCount": 3
}

GetUPgSQLUpgradePrice ListUPgSQLInstance