设置跨区域备份策略 - SetOffSiteBackupPolicy

功能介绍

在备份原区域设置跨区域备份策略。

调用接口前，您需要了解API认证鉴权。
调用接口前，您需要了解请求Header参数说明。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
rds:instance:modifyBackupPolicy	permission_management	instance	g:EnterpriseProjectId rds:BackupEnabled g:ResourceTag/<tag-key>	-	-

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:modifyBackupPolicy

permission_management

instance

g:EnterpriseProjectId

rds:BackupEnabled

g:ResourceTag/<tag-key>

接口约束

如果实例已开启跨区域备份策略，调用接口设置跨区域备份策略，仅会更改保留天数，其他参数设置无效。
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。默认取值：不涉及。
instance_id	是	参数解释：实例ID。约束限制：非空。取值范围：该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。默认取值：不涉及。

请求消息

表2 参数说明
名称	是否必选	参数类型	说明
policy_para	是	Object	参数解释：备份策略对象，包括备份类型、备份保留天数、目标区域ID和目标project ID。详情请参见表3。约束限制：不涉及。

表3 policy_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。约束限制：不涉及。取值范围：非空，请参见地区和终端节点。默认取值：不涉及。
destination_project_id	是	String	参数解释：设置跨区域备份策略的目标project ID。约束限制：不涉及。取值范围：获取方法请参见获取项目ID。默认取值：不涉及。

请求示例

更新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"
	}
}