# 设置跨区域备份策略 - SetOffSiteBackupPolicy #### 功能介绍 在备份原区域设置跨区域备份策略。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=RDS&api=SetOffSiteBackupPolicy)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:instance:modifyBackupPolicy | permission_management | instance | g:EnterpriseProjectId rds:BackupEnabled g:ResourceTag/\ | - | - | #### 接口约束 - 如果实例已开启跨区域备份策略，调用接口设置跨区域备份策略，仅会更改保留天数，其他参数设置无效。 - RDS for PostgreSQL自动全量备份和自动增量备份保留天数必须保持一致。 - RDS for PostgreSQL自动增量备份必须在开启自动全量备份后才能开启。 - RDS for PostgreSQL自动全量备份和自动增量备份都开启后，关闭时请按顺序依次关闭自动增量备份、自动全量备份。 - RDS for PostgreSQL选择卷快照备份方式的实例不支持跨区域备份。 #### URI - URI格式 PUT /v3/{project_id}/instances/{instance_id}/backups/offsite-policy - 参数说明 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | **参数解释：** 实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求消息 表2参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | policy_para | 是 | Object | **参数解释：** 备份策略对象，包括备份类型、备份保留天数、目标区域ID和目标project ID。 详情请参见[表3]。 **约束限制：** 不涉及。 | 表3policy_para字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | backup_type | 是 | String | **参数解释：** 指定备份的类型。 **约束限制：** 不涉及。 **取值范围：** RDS for SQL Server仅支持设置为"all"。 - auto：自动全量备份。 - incremental：自动增量备份。 - all：同时设置所有备份类型。 - RDS for MySQL：同时设置自动全量和自动增量备份。 - RDS for PostgreSQL：同时设置自动全量和自动增量备份。 - RDS for SQL Server：同时设置自动全量、自动增量备份和手动备份。 **默认取值：** 不涉及。 | | keep_days | 是 | Integer | **参数解释：** 指定已生成的备份文件可以保存的天数。 **约束限制：** 关闭备份策略后，备份任务将立即停止，如果有增量备份，所有增量备份任务将立即删除，使用增量备份的相关操作可能失败，相关操作不限于下载、复制、恢复、重建等，请谨慎操作。 **取值范围：** 0～1825 保存天数设置为0时，表示关闭跨区域备份策略。 **默认取值：** 不涉及。 | | destination_region | 是 | String | **参数解释：** 设置跨区域备份策略的目标区域ID。 **约束限制：** 不涉及。 **取值范围：** 非空，请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 **默认取值：** 不涉及。 | | destination_project_id | 是 | String | **参数解释：** 设置跨区域备份策略的目标project ID。 **约束限制：** 不涉及。 **取值范围：** 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **默认取值：** 不涉及。 | #### 请求示例 - 更新MySQL或PostgreSQL实例的跨区域自动全量备份策略。 ``` PUT https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/offsite-policy { "policy_para": { "backup_type": "auto", "keep_days": 7, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } ``` - 关闭MySQL或PostgreSQL实例的跨区域自动全量备份策略。 ``` { "policy_para": { "backup_type": "auto", "keep_days": 0, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } ``` - 更新SQL Server实例的跨区域备份策略。 ``` { "policy_para": { "backup_type": "all", "keep_days": 7, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } ``` - 关闭SQL Server实例的跨区域备份策略。 ``` { "policy_para": { "backup_type": "all", "keep_days": 0, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } ``` #### 响应消息 - 正常响应要素说明 表4要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | resp | String | **参数解释**： 调用结果。 **取值范围**： 调用正常时，返回"successful"。 | - 正常响应样例 ``` { "resp": "successful" } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。