You need to enable JavaScript to run this app.
导航
云数据库 MySQL 版
  • 文档首页
    • /
  • 云数据库 MySQL 版

ModifyBackupPolicy

最近更新时间：2024.01.15 19:02:14

首次发布时间：2023.08.14 13:15:55

我的收藏

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

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述
InstanceIdString是mysql-46609cf2****实例 ID。

DataFullBackupPeriods

Array of String

否

["Monday","Wednesday","Friday","Sunday"]

全量备份周期。建议每周至少选择 2 天进行全量备份，多个取值用英文逗号（,）隔开。取值：

  • Monday：周一。
  • Tuesday：周二。
  • Wednesday：周三。
  • Thursday：周四。
  • Friday：周五。
  • Saturday：周六。
  • Sunday：周日。

说明

当修改数据备份策略时，需要传入该参数。

DataBackupRetentionDay

Integer

否

7

数据备份保留天数，取值：7~365 天。默认保留 7 天。

说明

当修改数据备份策略时，需要传入该参数。

DataFullBackupTime

String

否

19:00Z-01:00Z

执行备份任务的时间，间隔窗口为 6 小时。格式：HH:mmZ-HH:mmZ（UTC 时间）。

说明

当修改数据备份策略时，需要传入该参数。

DataIncrBackupPeriods

Array of 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~365，单位为天。

说明

当修改日志备份策略时，需要传入该参数。

LockDdlTime

Integer

否

30

DDL 最长等待时间。默认值为 30，最小值为 10，最大值为 1440， 单位为分钟。

说明

仅 MySQL 8.0 版本实例支持此设置。

返回参数

名称类型示例值描述
InstanceIdStringmysql-46609cf2****实例 ID。

DataFullBackupPeriods

Array of String

["Monday","Wednesday","Friday","Sunday"]

全量备份周期。取值：

  • Monday：周一。
  • Tuesday：周二。
  • Wednesday：周三。
  • Thursday：周四。
  • Friday：周五。
  • Saturday：周六。
  • Sunday：周日。
DataBackupRetentionDayInteger7数据备份保留天数，取值：7~365 天。默认保留 7 天。
DataFullBackupTimeString19:00Z-01:00Z执行备份任务的时间，间隔窗口为 6 小时。格式：HH:mmZ-HH:mmZ（UTC 时间）。

DataIncrBackupPeriods

Array of String

["Monday","Wednesday","Friday","Sunday"]

增量备份周期，取值：

  • Monday：周一。
  • Tuesday：周二。
  • Wednesday：周三。
  • Thursday：周四。
  • Friday：周五。
  • Saturday：周六。
  • Sunday：周日。

BinlogFileCountsEnable

Boolean

true

是否开启本地 Binlog 保留上限。取值：

  • true：开启。
  • false：不开启。
BinlogLimitCountInteger10本地 Binlog 保留个数，取值：6~1000 个，自动删除超过保留个数的本地日志。
BinlogLocalRetentionHourInteger7本地 Binlog 保留时长，取值：0~168 小时，自动删除超过保留时长的本地日志。当设置为 0 时，不自动删除本地日志。
BinlogSpaceLimitEnableBooleantrue是否开启空间过大自动清理 Binlog。当实例总存储空间占用率超过 80% 或者剩余空间不足 5GB 时，系统会自动开始清理最早的本地 Binlog，直至总空间占用率低于 80% 且剩余空间大于 5GB。

BinlogStoragePercentage

Integer

30

最大存储空间使用率，可设置 20%~50%，超出后自动删除最早的 Binlog 文件，直到空间使用率低于该比例。

说明

本地 Binlog 空间使用率 = 本地 Binlog 大小 / 实例总可用（购买）空间大小。

LogBackupRetentionDayInteger7Binlog 备份保留时长。取值范围：7~365 天。
LockDdlTimeInteger30DDL 最长等待时间。默认值为 30，最小值为 10，最大值为 1440， 单位为分钟。

请求示例

  • 仅修改数据备份

    POST /?Action=ModifyBackupPolicy&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20230810T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20230810/cn-beijing/rds_mysql/request, SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645a****

{
    "InstanceId":"mysql-46609cf2****",
    "DataFullBackupPeriods":[
        "Sunday",
        "Tuesday",
        "Thursday"
    ],
    "DataBackupRetentionDay":8,
    "DataFullBackupTime":"19:00Z-01:00Z",
    "DataIncrBackupPeriods":[
        "Monday"
    ]
}

  • 仅修改日志备份

    POST /?Action=ModifyBackupPolicy&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20230810T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20230810/cn-beijing/rds_mysql/request, SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645a****

{
    "InstanceId":"mysql-46609cf2****",
    "BinlogFileCountsEnable":true,
    "BinlogLimitCount":60,
    "BinlogLocalRetentionHour":24,
    "BinlogSpaceLimitEnable":true,
    "BinlogStoragePercentage":30,
    "LogBackupRetentionDay":7
}

  • 同时修改数据备份和日志备份

    POST /?Action=ModifyBackupPolicy&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20230810T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20230810/cn-beijing/rds_mysql/request, SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645a****

{
    "InstanceId":"mysql-d4942fd7****",
    "DataFullBackupPeriods":[
        "Sunday",
        "Tuesday",
        "Thursday"
    ],
    "DataBackupRetentionDay":8,
    "DataFullBackupTime":"19:00Z-01:00Z",
    "DataIncrBackupPeriods":[
        "Monday"
    ],
    "BinlogFileCountsEnable":true,
    "BinlogLimitCount":60,
    "BinlogLocalRetentionHour":24,
    "BinlogSpaceLimitEnable":true,
    "BinlogStoragePercentage":30,
    "LogBackupRetentionDay":7
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308091637563E07AB3D46D9D67D8007",
        "Action": "ModifyBackupPolicy",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BinlogFileCountsEnable": true,
        "BinlogLimitCount": 60,
        "BinlogLocalRetentionHour": 24,
        "BinlogSpaceLimitEnable": true,
        "BinlogStoragePercentage": 30,
        "DataBackupRetentionDay": 8,
        "DataFullBackupPeriods": [
            "Sunday",
            "Tuesday",
            "Thursday"
        ],
        "DataFullBackupTime": "19:00Z-01:00Z",
        "DataIncrBackupPeriods": [
            "Monday"
        ],
        "InstanceId": "mysql-46609cf2****",
        "LogBackupRetentionDay": 7
    }
}

错误码

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