# 查询跨区域备份实例列表 - ListOffSiteInstances
#### 功能介绍
根据指定条件在备份目标区域查询跨区域备份实例列表。
- 调用接口前，您需要了解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=ListOffSiteInstances)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                    | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名            | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:listAll | read | -             | -      | rds:instance:list | -      |
   
#### URI
- URI格式 GET /v3/backups/offsite-backup-instance?offset={offset}\&limit={limit}
  
- 参数说明
  表1参数说明 
  | 名称     | 参数类型      | 是否必选 | 说明                                                                                                                                                                                                                                                                                                                                 |
  |:---|:---|:---|:---|
  | offset | Integer | 否    | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** 大于等于0的整数。 **默认取值：** 默认为0。偏移0条数据，表示从第一条数据开始查询。 |
  | limit    | Integer   | 否     | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值：** 100                    |
     
  
 
#### 请求消息
- 请求参数 无。
  
- URI样例
  - 查询所有表 GET https://{endpoint}/v3/backups/offsite-backup-instance
    
  
  - 根据指定条件查询实例列表 GET https://{endpoint}/v3/backups/offsite-backup-instance?offset=0\&limit=10
    
   
 
#### 响应消息
- 正常响应要素说明
  表2参数说明 
  | 名称                      | 参数类型               | 说明                                                                                                                           |
  |:---|:---|:---|
  | offsite_backup_instances | Array of objects | **参数解释：** 跨区域备份实例信息。 详情请参见[表3]。 |
  | total_count             | Integer            | **参数解释：** 总记录数。 **取值范围**： 不涉及。       |
     
   表3offsite_backup_instances字段数据结构说明 
  | 名称                     | 参数类型      | 说明                                                                                                                                          |
  |:---|:---|:---|
  | id                      | String  | **参数解释：** 实例ID。 **取值范围**： 不涉及。                    |
  | name                  | String    | **参数解释：** 创建的实例名称。 **取值范围**： 不涉及。                  |
  | source_region        | String  | **参数解释：** 源区域。 **取值范围**： 不涉及。                    |
  | source_project_id      | String   | **参数解释：** 租户在源区域下的project ID。 **取值范围**： 不涉及。 |
  | datastore              | Object    | **参数解释：** 数据库信息。 详情请参见[表4]。                    |
  | destination_region       | String     | **参数解释：** 跨区域备份所在区域。 **取值范围**： 不涉及。               |
  | destination_project_id | String    | **参数解释：** 租户在目标区域下的project ID。 **取值范围**： 不涉及。        |
  | keep_days             | Integer | **参数解释：** 跨区域备份保留天数。 **取值范围**： 不涉及。                |
     
   表4datastore字段数据结构说明 
  | 名称     | 参数类型    | 说明                                                                                                                        |
  |:---|:---|:---|
  | type | String  | **参数解释：** 数据库引擎。 **取值范围**： 不涉及。 |
  | version | String | **参数解释：** 数据库版本。 **取值范围**： 不涉及。   |
     
  
- 正常响应样例 **根据指定条件查询实例列表：**
  ```
  {
          "total_count": 1,
  "offsite_backup_instances": [{
  "id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
                  "name": "rds-instance-rep2",
                  "source_region": "aaa",
                  "source_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
                  "datastore": {
  "type": "MySQL",
  "version": "5.7"
  },
  "destination_region": "bbb",
  "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9",
  "keep_days": 7
  }
           ]
  }
  ```
  

- **查询所有实例列表：**
  
  ```
  {
          "total_count": 1,
  "offsite_backup_instances": [{
  "id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
                  "name": "rds-instance-rep2",
                  "source_region": "aaa",
                  "source_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
                  "datastore": {
  "type": "MySQL",
  "version": "5.7"
  },
  "destination_region": "bbb",
  "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9",
  "keep_days": 7
  }
           ]
  }
  ```
  
- 异常响应 请参见[异常响应结果](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)。