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

文档中心

立即注册

导航

ModifyBackupPolicy

最近更新时间：2024.11.13 15:58:37首次发布时间：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~365 天。默认保留 7 天。说明当修改数据备份策略时，需要传入该参数。
DataFullBackupTime	String	否	18:00Z-19:00Z	执行备份任务的时间窗，时间窗口为 1 小时。格式：HH:mmZ-HH:mmZ（UTC 时间）。说明当修改数据备份策略时，需要传入该参数。
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~365，单位为天。说明当修改日志备份策略时，需要传入该参数。
LockDDLTime	Integer	否	30	DDL 最长等待时间。默认值为 30，最小值为 10，最大值为 1440，单位为分钟。说明仅 MySQL 8.0 版本实例支持此设置。

返回参数

参数	类型	示例值	描述
InstanceId	String	mysql-d4942fd7****	实例 ID。
DataFullBackupPeriods	String[]	["Monday","Wednesday","Friday",Sunday"]	全量备份周期。取值： `Monday`：周一。 `Tuesday`：周二。 `Wednesday`：周三。 `Thursday`：周四。 `Friday`：周五。 `Saturday`：周六。 `Sunday`：周日。
DataBackupRetentionDay	Integer	7	数据备份保留天数，取值：7~365 天。默认保留 7 天。
DataFullBackupTime	String	18:00Z-19:00Z	执行备份任务的时间窗，时间窗口为 1 小时。格式：HH:mmZ-HH:mmZ（UTC 时间）。
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。
BinlogStoragePercentage	Integer	30	最大存储空间使用率，可设置 20%~50%，超出后自动删除最早的 Binlog 文件，直到空间使用率低于该比例。说明本地 Binlog 空间使用率 = 本地 Binlog 大小/实例总可用（购买）空间大小。
LogBackupRetentionDay	Integer	7	Binlog 备份保留时长。取值范围：7~365 天。
LockDDLTime	Integer	30	DDL 最长等待时间。默认值为 30，最小值为 10，最大值为 1440，单位为分钟。

示例

请求示例 1

仅修改数据备份

POST /?Action=ModifyBackupPolicy&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId":"mysql-46609cf2****",
    "DataFullBackupPeriods":[
        "Sunday",
        "Tuesday",
        "Thursday"
    ],
    "DataBackupRetentionDay":8,
    "DataFullBackupTime":"18:00Z-19:00Z",
    "DataIncrBackupPeriods":[
        "Monday"
    ]
}

返回示例 1

{
    "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": "18:00Z-19:00Z",
        "DataIncrBackupPeriods": [
            "Monday"
        ],
        "InstanceId": "mysql-46609cf2****",
        "LogBackupRetentionDay": 7
    }
}

请求示例 2

仅修改日志备份

POST /?Action=ModifyBackupPolicy&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId":"mysql-46609cf2****",
    "BinlogFileCountsEnable":true,
    "BinlogLimitCount":60,
    "BinlogLocalRetentionHour":24,
    "BinlogSpaceLimitEnable":true,
    "BinlogStoragePercentage":30,
    "LogBackupRetentionDay":7
}

返回示例 2

{
    "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
    }
}

请求示例 3

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

POST /?Action=ModifyBackupPolicy&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId":"mysql-d4942fd7****",
    "DataFullBackupPeriods":[
        "Sunday",
        "Tuesday",
        "Thursday"
    ],
    "DataBackupRetentionDay":8,
    "DataFullBackupTime":"18:00Z-19:00Z",
    "DataIncrBackupPeriods":[
        "Monday"
    ],
    "BinlogFileCountsEnable":true,
    "BinlogLimitCount":60,
    "BinlogLocalRetentionHour":24,
    "BinlogSpaceLimitEnable":true,
    "BinlogStoragePercentage":30,
    "LogBackupRetentionDay":7
}

返回示例 3

{
    "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": "18:00Z-19:00Z",
        "DataIncrBackupPeriods": [
            "Monday"
        ],
        "InstanceId": "mysql-46609cf2****",
        "LogBackupRetentionDay": 7
    }
}

错误码

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