edit-icon download-icon

DescribeBackups

Last Updated: Mar 21, 2018

Description

This API is used to query the details of a backup file, including the backup start time, file size, backup mode, download address, and other information.

Request parameters

Name Type Required Description
Common request parameters - Yes For more information, see Common request parameters.
Action String Yes Required parameter. Value: DescribeBackups.
InstanceId String Yes Instance ID
BackupId String No Backup set ID
PagSize String Yes Number of records per page. Supported values: 30, 50, and 100.
PageNumber String Yes Page number. It must be greater than 0 and cannot exceed the maximum value of the given Integer.
StartTime String Yes Query start time
EndTime String Yes Query end time

Response parameters

Name Type Description
Common return parameters - For more information, see Common return parameters.
Backups List Array composed of Backups
PageNumber Integer Page number
TotalCount Integer Total number of backups
PageSize Integer Number of records per page

Backup parameter structure

Name Type Description
BackupId String Backup set ID
BackupDBNames String Backup database name
BackupStatus String Backup set status:

- Success
- Failed
BackupStartTime String Backup start time
BackupEndTime String Backup end time
BackupType String Backup type:

- FullBackup
- IncrementalBackup
BackupMode String Backup mode:

- Automated
- Manual
BackupMethod String Backup method:

- Logical
- Physical
BackupDownloadURL String Download address of the backup file
BackupSize String Backup size

Example

Request example

  1. https://r-kvstore.aliyuncs.com
  2. ?<Common request parameters>
  3. &Action= DescribeBackups
  4. &InstanceId= de5d88e34d004211
  5. & PageNumber=1
  6. &PageSize=10
  7. &InstanceId=de5d88e34d004211

Response example

  1. {
  2. {
  3. " Backups " : {
  4. " Backup " : [{
  5. BackupId":"187709043",
  6. "BackupDBNames":"all",
  7. "BackupStatus":"Success",
  8. BackupType”:” FullBackup”,
  9. "BackupStartTime":"2017-10-18T10:34:52Z",
  10. "BackupEndTime":"2017-10-18T10:36:06Z",
  11. "BackupMode":"Manual",
  12. "BackupMethod":"Physical",
  13. "BackupDownloadURL":"https://rdsbak-st-v2.oss-cn-shenzhen.aliyuncs.com/custins4588367/hins3402581_data_20171018183408.rdb?OSSAccessKeyId=LTAITfQ7krsrEwRn&Expires=1508409386&Signature=rYyFYVdMOhhTJ0TAPafGc6oJSuk%3D",
  14. "BackupSize":"1024"
  15. }
  16. ]
  17. },
  18. "PageNumber" : 1,
  19. "PageSize" : 10,
  20. "TotalCount" : 1,
  21. "RequestId" : "5C97648D-C85F-4D58-A71F-7B6750856BF7
  22. }
Thank you! We've received your feedback.