更新时间:2024-03-28 GMT+08:00

设置跨区域备份策略

功能介绍

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

接口约束

  • 如果实例已开启跨区域备份策略,调用接口设置跨区域备份策略,仅会更改保留天数,其他参数设置无效。
  • RDS for MySQL和RDS for PostgreSQL自动全量备份和自动增量备份保留天数必须保持一致。
  • RDS for MySQL和RDS for PostgreSQL自动增量备份必须在开启自动全量备份后才能开启。
  • RDS for MySQL和RDS for PostgreSQL自动全量备份和自动增量备份都开启后,关闭时请按顺序依次关闭自动增量备份、自动全量备份。
  • RDS for MySQL和RDS for PostgreSQL选择卷快照备份方式的实例不支持跨区域备份。

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/backups/offsite-policy

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

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

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

    instance_id

    实例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。

请求示例

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

响应消息

状态码

错误码

请参见错误码