ModifyBackupPolicy--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

ModifyBackupPolicy

最近更新时间：2025.09.25 15:44:03首次发布时间：2023.08.14 13:15:55

调用 ModifyBackupPolicy 接口修改实例的备份策略。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-46609cf2****	实例 ID。
DataFullBackupPeriods	String[]	否	["Monday","Wednesday","Friday","Sunday"]	全量备份周期。建议每周至少选择 2 天进行全量备份，多个取值用英文逗号（,）隔开。取值： `Monday`：周一。 `Tuesday`：周二。 `Wednesday`：周三。 `Thursday`：周四。 `Friday`：周五。 `Saturday`：周六。 `Sunday`：周日。
DataBackupRetentionDay	Integer	否	7	备份文件在的保留时长。不同存储类型实例的备份保留天数取值范围不同：对于本地盘实例：可选范围为 7~3650 天，默认为 7 天。对于云盘实例：当前仅支持保留 7 天。
DataFullBackupTime	String	否	18:00Z-19:00Z	执行备份任务的时间窗，时间窗口为 1 小时。格式：`HH:mmZ-HH:mmZ`（UTC 时间）。说明 DataFullBackupStartUTCHour 和 DataFullBackupTime 均可用于指明实例的全量备份时间段。DataFullBackupStartUTCHour 具备更高优先级，如同时返回这两个字段，以 DataFullBackupStartUTCHour 为准。如需设置起点为 15:00（UTC）的时间窗，终点应设置为 15:59。
DataIncrBackupPeriods	String[]	否	["Monday","Wednesday","Friday","Sunday"]	增量备份周期，多个取值用英文逗号（,）隔开。取值： `Monday`：周一。 `Tuesday`：周二。 `Wednesday`：周三。 `Thursday`：周四。 `Friday`：周五。 `Saturday`：周六。 `Sunday`：周日。说明增量备份周期不能与全量备份冲突。
BinlogFileCountsEnable	Boolean	否	true	是否开启本地 Binlog 保留上限。取值： `true`：开启。 `false`：不开启。
BinlogLimitCount	Integer	否	10	本地 Binlog 保留个数，取值为 6~1000，单位为个。自动删除超过保留个数的本地日志。
BinlogLocalRetentionHour	Integer	否	7	本地 Binlog 保留时长，取值为 0~168，单位为小时，自动删除超过保留时长的本地日志。当设置为 0 时，不自动删除本地日志。
BinlogSpaceLimitEnable	Boolean	否	true	是否开启空间过大自动清理 Binlog。当实例总存储空间占用率超过 80% 或者剩余空间不足 5GB 时，系统会自动开始清理最早的本地 Binlog，直至总空间占用率低于 80% 且剩余空间大于 5GB。 `true`：开启。 `false`：不开启。
BinlogStoragePercentage	Integer	否	30	最大存储空间使用率，可设置 20%~50%，超出后自动删除最早的 Binlog 文件，直到空间使用率低于该比例。说明本地 Binlog 空间使用率 = 本地 Binlog 大小 / 实例总可用（购买）空间大小。
LogBackupRetentionDay	Integer	否	7	Binlog 备份保留时长。不同存储类型实例的备份保留天数取值范围不同：对于本地盘实例：可选范围为 7~3650 天，默认为 7 天。对于云盘实例：可选范围为 7~720 天，默认为 7 天。说明 LogBackupRetentionDay 在 RetentionPolicySynced 取值为 `true` 时不生效。
LockDDLTime	Integer	否	30	DDL 最长等待时间。默认值为 30，最小值为 10，最大值为 1440，单位为分钟。说明备份过程会堵塞 DDL，若堵塞时间超过指定时间，则备份会自动停止。
DataFullBackupStartUTCHour	Integer	否	16	启动全量备份任务时间窗的起点（UTC 时间）。时间窗长度为 1 小时。说明 DataFullBackupStartUTCHour 和 DataFullBackupTime 均可用于指明实例的全量备份时间段。DataFullBackupStartUTCHour 具备更高优先级，如同时返回这两个字段，以 DataFullBackupStartUTCHour 为准。
HourlyIncrBackupEnable	Boolean	否	true	是否开启本地盘实例的高频备份功能。取值： `true`：是。 `false`：否。
IncrBackupHourPeriod	Integer	否	2	本地盘实例进行高频增量备份的频率。取值： `2`：每 2 小时进行一次增量备份。 `4`：每 4 小时进行一次增量备份。 `6`：每 6 小时进行一次增量备份。 `12`：每 12 小时进行一次增量备份。说明当 HourlyIncrBackupEnable 取值为 `true` 时，IncrBackupHourPeriod 为必选。 IncrBackupHourPeriod 仅在 HourlyIncrBackupEnable 取值为 `true` 时生效。
DataBackupEncryptionEnabled	Boolean	否	true	是否为本地盘实例开启数据备份开启加密功能。取值： `true`：是。 `false`：否。说明云盘实例暂不支持该功能。
BinlogBackupEncryptionEnabled	Boolean	否	true	是否为日志备份开启加密功能。取值： `true`：是。 `false`：否。
DataKeepPolicyAfterReleased	String	否	Last	实例释放后保留该实例备份的策略。取值为： `Last`：保留最后一个备份。默认值。 `All`：保留实例所有备份。 `None`：不保留备份。
DataKeepDaysAfterReleased	Integer	否	7	实例释放时备份保留天数。支持取 7~3650 之间的整数值，默认值为 7。
DataBackupAllRetention	Boolean	否	true	是否在释放实例前保留全部数据备份。取值： `true`：是。 `false`：否。
BinlogBackupAllRetention	Boolean	否	true	是否在释放实例前保留全部日志备份。取值： `true`：是。 `false`：否。说明 BinlogBackupAllRetention 在 RetentionPolicySynced 取值为 `true` 时不生效。
BinlogBackupEnabled	Boolean	否	true	是否开启日志备份功能。取值： `true`：是。 `false`：否。
RetentionPolicySynced	Boolean	否	true	日志备份的保留策略是否与数据备份的保留策略一致。说明取值为 `true` 时忽略 LogBackupRetentionDay 和 BinlogBackupAllRetention。
HighFrequencySnapshotBackupEnable	Boolean	否	false	是否开启云盘实例的高频备份功能。取值： `true`：是。 `false`：否。
HighFrequencySnapshotBackupSecondPeriod	Integer	否	3600	云盘实例高频增量快照备份的频率，单位为秒。取值： `3600`：每 1 小时。 `7200`：每 2 小时。 `10800`：每 3 小时。 `14400`：每 4 小时。 `19200`：每 6 小时。 `28800`：每 8 小时。 `38400`：每 12 小时。
KeepCrossBackupEnableAfterReleased	Boolean	否	false	是否保留跨地域备份。取值： `true`：是。 `false`：否。说明云盘实例暂不支持该功能。

