查询跨区域备份策略 - ShowOffSiteBackupPolicy

功能介绍

在备份原区域查询实例的跨区域备份策略。

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

调试

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

授权信息

URI

• URI格式

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

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	参数解释： 租户在某一region下的project ID。 约束限制： 非空。 取值范围： 获取方法请参见获取项目ID。 默认取值： 不涉及。
  instance_id	是	参数解释： 实例ID。 约束限制： 非空。 取值范围： 该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。 默认取值： 不涉及。

请求消息

• 请求参数

  无。

• URI样例

  GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/offsite-policy

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  policy_para	Array of objects	参数解释： 备份策略对象，包括备份类型、备份保留天数、目标区域ID和目标project ID。 详情请参见表3。

  表3 policy_para字段数据结构说明

  名称	参数类型	说明
  backup_type	String	参数解释： 指定备份的类型。 取值范围： auto：自动全量备份。 incremental：自动增量备份。 manual：手动备份，仅RDS for SQL Server返回该备份类型 。
  keep_days	Integer	参数解释： 备份文件可以保存的天数。 取值范围： 0～1825 保存天数设置为0时，表示关闭跨区域备份策略。
  destination_region	String	参数解释： 设置跨区域备份策略的目标区域ID。 取值范围： 非空，请参见地区和终端节点。
  destination_project_id	String	参数解释： 设置跨区域备份策略的目标project ID。 取值范围： 请参见获取项目ID。

• 正常响应样例

  跨区域备份策略关闭时：

  {
  	"policy_para": {
  		"keep_days": 0
  	}
  }

  RDS for MySQL、RDS for PostgreSQL自动备份策略和增量备份策略开启时：

  {
  	"policy_para": [
              {
  		"keep_days": 7,
  		"backup_type": "auto",
  		"destination_region": "aaa",
                  "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9"
              },
              {
                  "keep_days": 7,
  		"backup_type": "incremental",
  		"destination_region": "aaa",
                  "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9"
               }
  	]
  }

  RDS for SQL Server自动备份策略、增量备份策略和手动备份策略开启时：

  {
  	"policy_para": [
              {
  		"keep_days": 7,
  		"backup_type": "incremental",
  		"destination_region": "aaa",
                  "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9"
              },
              {
                  "keep_days": 7,
  		"backup_type": "manual",
  		"destination_region": "aaa",
                  "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9"
               },
              {
  		"keep_days": 7,
  		"backup_type": "auto",
  		"destination_region": "aaa",
                  "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9"
              }
  	]
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。