设置跨区域备份策略 - SetOffSiteBackupPolicy

功能介绍

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

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

调试

您可以在API Explorer中调试该接口。

授权信息

接口约束

• 如果实例已开启跨区域备份策略，调用接口设置跨区域备份策略，仅会更改保留天数，其他参数设置无效。
• 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”获取。 默认取值： 不涉及。

请求消息

请求示例

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

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。