文档首页/ 云数据库 GaussDB/ API参考/ 历史API/ 备份管理/ 设置自动备份策略
更新时间：2024-10-18 GMT+08:00
查看PDF
分享

设置自动备份策略

功能介绍

设置自动备份策略。

调试

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

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

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

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

实例ID。

请求参数

表2 参数说明

名称

是否必选

参数类型

说明

backup_policy

是

Object

备份策略信息。

详情参见表3。
表3 backup_policy字段数据结构说明

名称

是否必选

参数类型

说明

keep_days

是

Integer

备份文件可以保存的天数。

取值范围：1-36500天。

start_time

是

String

备份时间段。自动备份将在该时间段内触发。

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

HH取值必须比hh大1，mm和MM取值必须相同，且取值必须为00。

取值示例：

21:00-22:00

说明：

该时间段为执行备份的UTC时间段。比如备份时间是当地时间05:00-06:00，时区为UTC+08:00，则接口需要传入21:00-22:00；如果时区为UTC+04:00，接口传入01:00-02:00。

period

是

String

全量备份周期配置。自动全量备份将在每周对应的UTC日期进行。

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

取值示例：

  • 1,2,3,4 表示备份周期配置为星期一、星期二、星期三和星期四。
  • 1,2,3,4,5,6,7 则表示星期一至星期日每天执行一次自动备份。
  • 1,3,5表示周一、周三、周五执行一次自动备份。
说明：

该时间段为执行备份的UTC日期。比如备份时间为当地时间周一、周二05:00-06:00，时区为UTC+08:00，则period传入1,7；如果时区为UTC+04:00，period传入1,2。

differential_period

是

String

差异备份间隔时间配置。每次自动差异备份的间隔时间。

取值范围：15、30、60、180、360、720、1440。单位：分钟。

取值示例：30

rate_limit

否

Integer

备份限速,默认值为0MB/s，表示不限速。控制备份是备份数据上传OBS的速度，限速用于限制上传备份对上传带宽的影响

取值范围：0~ 1024

最小值：0 MB/s

prefetch_block

否

Integer

控制差量备份时读取磁盘上表文件差量修改页面的预取页面个数。当差量修改页面非常集中时（如数据导入场景），可以适当调大该值；当差量修改页面非常分散时（如随机更新），可以适当调小该值。默认为64,单位个数

取值范围：1 ~ 8192

最小值：1

最大值：8192

file_split_size

否

Integer

全量、差量备份时产生的备份文件会根据该参数的值进行拆分，可设置范围为0~1024GB，设置需为4的倍数，默认4GB，0GB表示不限制大小。

取值范围：0 ~ 1024

最小值：0

最大值：1024

filesplit_size

否

Integer

全量、差量备份时产生的备份文件会根据该参数的值进行拆分，废弃，无需填写。

enable_standby_backup

否

Boolean

是否启用备机备份。(不支持单节点实例及3.100.0以下的实例)

响应参数

无。

请求示例

设置GaussDB实例备份策略，备份文件保存时长7天，备份时间段为19:00-20:00。 
PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy
{
         "backup_policy": {
                "keep_days": 7,
                "start_time": "19:00-20:00",
                "period": "1,2,3,4,5",
                "differential_period": "30",
                "rate_limit": 75 ,
                "prefetch_block": 64 ,
                "file_split_size": 4 ,
                "enable_standby_backup" : false
 
 
 
 
 
 }
}

响应示例

{}

状态码

错误码

请参见错误码。

父主题： 备份管理

相关文档