# 设置自动备份策略 - ConfiguringanAutomatedBackupPolicy #### 功能介绍 设置自动备份策略。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=SetNewBackupPolicy)中调试该接口。 #### URI PUT /v3.1/{*project_id* }/instances/{*instance_id*}/backups/policy 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | 表3参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | backup_policy | 是 | Object | **参数解释：** 备份策略信息。 详情参见[表4]。 **约束限制：** 不涉及。 | 表4backup_policy字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | keep_days | 是 | Integer | **参数解释：** 备份文件可以保存的天数。 **约束限制：** 不涉及。 **取值范围：** 1-36500天。 **默认取值：** 不涉及。 | | start_time | 是 | String | **参数解释：** 备份时间段。自动备份将在该时间段内触发。 **约束限制：** 不涉及。 **取值范围：** 非空，长度为11个字符，格式必须为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 | **参数解释：** 备份限速，单位：MB/s。控制备份时备份数据上传OBS的速度，限速用于限制上传备份对上传带宽的影响。 **约束限制：** 不涉及。 **取值范围：** 0\~1024MB/s，0表示不限速。 **默认取值：** 75MB/s | | prefetch_block | 否 | Integer | **参数解释：** 差量预取页面个数，单位：个。控制差量备份时读取磁盘上表文件差量修改页面的预取页面个数。当差量修改页面非常集中时（如数据导入场景），可以适当调大该值；当差量修改页面非常分散时（如随机更新），可以适当调小该值。 **约束限制：** 不涉及。 **取值范围：** 1 \~ 8192 **默认取值：** 64 | | file_split_size | 否 | Integer | **参数解释：** 文件拆分大小，单位：GB。全量、差量备份时产生的备份文件会根据该参数的值进行拆分。 **约束限制：** 需为4的倍数。 **取值范围：** 可设置范围为0\~1024GB。0GB表示不限制大小。 **默认取值：** 4GB | | enable_standby_backup | 否 | Boolean | **参数解释：** 是否启用备机备份。 **约束限制：** 不支持单节点实例及3.100.0以下的实例。 **取值范围：** - true：启用备机备份。 - false：不启用备机备份。 **默认取值：** 不涉及。 | #### 响应参数 无。 #### 请求示例 设置GaussDB实例备份策略，备份文件保存时长7天，备份时间段为19:00-20:00。 ``` PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/dd93e98e103b4fc4b5a978a6bd6f03a9in14/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 } } ``` #### 响应示例 ``` {} ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。