Queries the automatic backup policy of a PolarDB cluster.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | DescribeBackupPolicy |
The operation that you want to perform. Set the value to DescribeBackupPolicy. |
DBClusterId | String | Yes | pc-************* |
The ID of the cluster. Note You can call the DescribeDBClusters operation to query information about all clusters that are deployed in a specified
region, such as the cluster ID.
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
BackupFrequency | String | Normal |
The backup frequency. Valid values:
Note
|
BackupRetentionPolicyOnClusterDeletion | String | NONE |
Specifies whether to retain backups when you delete a cluster. Valid values:
|
DataLevel1BackupRetentionPeriod | String | 7 |
The retention period of level-1 backups. Valid values: 3 to 14. Unit: days. |
DataLevel2BackupRetentionPeriod | String | 0 |
The retention period of level-2 backups. Valid values:
|
PreferredBackupPeriod | String | Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday |
The backup cycle. Valid values:
|
PreferredBackupTime | String | 07:00Z-08:00Z |
The time period during which automatic backup was performed. The start time and the end time are displayed in UTC. |
PreferredNextBackupTime | String | 2020-11-16T07:30Z |
The start time for the next backup. The time is displayed in UTC. |
RequestId | String | EADFCE0F-9FB5-4685-B395-1440B****** |
The ID of the request. |
Examples
Sample requests
http(s)://polardb.aliyuncs.com/? Action=DescribeBackupPolicy
&DBClusterId=pc-*************
&<Common request parameters>
Sample success responses
XML
format
<DescribeBackupPolicyResponse>
<PreferredBackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</PreferredBackupPeriod>
<DataLevel1BackupRetentionPeriod>7</DataLevel1BackupRetentionPeriod>
<RequestId>1CB29F6D-2FFE-49F5-B8D9-D3469F******</RequestId>
<BackupRetentionPolicyOnClusterDeletion>NONE</BackupRetentionPolicyOnClusterDeletion>
<PreferredBackupTime>07:00Z-08:00Z</PreferredBackupTime>
<BackupFrequency>Normal</BackupFrequency>
<PreferredNextBackupTime>2020-11-16T07:30Z</PreferredNextBackupTime>
<BackupRetentionPeriod>7</BackupRetentionPeriod>
<DataLevel2BackupRetentionPeriod>0</DataLevel2BackupRetentionPeriod>
</DescribeBackupPolicyResponse>
JSON
format
{
"PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
"DataLevel1BackupRetentionPeriod": 7,
"RequestId": "1CB29F6D-2FFE-49F5-B8D9-D3469F******",
"BackupRetentionPolicyOnClusterDeletion": "NONE",
"PreferredBackupTime": "07:00Z-08:00Z",
"BackupFrequency": "Normal",
"PreferredNextBackupTime": "2020-11-16T07:30Z",
"BackupRetentionPeriod": 7,
"DataLevel2BackupRetentionPeriod": 0
}
Error codes
For a list of error codes, visit the API Error Center.