All Products
Search
Document Center

ApsaraDB RDS:ModifyBackupPolicy

Last Updated:Mar 22, 2024

Modifies the backup policy settings of an instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB

References

Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rds:ModifyBackupPolicyWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxxx
BackupPolicyModestringNo

The type of the backup. Valid values:

  • DataBackupPolicy: data backup
  • LogBackupPolicy: log backup
DataBackupPolicy
PreferredBackupTimestringNo

The 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
  • This parameter must be specified when BackupPolicyMode is set to DataBackupPolicy.
  • This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
  • 00:00Z-01:00Z
    PreferredBackupPeriodstringNo

    The backup cycle. Specify at least two days of the week and separate the days with commas (,). Valid values:

    • Monday
    • Tuesday
    • Wednesday
    • Thursday
    • Friday
    • Saturday
    • Sunday
    Note
  • You can configure a backup policy by using 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 every 30 minutes on every Saturday and Sunday.
  • This parameter must be specified when BackupPolicyMode is set to DataBackupPolicy.
  • This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
  • Monday
    BackupRetentionPeriodstringNo

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

    Note
  • This parameter must be specified when BackupPolicyMode is set to DataBackupPolicy.
  • This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
  • 7
    BackupLogstringNo

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

    • Enable: enables the feature.
    • Disabled: disables the feature.
    Note
  • This parameter must be specified when BackupPolicyMode is set to DataBackupPolicy.
  • This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
  • Enable
    LogBackupRetentionPeriodstringNo

    The number of days for which the log backup is retained. 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 parameter is supported for instances that run MySQL and PostgreSQL.
  • This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy or LogBackupPolicy.
  • 7
    EnableBackupLogstringNo

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

    • True or 1: enables the feature.
    • False or 0: disables the feature.
    Note
  • This parameter must be specified when BackupPolicyMode is set to LogBackupPolicy.
  • This parameter takes effect only when BackupPolicyMode is set to LogBackupPolicy.
  • 1
    LocalLogRetentionHoursstringNo

    The number of hours for which you want to retain log backup files on the instance. Valid values: 0 to 168. The value 0 specifies that log backup files are not retained on the instance. The value 168 is calculated based on the following formula: 7 × 24.

    Note
  • This parameter must be specified when BackupPolicyMode is set to LogBackupPolicy.
  • This parameter takes effect only when BackupPolicyMode is set to LogBackupPolicy.
  • 18
    LocalLogRetentionSpacestringNo

    The maximum storage usage that is allowed for log backup files on the instance. If the storage usage for log backup files on the instance exceeds the value of this parameter, the system 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
  • This parameter must be specified when BackupPolicyMode is set to LogBackupPolicy.
  • This parameter takes effect only when BackupPolicyMode is set to LogBackupPolicy.
  • 30
    HighSpaceUsageProtectionstringNo

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

    Note
  • This parameter must be specified when BackupPolicyMode is set to LogBackupPolicy.
  • This parameter takes effect only when BackupPolicyMode is set to LogBackupPolicy.
  • Enable
    LogBackupFrequencystringNo

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

    • LogInterval: A log backup is performed every 30 minutes.
    • The default value is the same as the data backup frequency.
    Note
  • The value LogInterval is supported only for instances that run SQL Server.
  • This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
  • LogInterval
    CompressTypestringNo

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

    • 0: Backups are not compressed.
    • 1: The zlib tool is used to compress backups into .tar.gz files.
    • 2: The zlib tool is used to compress backups in parallel.
    • 4: The QuickLZ tool is used to compress backups into .xb.gz files. This compression format is supported for instances that run MySQL 5.6 or MySQL 5.7. Backups in this compression format can be used to restore individual databases and tables. For more information, see Restore individual databases and tables of an ApsaraDB RDS for MySQL instance.
    • 8: The QuickLZ tool is used to compress backups into .xb.gz files. This compression format is supported only for instances that run MySQL 8.0. Backups in this compression format cannot be used to restore individual databases and tables.
    Note This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
    4
    ArchiveBackupRetentionPeriodstringNo

    The number of days for which the archived backup is retained. The default value 0 specifies that the backup archiving feature is disabled. Valid values: 30 to 1095.

    Note This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
    365
    ArchiveBackupKeepPolicystringNo

    The retention period of archived backup files. The number of archived backup files that can be retained within the specified retention period is specified by ArchiveBackupKeepCount. Default value: 0. Valid values:

    • ByMonth
    • ByWeek
    • KeepAll
    Note This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
    ByMonth
    ArchiveBackupKeepCountintegerNo

    The number of archived backup files that are retained. Default value: 1. Valid values:

    • Valid values when ArchiveBackupKeepPolicy is set to ByMonth: 1 to 31.
    • Valid values when ArchiveBackupKeepPolicy is set to ByWeek: 1 to 7.
    Note
  • You do not need to specify this parameter when ArchiveBackupKeepPolicy is set to KeepAll.
  • This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
  • 1
    ReleasedKeepPolicystringNo

    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 BackupPolicyMode is set to DataBackupPolicy.
    None
    LogBackupLocalRetentionNumberintegerNo

    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 BackupPolicyMode is set to LogBackupPolicy.
  • If the instance runs MySQL, you can set this parameter to **-1**. The value -1 specifies that no limits are imposed on the number of binary log files retained on the instance.
  • 60
    CategorystringNo

    Specifies whether to enable the single-digit second backup feature. Valid values:

    • Flash: enables the feature.
    • Standard: disables the feature.
    Note This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
    Standard
    BackupIntervalstringNo

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

    • -1: No backup frequencies are specified.
    • 30: A snapshot backup is performed every 30 minutes.
    • 60: A snapshot backup is performed every 60 minutes.
    • 120: A snapshot backup is performed every 120 minutes.
    • 240: A snapshot backup is performed every 240 minutes.
    • 480: A snapshot backup is performed every 480 minutes.
    Note
  • You can configure a backup policy by using this parameter and the PreferredBackupPeriod parameter. For example, if you set PreferredBackupPeriod to Saturday,Sunday and BackupInterval to **-1**, a snapshot backup is performed on every Saturday and Sunday.
  • If the instance runs PostgreSQL, BackupInterval is supported only when the instance is equipped with cloud disks.
  • If the instance runs SQL Server, BackupInterval is supported only when the snapshot backup feature is enabled for the instance. For more information, see Enable snapshot backups for an ApsaraDB RDS for SQL Server instance.
  • If Category is set to Flash, BackupInterval is invalid.
  • This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
  • 30
    BackupMethodstringNo

    The backup method of the instance. Valid values:

    • Physical: physical backup
    • Snapshot: snapshot backup

    Default value: Physical.

    Note
  • This parameter takes effect only on instances that run SQL Server with cloud disks.
  • This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
  • Physical
    EnableIncrementDataBackupbooleanNo

    Specifies whether to enable incremental backup. Valid values:

    • false (default): disables the feature.
    • true: enables the feature.
    Note
  • This parameter takes effect only on instances that run SQL Server with cloud disks.
  • This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy.
  • false
    BackupPriorityintegerNo

    Specifies whether the backup settings of a secondary instance are configured. Valid values:

    • 1: secondary instance preferred
    • 2: primary instance preferred
    Note
  • This parameter is suitable only for instances that run SQL Server on RDS Cluster Edition.
  • This parameter takes effect only when BackupMethod is set to Physical. If BackupMethod is set to Snapshot, backups are forcefully performed on the primary instance that runs SQL Server on RDS Cluster Edition.
  • 2

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    DA147739-AEAD-4417-9089-65E9B1D8240D
    CompressTypestring

    The method that is used to compress backups. Valid values:

    • 0: Backups are not compressed.
    • 1: Backups are compressed by using the zlib tool.
    • 2: Backups are compressed in parallel by using the zlib tool.
    • 4: Backups are compressed by using the QuickLZ tool and can be used to restore individual databases and tables.
    • 8: Backups are compressed by using the QuickLZ tool but cannot be used to restore individual databases or tables. This value is supported only for instances that run MySQL 8.0.
    4
    LocalLogRetentionSpacestring

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

    30
    LogBackupLocalRetentionNumberinteger

    The number of binary log files on the instance.

    60
    DBInstanceIDstring

    The instance ID.

    rm-uf6wjk5xxxxxxx
    EnableBackupLogstring

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

    • 1: The feature is enabled.
    • 0: The feature is disabled.
    1
    LocalLogRetentionHoursinteger

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

    18
    HighSpaceUsageProtectionstring

    Specifies whether to forcefully delete log backup files from the instance when the storage usage of the instance exceeds 80% or the amount of remaining storage on the instance is less than 5 GB.

    Disable

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "DA147739-AEAD-4417-9089-65E9B1D8240D",
      "CompressType": "4",
      "LocalLogRetentionSpace": "30",
      "LogBackupLocalRetentionNumber": 60,
      "DBInstanceID": "rm-uf6wjk5xxxxxxx",
      "EnableBackupLog": "1",
      "LocalLogRetentionHours": 18,
      "HighSpaceUsageProtection": "Disable"
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidColdRetention.FormatInvalid cold retention format.-
    400InvalidLogBackupFrequency.MalformedInvalid log backup frequency.The value of the LogBackupFrequency parameter is invalid. Check the value of this parameter.
    400InvalidBackupRetentionPeriod.MalformedThe specified backup retention period is invalid.The backup cycle is left unspecified. Specify a backup cycle in the range of 1 day to 30 days.
    400BackupPropertyNotFoundBackup policy not foundThe operation failed. The backup policy cannot be found.
    400OperationDenied.SwitchToSnapshotSnapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode.Snapshot backups cannot be stored across regions. Disable cross-region backup first and then switch to the snapshot backup mode.
    400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.-
    403IncorrectCategoryCurrent Instance type does not support Category.The category is not supported for the specified instance type.
    403OperationDenied.SwitchSnapshotToPhysicalOnly physical backup to snapshot backup is supported.The current operation only supports physical backups to snapshot backups.
    403OperationDenied.ModifyBackupSwitchOffThe switch is not turned on. It is forbidden to modify the backup mode.Cross-region backup is not enabled.
    403OperationDenied.ApiForbiddenForLogBackupFrequencyWhen the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup.When the instance is in snapshot backup mode, the log backup frequency must not be Same as Data Backup.
    403OperationDenied.NotSupportedBackupMethodWhen the storage is larger than 4000 GB, only snapshot backup is supported.If the storage capacity is larger than 4,000 GB, only snapshot backup is supported.
    403OperationDenied.ApiForbiddenOperation is not permitted.The operation is not supported.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-06-29The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: BackupPriority
    2022-05-10The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403