# 查询可恢复的实例列表 - QueryingInstancesthatCanBeRestored
#### 功能介绍
查询用户可恢复的实例列表。
#### 接口约束
该接口只支持GeminiDB Mongo数据库实例。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=ShowRestorableList)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                              | 访问级别 | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                                            | 别名                  | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbfornosql:instance:listRestorableInstances | List | instance \* | - g:ResourceTag/\<tag-key\>  - g:EnterpriseProjectId   | nosql:instance:list | -      |
     
  
 
#### URI
GET /v3/{project_id}/backups/{backup_id}/restorable-instances
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。                           |
| backup_id  | 是    | String | **参数解释：** 备份文件ID。 获取方式请参见"[查询备份列表](https://support.huaweicloud.com/api-nosql/nosql_12_0011.html)"响应参数"backups"。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表2Query参数 
| 参数     | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| offset | 否    | Integer | **参数解释：** 索引位置偏移量。 **约束限制：** 大于或等于0。 **取值范围：** 不涉及。 **默认取值：** 0。 |
| limit  | 否    | Integer | **参数解释：** 查询个数上限值。 **约束限制：** 不涉及。 **取值范围：** 1\~100。 **默认取值：** 100。  |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数                   | 参数类型                                                                              | 描述                                                                                                                                           |
|:---|:---|:---|
| total_count          | Integer                                                                           | **参数解释：** 可恢复的实例总数。 **取值范围：** 不涉及。 |
| restorable_instances | Array of [QueryRestoreList] objects | **参数解释：** 可恢复的实例信息。                                                                                      |
   
 表5QueryRestoreList 
| 参数                 | 参数类型             | 描述                                                                                                                                       |
|:---|:---|:---|
| instance_id        | String           | **参数解释：** 实例ID。 **取值范围：** 不涉及。 |
| instance_mode      | String           | **参数解释：** 实例模式。 **取值范围：** 不涉及。 |
| engine_name        | String           | **参数解释：** 接口名称。 **取值范围：** 不涉及。    |
| engine_version     | String           | **参数解释：** 接口版本。 **取值范围：** 不涉及。   |
| vpc_id             | String           | **参数解释：** VPC ID。 **取值范围：** 不涉及。    |
| subnet_ids         | Array of strings | **参数解释：** 子网ID列表。                                                                                       |
| security_group_ids | Array of strings | **参数解释：** 安全组ID列表。                                                                                  |
   
#### 请求示例
URI样例
```
GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/backups/2b19a3348108411baf7c46cf8d668e90br10/restorable-instances?offset=0&limit=100
```
#### 响应示例
**状态码： 200**
Success
```
{
  "total_count" : 1,
  "restorable_instances" : [ {
    "instance_id" : "6aef2786115341b6a18a67e0ee6ef664in10",
    "instance_mode" : "ReplicaSet",
    "engine_name" : "geminimongodb",
    "engine_version" : "4.0.3.11",
    "vpc_id" : "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
    "subnet_ids" : [ "f1df08c5-71d1-406a-aff0-de435a51007" ],
    "security_group_ids" : [ "7aa51dbf-5b63-40db-9724-dad3c4828b58" ]
  } ]
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。