# 查询跨区域备份策略 - ShowOffSiteBackupPolicy
#### 功能介绍
在备份原区域查询实例的跨区域备份策略。
- 调用接口前，您需要了解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=ShowOffSiteBackupPolicy)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                          | 访问级别 | 资源类型（\*为必须） | 条件键                                                                           | 别名                | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:getBackupPolicy | read | instance    | g:EnterpriseProjectId g:ResourceTag/\<tag-key\> | rds:instance:list | -      |
   
#### URI
- URI格式 GET /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"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
     
  
 
#### 请求消息
- 请求参数 无。
  
- URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/offsite-policy
  
 
#### 响应消息
- 正常响应要素说明
  表2要素说明 
  | 名称          | 参数类型             | 说明                                                                                                                                                           |
  |:---|:---|:---|
  | policy_para | Array of objects | **参数解释：** 备份策略对象，包括备份类型、备份保留天数、目标区域ID和目标project ID。 详情请参见[表3]。 |
     
   表3policy_para字段数据结构说明 
  | 名称                     | 参数类型    | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                          |
  |:---|:---|:---|
  | backup_type            | String  | **参数解释：** 指定备份的类型。 **取值范围：** - auto：自动全量备份。  - incremental：自动增量备份。  - manual：手动备份，仅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)。                                                                                                                                                                                                                                |
     
  
- 正常响应样例 **跨区域备份策略关闭时：**
  ```
  {
  "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"
              }
  ]
  }
  ```
  
- 异常响应 请参见[异常响应结果](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)。