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

文档中心

立即注册

导航

DescribeBackupPolicy

最近更新时间：2025.01.22 12:04:47首次发布时间：2023.08.14 13:15:55

调用 DescribeBackupPolicy 接口查询指定实例的备份策略。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-d4942fd7****	实例 ID。

返回参数

参数	类型	示例值	描述
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`：保留实例所有备份。
DataIncrBackupPeriods	String[]	["Monday","Wednesday","Friday","Sunday"]	增量备份周期，取值： `Monday`：周一。 `Tuesday`：周二。 `Wednesday`：周三。 `Thursday`：周四。 `Friday`：周五。 `Saturday`：周六。 `Sunday`：周日。说明开启高频增量备份时，即 HourlyIncrBackupEnable 取值为 `true` 时，不返回该字段。
HourlyIncrBackupEnable	Boolean	true	是否开启高频备份功能。取值： `true`：是。 `false`：否。
IncrBackupHourPeriod	Integer	2	进行高频增量备份的频率。取值： `0`：表示不进行高频增量备份。此时 HourlyIncrBackupEnable 取值为 `false`。 `2`：每 2 小时进行一次增量备份。 `4`：每 4 小时进行一次增量备份。 `6`：每 6 小时进行一次增量备份。 `12`：每 12 小时进行一次增量备份。
InstanceId	String	mysql-d4942fd7****	实例 ID。
LockDDLTime	Integer	30	DDL 最长等待时间。默认值为 30，最小值为 10，最大值为 1440，单位为分钟。说明仅 MySQL 8.0 版本实例支持此设置。
LogBackupRetentionDay	Integer	7	Binlog 备份保留时长。取值范围：7~3650 天。说明该参数在 RetentionPolicySynced 取值为 `true` 时不返回。
RetentionPolicySynced	Boolean	true	日志备份的保留策略是否与数据备份的保留策略一致。取值： `true`：是。 `false`：否。

示例

请求示例

POST /?Action=DescribeBackupPolicy&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-d4942fd7****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308101124409984CE8C71ABEA55A2B8",
        "Action": "DescribeBackupPolicy",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BinlogBackupAllRetention": false,
        "BinlogBackupEnabled": true,
        "BinlogBackupEncryptionEnabled": false,
        "BinlogFileCountsEnable": true,
        "BinlogLimitCount": 60,
        "BinlogLocalRetentionHour": 24,
        "BinlogSpaceLimitEnable": false,
        "BinlogStoragePercentage": 30,
        "DataBackupAllRetention": false,
        "DataBackupEncryptionEnabled": false,
        "DataBackupRetentionDay": 8,
        "DataFullBackupPeriods": [
            "Monday",
            "Tuesday",
            "Wednesday"
        ],
        "DataFullBackupStartUTCHour": 16,
        "DataFullBackupTime": "16:00Z-16:59Z",
        "DataKeepDaysAfterReleased": 7,
        "DataKeepPolicyAfterReleased": "All",
        "HourlyIncrBackupEnable": true,
        "IncrBackupHourPeriod": 4,
        "InstanceId": "mysql-d4942fd7****",
        "LockDDLTime": 30,
        "LogBackupRetentionDay": 7,
        "RetentionPolicySynced": false
    }
}

错误码

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