# 设置自动备份策略-SettinganAutomatedBackupPolicy #### 功能介绍 设置自动备份策略。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=SetBackupPolicy)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dds:instance:setBackupPolicy | write | - | - | dds:instance:modifyBackupPolicy | - | #### URI - URI格式 PUT /v3/{project_id}/instances/{instance_id}/backups/policy - URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/cc6345c64cec47499182467ea0dd432ain02/backups/policy 表1路径参数 | 名称 | 是否必选 | 类型 | IN | 描述 | |:---|:---|:---|:---|:---| | project_id | 是 | string | path | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | string | path | **参数解释：** 实例ID，可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 名称 | 是否必选 | 类型 | IN | 描述 | |:---|:---|:---|:---|:---| | X-Auth-Token | 是 | string | header | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 名称 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | backup_policy | 是 | Object | **参数解释：** 备份策略对象，包括备份保留的天数和备份开始时间。详情请参见[表4]。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表4backup_policy字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | keep_days | 否 | String | **参数解释：** 指定已生成的备份文件可以保存的天数。 **约束限制：** keep_days或enable_incremental_backup至少传其中一个参数。 **取值范围：** 0～732。取0值，表示关闭备份策略，包括自动备份策略和增量备份策略。 **默认取值：** 不涉及。 | | start_time | 否 | String | **参数解释：** 备份时间段。自动备份将在该时间段内触发。 **约束限制：** 开启自动备份策略时，该参数必选；关闭自动备份策略时，不传该参数。 **取值范围：** 格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。 - HH取值必须比hh大1。 - mm和MM取值必须相同，且取值必须为00。 取值示例： 23:00-00:00 **默认取值：** 不涉及。 | | period | 否 | String | **参数解释：** 备份周期配置。自动备份将在每星期指定的天进行。 **约束限制：** - 0天，不传该参数。 - 1～6天，备份周期全选，取值为：1,2,3,4,5,6,7。 - 7～732天，备份周期至少选择一周中的一天。示例：1,2,3,4。 **取值范围：** 格式为半角逗号隔开的数字，数字代表星期。 **默认取值：** 不涉及。 | | enable_incremental_backup | 否 | Boolean | **参数解释：** 增量备份开关。不传这个参数则不对增备状态进行改动。开启增量备份后，系统会自动进行增量备份。 **约束限制：** 不涉及。 **取值范围：** - false，代表关闭增量备份，关闭会将之前做的增量备份清理。 - true，代表开启增量备份，开启增量备份会触发一次全量备份。 **默认取值：** 不涉及。 | #### 响应参数 无。 #### 请求示例 - 开启或修改自动备份策略，并开启增量备份策略： ``` PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 9, "start_time" : "08:15-09:15", "period" : "1,4,5,6,7", "enable_incremental_backup" : true } } ``` - 开启或修改自动备份策略，并关闭增量备份策略 ``` PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 9, "start_time" : "08:15-09:15", "period" : "1,4,5,6,7", "enable_incremental_backup" : false } } ``` - 仅开启或修改自动备份策略，增量备份策略状态保持不变 ``` PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 9, "start_time" : "08:15-09:15", "period" : "1,4,5,6,7" } } ``` - 开启增量备份策略，需要在有自动全备策略情况下才能下发，关闭增量备份策略同理 ``` PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "enable_incremental_backup" : true } } ``` - 关闭备份策略，包括自动备份策略和增量备份策略 ``` PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 0 } } ``` #### 响应示例 无。 #### SDK 单击[文档数据库服务 DDS SDK](https://sdkcenter.developer.huaweicloud.com/?product=DDS)，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。 #### 状态码 详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。 #### 错误码 详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。