All Products
Search
Document Center

DescribeBackups

Last Updated: Aug 05, 2020

Queries the backup sets of an AnalyticDB for MySQL cluster.

Request parameters

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeBackupsThe operation that you want to perform. Set the value to DescribeBackups

DBClusterIdStringYesam-bp1xxxxxxxx47The ID of the cluster whose backup sets are to be queried.
BackupIdStringNo327329803The ID of the backup set whose information is to be queried.
StartTimeStringYes2011-06-01T16:00ZThe beginning of the time range to query. Format: yyyy-MM-ddTHH:mmZ
EndTimeStringYes2011-06-15T16:00ZThe end of the time range to query. The end time must be later than the start time. Format: yyyy-MM-ddTHH:mmZ
PageSizeIntegerNo30The number of entries to return on each page. Valid values:
  • 30
  • 50
  • 100
Default value: 30
PageNumberIntegerNo1The number of the page to return. Valid values: any positive integer Default value: 1

Response parameters

ParameterTypeExampleDescription
TotalCountString300The total number of entries returned.
PageNumberString10The page number of the page returned.
PageSizeString30The number of entries on the page returned.
RequestIdString1AD222E9-E606-4A42-BF6D-8A4442913CEFThe ID of the request.
ItemsList<Backup>-The information about backup sets.

Backup

ParameterTypeExampleDescription
BackupIdString327329803The ID of a backup set.
DBClusterIdStringam-bp1xxxxxxxx47The ID of the cluster.
BackupStartTimeString2011-05-30T03:29:00ZThe time when the backup started. Format: “YYYY-MM-DD’T’HH:mm:ssZ”
BackupEndTimeString2011-05-30T03:29:00ZThe time when the backup ended. Format: “YYYY-MM-DD’T’HH:mm:ssZ”
BackupType String FullBackup The type of the backup. Valid values:
  • FullBackup: full backup
  • IncrementalBackup: incremental backup
BackupSize Long 2167808 The size of the backup file. Unit: bytes
BackupMethod String Snapshot The method used for the backup.

The value is Snapshot.

Examples

Sample requests

  1. http(s)://[Endpoint]/?Action=DescribeBackups
  2. &DBClusterId=am-bpxxxxxxx
  3. &EndTime=2019-07-27T15:00Z
  4. &StartTime=2019-07-01T15:00Z
  5. &<Common request parameters>

Sample success responses

XML format

  1. <DescribeBackupsResponse>
  2. <Items>
  3. <Backup>
  4. <BackupType>FullBackup</BackupType>
  5. <BackupEndTime>2019-07-07T19:02:56Z</BackupEndTime>
  6. <BackupMethod>Snapshot</BackupMethod>
  7. <BackupSize>214748364800</BackupSize>
  8. <DBClusterId>am-bpxxxxxxxxxxxxxxxx</DBClusterId>
  9. <BackupStartTime>2019-07-07T18:00:25Z</BackupStartTime>
  10. <BackupId>493504366</BackupId>
  11. </Backup>
  12. </Items>
  13. <PageNumber>1</PageNumber>
  14. <TotalCount>1</TotalCount>
  15. <PageSize>30</PageSize>
  16. <RequestId>9B2F9613-292E-45E3-9653-47857255B33C</RequestId>
  17. </DescribeBackupsResponse>