返回参数

参数	类型	示例值	描述
BinlogBackupAllRetention	Boolean	true	是否在释放实例前保留全部日志备份。取值： `true`：是。 `false`：否。
BinlogBackupEnabled	Boolean	true	是否开启日志备份功能。取值： `true`：是。 `false`：否。
BinlogBackupEncryptionEnabled	Boolean	true	是否为日志备份开启加密功能。取值： `true`：是。 `false`：否。
BinlogFileCountsEnable	Boolean	true	是否开启本地 Binlog 保留上限。取值： `true`：开启。 `false`：不开启。
BinlogLimitCount	Integer	10	本地 Binlog 保留个数，取值范围为 `6~1000`。超过指定保留个数后，会自动删除超过保留个数的本地日志。
BinlogLocalRetentionHour	Integer	7	本地 Binlog 保留时长，取值范围为 `0~168`。超过指定保留时长后，会自动删除超过保留时长的本地日志。当设置为 `0` 时，不自动删除本地日志。
BinlogSpaceLimitEnable	Boolean	true	是否开启空间过大自动清理 Binlog。当实例总存储空间占用率超过 80% 或者剩余空间不足 5GB 时，系统会自动开始清理最早的本地 Binlog，直至总空间占用率低于 80% 且剩余空间大于 5GB。
BinlogStoragePercentage	Integer	30	最大存储空间使用率，可设置 20%~50%，超出后自动删除最早的 Binlog 文件，直到空间使用率低于该比例。说明本地 Binlog 空间使用率 = 本地 Binlog 大小/实例总可用（购买）空间大小。
DataBackupAllRetention	Boolean	true	是否在释放实例前保留全部数据备份。取值： `true`：是。 `false`：否。
DataBackupEncryptionEnabled	Boolean	true	是否为本地盘实例的数据备份开启加密功能。取值： `true`：是。 `false`：否。说明云盘实例暂不支持此功能。
DataBackupRetentionDay	Integer	7	数据备份保留天数，取值：7~3650 天。默认保留 7 天。
DataFullBackupPeriods	String[]	["Monday","Wednesday","Friday",Sunday"]	全量备份周期。取值： `Monday`：周一。 `Tuesday`：周二。 `Wednesday`：周三。 `Thursday`：周四。 `Friday`：周五。 `Saturday`：周六。 `Sunday`：周日。
DataFullBackupStartUTCHour	Integer	16	启动全量备份任务时间窗的起点（UTC 时间）。时间窗长度为 1 小时。说明 DataFullBackupStartUTCHour 和 DataFullBackupTime 均可用于指明实例的全量备份时间段。DataFullBackupStartUTCHour 具备更高优先级，如同时返回这两个字段，以 DataFullBackupStartUTCHour 为准。
DataFullBackupTime	String	18:00Z-19:00Z	执行备份任务的时间窗，时间窗口为 1 小时。格式：HH:mmZ-HH:mmZ（UTC 时间）。说明 DataFullBackupStartUTCHour 和 DataFullBackupTime 均可用于指明实例的全量备份时间段。DataFullBackupStartUTCHour 具备更高优先级，如同时返回这两个字段，以 DataFullBackupStartUTCHour 为准。
DataKeepDaysAfterReleased	Integer	7	实例释放时备份保留天数。当前仅支持取值为 `7`。
DataKeepPolicyAfterReleased	String	Last	实例释放后保留该实例备份的策略。取值为： `Last`：保留最后一个备份。默认值。 `All`：保留实例所有备份。 `None`：不保留备份。
DataIncrBackupPeriods	String[]	["Monday","Wednesday","Friday","Sunday"]	本地盘实例进行增量备份的周期，取值： `Monday`：周一。 `Tuesday`：周二。 `Wednesday`：周三。 `Thursday`：周四。 `Friday`：周五。 `Saturday`：周六。 `Sunday`：周日。说明开启高频增量备份时，即 HourlyIncrBackupEnable 取值为 `true` 时，不返回该字段。
HighFrequencySnapshotBackupEnable	Boolean	false	云盘实例是否开启了高频增量快照备份功能。取值： `true`：是。 `false`：否。说明如实例为本地盘实例，该字段则返回 `false`。
HighFrequencySnapshotBackupSecondPeriod	Integer	3600	云盘实例高频增量快照备份的频率，单位为秒。取值： `3600`：每 1 小时。 `7200`：每 2 小时。 `10800`：每 3 小时。 `14400`：每 4 小时。 `19200`：每 6 小时。 `28800`：每 8 小时。 `38400`：每 12 小时。说明如实例为本地盘实例或云盘实例的高频增量快照备份功能未开启，该字段则返回 `0`。
HourlyIncrBackupEnable	Boolean	true	本地盘实例是否开启高频备份功能。取值： `true`：是。 `false`：否。
IncrBackupHourPeriod	Integer	2	本地盘实例进行高频增量备份的频率。取值： `0`：表示不进行高频增量备份。此时 HourlyIncrBackupEnable 取值为 `false`。 `2`：每 2 小时进行一次增量备份。 `4`：每 4 小时进行一次增量备份。 `6`：每 6 小时进行一次增量备份。 `12`：每 12 小时进行一次增量备份。
InstanceId	String	mysql-d4942fd7****	实例 ID。
KeepCrossBackupEnableAfterReleased	Boolean	false	是否保留跨地域备份。取值： `true`：是。 `false`：否。
LockDDLTime	Integer	30	DDL 最长等待时间。默认值为 30，最小值为 10，最大值为 1440，单位为分钟。
LogBackupRetentionDay	Integer	7	Binlog 备份保留时长。取值范围：7~3650 天。说明该参数在 RetentionPolicySynced 取值为 `true` 时不返回。
PublicDownloadEnable	Boolean	true	是否允许从公网环境下载实例的备份数据。取值： `true`：是。 `false`：否。
RetentionPolicySynced	Boolean	true	日志备份的保留策略是否与数据备份的保留策略一致。取值： `true`：是。 `false`：否。

示例

请求示例

POST /?Action=ModifyBackupPolicy&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-cf4f3ddc****",
    "BinlogBackupAllRetention": false,
    "BinlogBackupEnabled": true,
    "BinlogBackupEncryptionEnabled": true,
    "BinlogFileCountsEnable": true,
    "BinlogLimitCount": 600,
    "BinlogLocalRetentionHour": 128,
    "BinlogSpaceLimitEnable": false,
    "BinlogStoragePercentage": 20,
    "DataBackupAllRetention": true,
    "DataBackupEncryptionEnabled": false,
    "DataBackupRetentionDay": 10,
    "DataFullBackupPeriods": [
        "Monday",
        "Tuesday",
        "Wednesday"
    ],
    "DataFullBackupStartUTCHour": 16,
    "DataFullBackupTime": "16:00Z-16:59Z",
    "DataKeepDaysAfterReleased": 7,
    "DataKeepPolicyAfterReleased": "All",
    "HourlyIncrBackupEnable": true,
    "IncrBackupHourPeriod": 6,
    "LockDDLTime": 30,
    "LogBackupRetentionDay": 10,
    "RetentionPolicySynced": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241015210719E87A7B5DA6C5F6BD7795-eab62a",
        "Action": "ModifyBackupPolicy",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "BinlogBackupAllRetention": true,
        "BinlogBackupEnabled": true,
        "BinlogBackupEncryptionEnabled": true,
        "BinlogFileCountsEnable": true,
        "BinlogLimitCount": 600,
        "BinlogLocalRetentionHour": 128,
        "BinlogSpaceLimitEnable": false,
        "BinlogStoragePercentage": 20,
        "DataBackupAllRetention": true,
        "DataBackupEncryptionEnabled": false,
        "DataFullBackupPeriods": [
            "Monday",
            "Tuesday",
            "Wednesday"
        ],
        "DataFullBackupStartUTCHour": 16,
        "DataFullBackupTime": "16:00Z-16:59Z",
        "DataKeepDaysAfterReleased": 7,
        "DataKeepPolicyAfterReleased": "All",
        "HighFrequencySnapshotBackupEnable": false,
        "HighFrequencySnapshotBackupSecondPeriod": 0,
        "HourlyIncrBackupEnable": true,
        "IncrBackupHourPeriod": 6,
        "InstanceId": "mysql-cf4f3ddc****",
        "LockDDLTime": 30,
        "RetentionPolicySynced": true
    }
}

错误码

更多详情，请参见错误码。