
# 根据时间点或者备份文件查询原实例信息
#### 功能介绍
根据时间点或者备份文件查询原实例信息。
- 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。
- 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。
 
#### 接口约束
restore_time和backup_id参数不能同时为空。
- backup_id非空时，按照backup_id进行查询。
- backup_id为空时，按照restore_time进行查询。
- restore_time和backup_id均非空时，按照backup_id进行查询。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=InstanceSnapshot)中调试该接口。
#### URI
GET /v3/{project_id}/instance-snapshot
表1参数说明 
| 参数           | 是否必选                                                     | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| project_id   | 是                                                        | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 |
| instance_id  | 否  | String | 原实例ID。 当restore_time非空时，instance_id是必选参数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| restore_time | 否                                                        | String | 根据时间点查看实例的备份信息时，需要填写restore_time。 UNIX时间戳格式，单位是毫秒，时区是UTC，某时间点实例的信息。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| backup_id    | 否                                                        | String | 备份ID。 根据备份ID恢复实例时，需要填写该参数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
   
#### 请求参数
无。
#### 响应参数
表2参数说明 
| 参数               | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|
| cluster_mode     | String  | 实例部署形态。 枚举值： - Ha：集中式版。  - Independent：独立部署。  - Combined：混合部署。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| instance_mode    | String  | 实例模型。 枚举值： - basic：基础版。  - standard：标准版。  - enterprise：企业版。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| data_volume_size | String  | 磁盘大小，单位：GB。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| solution         | String  | 解决方案模板类型。 枚举值： - single：单节点。  - double：1主1备2节点部署。  - triset：1主2备。  - logger：1主1备1日志。  - loggerdorado：1主1备1日志（共享存储）。  - quadruset：1主3备。  - hws：分布式（独立部署）。   |
| node_num         | Integer | 节点数量。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| coordinator_num  | Integer | 协调节点数量。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| sharding_num     | Integer | 分片数量。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| replica_num      | Integer | 副本数量。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| engine_version   | String  | 引擎版本。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
   
#### 请求示例
```
GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instance-snapshot
```
#### 响应示例
```
{ 
  "cluster_mode" : "Ha", 
  "instance_mode" : "enterprise", 
  "data_volume_size" : "200", 
  "solution" : "triset", 
  "node_num" : 3, 
  "coordinator_num" : 0, 
  "sharding_num" : 3, 
  "replica_num" : 3, 
  "engine_version" : "2.2.90"
}
```
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。
