All Products
Document Center


Last Updated: Aug 04, 2020

Queries the backup settings of an AnalyticDB for MySQL cluster.

Request parameters

ActionStringYesDescribeBackupPolicyThe operation that you want to perform. Set the value to DescribeBackupPolicy

DBClusterIdStringYesam-bp1xxxxxxxx47The ID of the cluster whose backup settings are to be queried.

Response parameters

BackupRetentionPeriodInteger7The retention period of data backups.
PreferredBackupTimeString15:00Z-16:00ZThe time range in which data is backed up. Format: HH:mmZ-HH:mmZ
PreferredBackupPeriodString30The day on which data is backed up. Separate multiple values with commas (,). Valid values:
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
LogBackupRetentionPeriodInteger7The retention period of log backups.
EnableBackupLogBooleantrueIndicates whether the log backup feature was enabled. Valid values:
  • true: enabled
  • false: disabled
RequestIdString1AD222E9-E606-4A42-BF6D-8A4442913CEFThe ID of the request.


Sample requests

  1. http(s)://[Endpoint]/?Action=DescribeBackupPolicy
  2. &DBClusterId=am-bpxxxxxxx
  3. &<Common request parameters>

Sample success responses

XML format

  1. <DescribeBackupPolicyResponse>
  2. <LogBackupRetentionPeriod>7</LogBackupRetentionPeriod>
  3. <PreferredBackupPeriod>Tuesday,Friday</PreferredBackupPeriod>
  4. <RequestId>A28C9818-7C4F-4747-8525-55CB527DEEE8</RequestId>
  5. <EnableBackupLog>true</EnableBackupLog>
  6. <PreferredBackupTime>18:00Z-19:00Z</PreferredBackupTime>
  7. <BackupRetentionPeriod>7</BackupRetentionPeriod>
  8. </DescribeBackupPolicyResponse>

JSON format

  1. {
  2. "LogBackupRetentionPeriod": 7,
  3. "PreferredBackupPeriod": "Tuesday,Friday",
  4. "RequestId": "A28C9818-7C4F-4747-8525-55CB527DEEE8",
  5. "EnableBackupLog": true,
  6. "PreferredBackupTime": "18:00Z-19:00Z",
  7. "BackupRetentionPeriod": 7
  8. }