You can call this operation to query the backup settings of an AnalyticDB for MySQL cluster.
Debugging
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. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
BackupRetentionPeriod | Integer | 7 |
The number of days for which data backup files are retained. |
EnableBackupLog | String | true |
Specifies whether to enable the origin protocol policy.
|
LogBackupRetentionPeriod | Integer | 7 |
The number of days for which log backup files are retained. |
PreferredBackupPeriod | String | Tuesday,Friday |
The cycle based on which backups are performed. If more than one day of the week is specified, the days of the week are separated by commas (,). Valid values:
|
PreferredBackupTime | String | 15:00Z-16:00Z |
The backup time. Specify the time in the HH:mmZ-HH:mmZ format. |
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeBackupPolicy
&DBClusterId=am-bp1xxxxxxxx47
&<Common request parameters>
Sample success responses
XML
format
<PreferredBackupPeriod>Tuesday,Friday</PreferredBackupPeriod>
<LogBackupRetentionPeriod>7</LogBackupRetentionPeriod>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<PreferredBackupTime>15:00Z-16:00Z</PreferredBackupTime>
<EnableBackupLog>true</EnableBackupLog>
<BackupRetentionPeriod>7</BackupRetentionPeriod>
JSON
format
{
"PreferredBackupPeriod": "Tuesday,Friday",
"LogBackupRetentionPeriod": 7,
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"PreferredBackupTime": "15:00Z-16:00Z",
"EnableBackupLog": true,
"BackupRetentionPeriod": 7
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The error message returned because the specified DBClusterId parameter does not exist. Check whether you specify the DBClusterId parameter correctly. |
For a list of error codes, visit the API Error Center.