Modifies the automatic backup policy of a PolarDB cluster.

You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see Back up data.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No ModifyBackupPolicy

The operation that you want to perform. Set the value to ModifyBackupPolicy.

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.
PreferredBackupPeriod String No Monday,Tuesday

The backup cycle. Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
Note Select at least two values. Separate multiple values with commas (,).
PreferredBackupTime String No 15:00Z-16:00Z

The time period during which automatic backup is performed. The value must be in the hh:mmZ-hh:mmZ format. The time must be in UTC. The start time and end time must be on the hour and with an interval of one hour. For example, 14:00Z-15:00Z.

DataLevel1BackupRetentionPeriod String No 3

The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

DataLevel2BackupRetentionPeriod String No 0

The retention period of level-2 backups. Valid values:

  • 0: The level-2 backup feature is disabled.
  • 30 to 7300: Level-2 backups are retained for 30 to 7,300 days.
  • -1: Level-2 backups are permanently retained.
    Note The default value is 0. By default, the level-2 backup feature is disabled when you create a cluster.
BackupRetentionPolicyOnClusterDeletion String No NONE

Specifies whether to retain backups when you delete a cluster. Valid values:

  • ALL: permanently retains all backups.
  • LATEST: permanently retains the last backup.
  • NONE: does not retain backups.
    Note The default value is NONE.
BackupFrequency String No Normal

The backup frequency. Valid values:

  • Normal (default): standard backup. The system backs up data once a day.
  • 2/24H: enhanced backup. The system backs up data every 2 hours.
  • 3/24H: The enhanced backup. The system backs up data every 3 hours.
  • 4/24H: The enhanced backup. The system backs up data every 4 hours.
Note
  • After you enable enhanced backup, all backups are retained for 24 hours. Backups are automatically deleted when the retention period expires. However, the system permanently retains the first backup that is created after 00:00:00 every day.
  • After you enable enhanced backup, the PreferredBackupPeriod parameter is automatically set to all days in a week (from Monday to Sunday).

Response parameters

Parameter Type Example Description
RequestId String C5A5DF0E-5968-4DC1-882E-AC2FE7******

The ID of the request.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=ModifyBackupPolicy
&DBClusterId=pc-bp13wz9586voc****
&PreferredBackupTime=15:00Z-16:00Z
&PreferredBackupPeriod=Monday,Tuesday
&DataLevel1BackupRetentionPeriod=3
&DataLevel2BackupRetentionPeriod=0
&BackupRetentionPolicyOnClusterDeletion=NONE
&BackupFrequency=Normal
&<Common request parameters>

Sample success responses

XML format

<ModifyBackupPolicyResponse>
  <RequestId>C5A5DF0E-5968-4DC1-882E-AC2FE7******</RequestId>
</ModifyBackupPolicyResponse>

JSON format

{
    "RequestId":"C5A5DF0E-5968-4DC1-882E-AC2FE7******"
}

Error codes

For a list of error codes, visit the API Error Center.