文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 备份与恢复/ 设置自动备份策略
更新时间：2024-03-12 GMT+08:00
查看PDF
分享

设置自动备份策略

功能介绍

设置自动备份策略。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/backups/policy

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    租户在某一Region下的项目ID。

    获取方法请参见获取项目ID。

    instance_id

    是

    实例ID。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

backup_policy

是

Object

备份策略对象，包括备份保留的天数和备份开始时间。

详情请参见表3。

reserve_backups

否

Boolean

仅关闭备份策略时有效，默认为true。

  • true：表示保留自动备份和差异备份。
  • false：表示关闭备份策略的同时，删除已有的自动备份和差异备份。
表3 backup_policy字段数据结构说明

名称

是否必选

参数类型

说明

keep_days

是

Integer

指定已生成的备份文件可以保存的天数。

取值范围：0～732。取0值，表示关闭自动备份策略。如果需要延长保留时间请联系客服人员申请，自动备份最长可以保留2562天。

须知：

关闭备份策略后，备份任务将立即停止，所有增量备份任务将立即删除，使用增量备份的相关操作可能失败，相关操作不限于下载、复制、恢复、重建等，请谨慎操作。

start_time

否

String

备份时间段。自动备份将在该时间段内触发。除关闭自动备份策略外，必选。

取值范围：格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。

  • HH取值必须比hh大1。
  • mm和MM取值必须相同，且取值必须为00、15、30或45。

取值示例：

  • 08:15-09:15
  • 23:00-00:00

period

否

String

备份周期配置。自动备份将在每星期指定的天进行。除关闭自动备份策略外，必选。

取值范围：格式为逗号隔开的数字，数字代表星期。

取值示例：1,2,3,4则表示备份周期配置为星期一、星期二、星期三和星期四。

请求示例

  • 设置周一和周二19:00~20:00内进行自动备份，备份文件保留7天。 
    PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/policy
{
	"backup_policy": {
		"keep_days": 7,
		"start_time": "19:00-20:00",
		"period": "1,2"
	}
}
  • 关闭自动备份策略。 
    {
	"backup_policy": {
		"keep_days": 0
	},
	"reserve_backups": false
}

响应消息

状态码

错误码

请参见错误码。

父主题： 备份与恢复

相关文档