You can call the ModifyBackupPolicy operation to modify the backup settings of an ApsaraDB RDS instance.

Before you call this operation, make sure that the following requirements are met:

  • The instance cannot be a read-only instance.
  • The instance must be in the Running state.

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 Yes ModifyBackupPolicy

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

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance.

BackupPolicyMode String No DataBackupPolicy

The type of backup that you want to perform for the instance. Valid values:

  • DataBackupPolicy: data backup
  • LogBackupPolicy: log backup
PreferredBackupTime String No 00:00Z-01:00Z

The point in time at which you want to perform a backup. Specify the time in the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time must be in UTC.

Note
  • You must specify this parameter when you set the BackupPolicyMode parameter to DataBackupPolicy.
  • This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
PreferredBackupPeriod String No Monday

The cycle based on which you want to perform a backup. Specify at least two days of the week and separate these days with commas (,). Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
Note
  • A backup policy is specified by this parameter and the BackupInterval parameter. For example, if you set this parameter to Saturday,Sunday and the BackupInterval parameter to 30, a backup is performed once every 30 minutes on every Saturday and Sunday.
  • You must specify this parameter when you set the BackupPolicyMode parameter to DataBackupPolicy.
  • This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
BackupRetentionPeriod String No 7

The number of days for which you want to retain data backup files. Valid values: 7 to 730.

Note
  • You must specify this parameter when you set the BackupPolicyMode parameter to DataBackupPolicy.
  • This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
BackupLog String No Enable

Specifies whether to enable the log backup feature. Valid values:

  • Enable
  • Disabled
Note
  • You must specify this parameter when you set the BackupPolicyMode parameter to DataBackupPolicy.
  • This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
LogBackupRetentionPeriod String No 7

The number of days for which you want to retain log backup files. Valid values: 7 to 730. The log backup retention period cannot be longer than the data backup retention period.

Note
  • If you enable the log backup feature, you can specify the log backup retention period. This applies only when the instance runs MySQL, PostgreSQL, or PPAS.
  • This parameter takes effect when you set the BackupPolicyMode parameter to DataBackupPolicy or LogBackupPolicy.
EnableBackupLog String No 1

Specifies whether to enable the log backup feature. Valid values:

  • True or 1: specifies to enable the log backup feature.
  • False or 0: specifies to disable the log backup feature.
Note
  • You must specify this parameter when you set the BackupPolicyMode parameter to LogBackupPolicy.
  • This parameter takes effect only when you set the BackupPolicyMode parameter to LogBackupPolicy.
LocalLogRetentionHours String No 18

The number of hours for which you want to retain log backup files on the instance. Valid values: 0 to 7 × 24. The value 0 specifies not to retain log backup files on the instance.

Note
  • You must specify this parameter when you set the BackupPolicyMode parameter to LogBackupPolicy.
  • This parameter takes effect only when you set the BackupPolicyMode parameter to LogBackupPolicy.
LocalLogRetentionSpace String No 30

The maximum storage usage that is allowed for log backup files on the instance. If the storage usage for log backup files exceeds the value of this parameter, ApsaraDB RDS deletes earlier log backup files until the storage usage falls below the value of this parameter. Valid values:0 to 50. You can retain the default value.

Note
  • You must specify this parameter when you set the BackupPolicyMode parameter to LogBackupPolicy.
  • This parameter takes effect only when you set the BackupPolicyMode parameter to LogBackupPolicy.
HighSpaceUsageProtection String No Enable

Specifies whether to forcibly delete log backup files when the storage usage of the instance exceeds 80% or the remaining storage space is less than 5 GB. Valid values: Enable and Disable. You can retain the default value.

Note
  • You must specify this parameter when you set the BackupPolicyMode parameter to LogBackupPolicy.
  • This parameter takes effect only when you set the BackupPolicyMode parameter to LogBackupPolicy
LogBackupFrequency String No LogInterval

The frequency at which you want to back up binary logs on the instance. Valid values:

  • The value LogInterval specifies to back up binary logs every 30 minutes.
  • The default value is the same as the data backup frequency.
Note
  • The value LogInterval is supported only when the instance runs SQL Server.
  • This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
CompressType String No 4

The format that is used to compress backup data. Valid values:

  • 1: The zlib tool is used to compress data into .tar.gz files.
  • 4: The QuickLZ tool is used to compress data into .xb.gz files. This compression format is supported only when the instance runs MySQL 5.6 or 5.7. Backup files in this compression format can be used to restore individual databases and tables. For more information, see ~~103175~~.
  • 8: The QuickLZ tool is used to compress data into .xb.gz files. This compression format is supported only when the instance runs MySQL 8.0. This compression format cannot be used to restore individual databases or tables.
Note This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
ArchiveBackupRetentionPeriod String No 365

The number of days for which you want to retain archived backup files. The default value 0 specifies that the backup archive feature is not enabled. Valid values: 30 to 1095.

Note This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
ArchiveBackupKeepPolicy String No ByMonth

The period of time for which you want to retain archived backup files. The number of archived backup files that can be retained within the specified period of time is specified by the ArchiveBackupKeepCount parameter. Default value: 0. Valid values:

  • ByMonth
  • ByWeek
  • KeepAll
