RDS

Products

RDS

describeBackups

Description

View the detailed information of all backups in the RDS instance. The returned backup list is sorted in descending order from start time of backup (backupStartTime).
- Support SQL Server Only

Request method

GET

Request address

https://rds.jdcloud-api.com/v1/regions/{regionId}/backups

Name Type Required or not Default value Description
regionId String True Region code, with range detailed in Regions and Availability Zone Comparison Table

Request parameter

Name Type Required or not Default value Description
instanceId String True RDS instance ID can identify an instance uniquely
auto Integer False Query the backup type, 0 for manual backup, 1 for automatic backup, not for all.
- Test parameters, only support SQL Server, and may be replaced by other parameters later
backupTypeFilter String False Return a list of backups with backupType equal to the specified value. Full is a full backup, and diff is an incremental backup
- Test parameters, only support SQL Server, and may be replaced by other parameters later
dbNameFilter String False Return a list of backups whose dbName is equal to the specified value. Return all if not for all or empty
- Test parameters, only support SQL Server, and may be replaced by other parameters later
backupTimeRangeStartFilter String False Return the backup list whose start time of backup is longer than this time
- Test parameters, only support SQL Server, and may be replaced by other parameters later
backupTimeRangeEndFilter String False Return the backup list whose backup start time is shorter than or equal to this time
-Test parameters, only support SQL Server, and may be replaced by other parameters later
pageNumber Integer True Display the page number of the data. The default is 1, and the value range is [-1, ∞). When pageNumber is -1, return all data page numbers; when the total number of pages is exceeded, display the last page.
pageSize Integer True The default of the number of data displayed per page is 10, and the value range is [1,100], which can only be a multiple of 10.

Response parameter

Name Type Description
result Result

Result

Name Type Description
backup Backup[ ] Backup Collection
totalCount Integer Total Number of Records

Backup

Name Type Description
backupId String Backup ID
backupName String Backup name with length up to 64 English characters or Chinese characters of equal length
instanceId String Backup Instance ID
backupStatus String Backup Status, detailed in Enumeration Parameter Definition
backupStartTime String Backup Start Time, Format: YYYY-MM-DD HH:mm:ss
backupEndTime String Backup End Time, Format: YYYY-MM-DD HH:mm:ss
backupType String Backup type, full backup or incremental backup, detailed in Enumeration Parameter Definition
- SQL Server supports**
- MySQL does not support
backupMode String Backup mode, automatic system backup or manual backup, detailed in Enumeration Parameter Definition
backupUnit String Backup granularity, instance backup or multi-database backup, detailed in Enumeration Parameter Definition
- SQL Server supports
- MySQL does not support
backupFiles String[ ] Backup File List
- SQL Server supports, there can be multiple backup files and the naming rules for file name are:
(1) Full: Database name +.bak
(2) Incremental: Database name +.diff
- MySQL does not support
backupSizeByte Integer Size of Whole Backup Set, Unit: Byte

Response code

Return code Description
200 OK
Update Time:2019-07-11 18:54:31