Queries the backup settings of an AnalyticDB for MySQL cluster.
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | Yes | DescribeBackupPolicy | The operation that you want to perform. Set the value to DescribeBackupPolicy |
| DBClusterId | String | Yes | am-bp1xxxxxxxx47 | The ID of the cluster whose backup settings are to be queried. |
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| BackupRetentionPeriod | Integer | 7 | The retention period of data backups. |
| PreferredBackupTime | String | 15:00Z-16:00Z | The time range in which data is backed up. Format: HH:mmZ-HH:mmZ |
| PreferredBackupPeriod | String | 30 | The day on which data is backed up. Separate multiple values with commas (,). Valid values:
|
| LogBackupRetentionPeriod | Integer | 7 | The retention period of log backups. |
| EnableBackupLog | Boolean | true | Indicates whether the log backup feature was enabled. Valid values:
|
| RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF | The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeBackupPolicy&DBClusterId=am-bpxxxxxxx&<Common request parameters>
Sample success responses
XML format
<DescribeBackupPolicyResponse><LogBackupRetentionPeriod>7</LogBackupRetentionPeriod><PreferredBackupPeriod>Tuesday,Friday</PreferredBackupPeriod><RequestId>A28C9818-7C4F-4747-8525-55CB527DEEE8</RequestId><EnableBackupLog>true</EnableBackupLog><PreferredBackupTime>18:00Z-19:00Z</PreferredBackupTime><BackupRetentionPeriod>7</BackupRetentionPeriod></DescribeBackupPolicyResponse>
JSON format
{"LogBackupRetentionPeriod": 7,"PreferredBackupPeriod": "Tuesday,Friday","RequestId": "A28C9818-7C4F-4747-8525-55CB527DEEE8","EnableBackupLog": true,"PreferredBackupTime": "18:00Z-19:00Z","BackupRetentionPeriod": 7}