Note This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
ArchiveBackupKeepCount Integer No 1

The number of archived backup files that can be retained on the instance. Default value: 1. Valid values:

  • If you set the ArchiveBackupKeepPolicy parameter to ByMonth, the value of the ArchiveBackupKeepCount parameter ranges from 1 to 31
  • If you set the ArchiveBackupKeepPolicy parameter to ByWeek, the value of the ArchiveBackupKeepCount parameter ranges from 1 to 7.
Note
  • If you set the ArchiveBackupKeepPolicy parameter to KeepAll, you do not need to specify the ArchiveBackupKeepCount parameter.
  • This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
ReleasedKeepPolicy String No None

The policy that is used to retain archived backup files if the instance is released. Default value: None. Valid values:

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All archived backup files are retained.
Note This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
LogBackupLocalRetentionNumber Integer No 60

The number of binary log files that you want to retain on the instance. Default value: 60. Valid values: 6 to 100.

Note This parameter takes effect only when you set the BackupPolicyMode parameter to LogBackupPolicy.
Category String No Standard

Specifies whether to enable the single-digit second backup feature. This feature allows ApsaraDB RDS to complete a backup within single-digit seconds. Valid values:

  • Flash: specifies to enable the single-digit second backup feature.
  • Standard: specifies to disable the single-digit second backup feature.
Note This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
BackupInterval String No 30

The frequency at which you want to perform a snapshot backup on the instance. Valid values:

  • -1: No backup frequencies are specified.
  • 30: every 30 minutes.
  • 60: every 60 minutes.
  • 120: every 120 minutes.
  • 240: every 240 minutes.
  • 480: every 480 minutes.
Note
  • A backup policy is specified by this parameter and the PreferredBackupPeriod parameter. For example, if you set the PreferredBackupPeriod parameter to Saturday,Sunday and the BackupInterval parameter to -1, a snapshot backup is performed on every Saturday and Sunday.
  • If the instance runs PostgreSQL, the BackupInterval parameter is supported only when the instance uses standard or enhanced SSDs.
  • If the instance runs SQL server, the BackupInterval parameter is supported only when the snapshot backup feature is enabled for the instance. For more information, see Snapshot backup.
  • If you set the Category parameter to Flash, the BackupInterval parameter is invalid.
  • This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
BackupMethod String No Physical

The method that is used to back up the instance. Valid values:

  • Physical: physical backup
  • Snapshot: snapshot backup

Default value: Physical.

Note
  • This parameter takes effect only when the instance runs SQL Server with standard or enhanced SSDs.
  • This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.

Response parameters

Parameter Type Example Description
CompressType String 4

The format that is used to compress backup data. Valid values:

  • 0: Backup data is not compressed.
  • 1: Backup data is compressed by using zlib.
  • 2: Backup data is compressed by using zlib that invokes more than one thread in parallel for each backup.
  • 4: Backup data is compressed by using QuickLZ and can be used to restore individual databases or tables.
  • 8: Backup data is compressed by using QuickLZ but cannot be used to restore individual databases or tables. This value is supported only when the instance runs MySQL 8.0.
DBInstanceID String rm-uf6wjk5xxxxxxx

The ID of the instance.

EnableBackupLog String 1

Indicates whether the log backup feature is enabled. Valid values:

  • 1: The log backup feature is enabled.
  • 0: The log backup feature is disabled.
HighSpaceUsageProtection String Disable

Indicates whether to forcibly delete log backup files when the storage usage of the instance exceeds 80% or the remaining storage space is less than 5 GB.

LocalLogRetentionHours Integer 18

The number of hours for which log backup files can be retained on the instance.

LocalLogRetentionSpace String 30

The maximum storage usage for log backup files on the instance.

LogBackupLocalRetentionNumber Integer 60

The number of log backup files that can be retained on the instance.

RequestId String DA147739-AEAD-4417-9089-65E9B1D8240D

The ID of the request.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=ModifyBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Sample success responses

XML format

<ModifyBackupPolicyResponse>
        <HighSpaceUsageProtection>Disable</HighSpaceUsageProtection>
      <DBInstanceID>rm-bp1z3xxxxx</DBInstanceID>
      <RequestId>E4BF5598-ED12-4406-AAA4-F375428BE741</RequestId>
      <LocalLogRetentionHours>18</LocalLogRetentionHours>
      <EnableBackupLog>1</EnableBackupLog>
      <LocalLogRetentionSpace>30</LocalLogRetentionSpace>
      <LogBackupLocalRetentionNumber>60</LogBackupLocalRetentionNumber>
</ModifyBackupPolicyResponse>

JSON format

{
    "HighSpaceUsageProtection": "Disable",
    "DBInstanceID": "rm-bp1z3xxxxx",
    "RequestId": "E4BF5598-ED12-4406-AAA4-F375428BE741",
    "LocalLogRetentionHours": "18",
    "EnableBackupLog": "1",
    "LocalLogRetentionSpace": "30",
    "LogBackupLocalRetentionNumber": 60
}

Error codes

HTTP status code Error code Error message Description
400 InvalidBackupRetentionPeriod.Malformed The specified backup retention period is invalid. The error message returned because the specified backup retention period is invalid.

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