
# 根据时间点或者备份文件查询原实例信息 - QueryingInformationAbouttheOriginalInstanceBasedonaSpecificPointofTimeoraBackupFile
#### 功能介绍
根据时间点或者备份文件查询原实例信息。
- 调用接口前，您需要了解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=ShowSourceInstanceDetail)中调试该接口。
#### URI
GET /v3.1/{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，可通过[查询备份列表 - QueryingBackups](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_068.html)获取。 **约束限制：** 当restore_time非空时，instance_id是必选参数。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值：** 不涉及。                                                                                                                                                                                                                                            |
| restore_time | 否                                                        | String | **参数解释：** 恢复时间点。根据时间点查看实例的备份信息时，需要填写restore_time。 UNIX时间戳格式，单位是毫秒，时区是UTC。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                                                                                                                                                                                      |
| backup_id    | 否                                                        | String | **参数解释：** 备份ID，可通过[查询备份列表 - QueryingBackups](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_068.html)获取。 **约束限制：** 根据备份ID恢复实例时，需要填写该参数。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                                                                                                                                                                                 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 |
| X-Language   | 否    | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文  - **en-us**：英文   **默认取值** **：** **en-us**                     |
   
#### 响应参数
表3参数说明 
| 参数               | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|
| 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.1/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" : "V2.0-2.2.90"
}
```
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。
