
# 恢复到新实例 - RestoringDatatoaNewinstance
#### 功能介绍
根据备份恢复新实例。
- 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。
- 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。
 
#### 接口约束
目标实例与源实例的数据库版本和实例类型必须一致。
目标实例规格必须大于等于源实例规格。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=CreateRestoreInstance)中调试该接口。
#### URI
POST /v3/{project_id}/instances
表1参数说明 
| 名称         | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 |
   
#### 请求参数
表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参数说明 
| 参数                      | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| name                    | 是    | String  | **参数解释** **：** 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。 **约束限制** **：** 不涉及。 **取值范围** **：** 4\~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| availability_zone       | 是    | String  | **参数解释** **：** 可用区ID。 **约束限制** **：** 不为空。 **取值范围** **：** 可选部署在相同可用区或不同可用区，可用区之间用英文逗号隔开。 调用[查询数据库规格](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_084.html)接口可在返回信息中获取到可用区ID。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                 |
| flavor_ref              | 是    | String  | **参数解释** **：** 规格码。参考[查询数据库规格 - QueryingInstanceSpecifications](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_084.html)中"spec_code"字段获取。 **约束限制** **：** 不为空。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                           |
| volume                  | 是    | Object  | **参数解释** **：** volume信息。 详情请参见[表4]。 **约束限制** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| disk_encryption_id      | 否    | String  | **参数解释** **：** 用于磁盘加密的密钥ID。通过调用密码安全中心的[创建密钥接口](https://support.huaweicloud.com/api-dew/CreateKey.html)获取（响应参数的key_id即为密钥ID）。 密钥授权请参考《密码安全中心 用户指南》的["创建授权"](https://support.huaweicloud.com/usermanual-dew/dew_01_0096.html)章节。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 默认为空。                                                                                                                                                                 |
| vpc_id                  | 是    | String  | **参数解释** **：** 虚拟私有云ID，获取方法如下： - 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。  - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询VPC列表](https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html)。   **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。                                         |
| subnet_id               | 是    | String  | **参数解释** **：** 子网的网络ID信息，获取方法如下： - 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。  - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询子网列表](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html)。   **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。            |
| security_group_id       | 是    | String  | **参数解释** **：** 指定实例所属的安全组。如果不需要指定安全组，请联系客服申请白名单。 - 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。  - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询安全组列表](https://support.huaweicloud.com/api-vpc/vpc_sg01_0003.html)。   **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 |
| password                | 是    | String  | **参数解释** **：** 数据库密码。 **约束限制** **：** 不涉及。 **取值范围** **：** 非空； 至少包含大写字母（A-Z），小写字母（a-z），数字（0-9），非字母数字字符（限定为\~!@#%\^\*-_=+?,）四类字符中的三类字符；长度8\~32个字符。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| charge_info             | 否    | Object  | **参数解释** **：** 付费方式信息，支持按需和包周期。 详情请参见[表5]。 **约束限制** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| backup_strategy         | 否    | Object  | **参数解释** **：** 自动备份策略。 详情请参见[表7]。 **约束限制** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| restore_point           | 是    | Object  | **参数解释** **：** 恢复数据源对象。 详情请参见[表6]。 **约束限制** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| enable_parallel_restore | 否    | Boolean | **参数解释** **：** 是否支持备份并行恢复。 **约束限制** **：** 当不传该参数时，分布式版默认为不支持，集中式版默认支持。 **取值范围** **：** - true：支持备份并行恢复。  - false：不支持备份并行恢复。   **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                               |
| configuration_id        | 否    | String  | **参数解释** **：** 参数模板ID。获取方法请参考[获取参数模板列表 - ObtainingParameterTemplates](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_049.html)。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 当不传该参数时，使用系统默认的参数模板，且响应体中不返回该参数。                                                                                                                                                                                                                                                                                                                            |
| enterprise_project_id   | 否    | String  | **参数解释** **：** 企业项目ID。 使用请参考《企业管理 API参考》的"[查询企业项目列表](https://support.huaweicloud.com/api-em/zh-cn_topic_0121230880.html)"响应消息表"enterprise_project字段数据结构说明"的"id"。 **约束限制** **：** 只有企业租户时该参数才生效。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。                                                                                                                                                                                                   |
| port                    | 否    | String  | **参数解释** **：** 数据库对外开放端口。 **约束限制** **：** 限制端口： 2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,12016,12017,20049,20050,21731,21732,32122,32123,32124。 **取值范围**： 1024-39998。 **默认取值**： 8000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| time_zone               | 否    | String  | **参数解释** **：** UTC时区。 **约束限制** **：** 不涉及。 **取值范围** **：** - 不选择时，GaussDB国内站默认为UTC时间。    - 选择填写时，取值范围为UTC-12:00\~UTC+12:00，且只支持整段时间，如UTC+08:00，不支持UTC+08:30。   **默认取值** **：** GaussDB国内站默认为UTC时间。                                                                                                                                                       |
| enable_force_switch     | 否    | Boolean | **参数解释** **：** 是否开启备机强升主功能。 **约束限制** **：** 仅支持1.2.2及以上版本。 **取值范围** **：** - true：表示开启备机强升主功能。  - false：表示关闭备机强升主功能。   **默认取值** **：** false 说明： 备机强升主功能适用场景：在主机发生故障后，为了保障集群的可用性，强制拉起备机作为新主机对外提供服务的场景。 本功能在集群故障状态下，以丢失部分数据为代价换取集群尽可能快地恢复服务。本功能是集群状态为不可用时的一个逃生方法，如果操作者不清楚备机强升后丢失数据对业务的影响，请勿使用本功能。                                                                                                                                                                       |
   
 表4volume字段数据结构说明 
| 参数   | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| type | 是    | String  | **参数解释** **：** 磁盘类型。 **约束限制** **：** 不涉及。 **取值范围** **：** 仅支持ULTRAHIGH和ESSD，区分大小写，分别表示SSD和极速云盘。 **默认取值** **：** 不涉及。                                                         |
| size | 是    | Integer | **参数解释** **：** 磁盘大小，单位GB。例如：该参数填写为"40"，表示为创建的实例分配40GB的磁盘空间。 **约束限制** **：** 不涉及。 **取值范围** **：** ECS部署方案：（分片数\*40GB）\~（分片数\*24000GB），且大小只能为分片数\*4GB的整数倍。 **默认取值** **：** 不涉及。 |
   
 表5charge_info字段数据结构说明 
| 参数            | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| charge_mode   | 是    | String  | **参数解释** **：** 计费模式。 **约束限制** **：** 不涉及。 **取值范围** **：**  - **postPaid**：后付费，即按需付费。  - **prePaid**：预付费，即包年/包月。   **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| period_type   | 否    | String  | **参数解释** **：** 订购周期类型。 **约束限制** **：** "charge_mode"为"prePaid"时生效，且为必选值。 **取值范围** **：** - month：包月。  - year：包年。   **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| period_num    | 否    | Integer | **参数解释** **：** 订购的时间。当period_type为month时，单位为月，当period_type为year时，单位为年。 **约束限制** **：** "charge_mode"为"prePaid"时生效，且为必选值。 **取值范围：** - 当"period_type"为"month"时，取值为1\~9。  - 当"period_type"为"year"时，取值为1\~3。   当传入浮点型时，会自动截取为整型。 **默认取值** **：** 不涉及。 |
| is_auto_renew | 否    | Boolean | **参数解释** **：** 创建包周期实例时可指定，表示是否自动续订，续订时会自动支付。 按月订购时续订周期默认为1个月，按年订购时续订周期默认为1年，续订周期可自定义修改。 **约束限制** **：** 不涉及。 **取值范围** **：** - true：为自动续订。  - false：为不自动续订。   **默认取值** **：** false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| is_auto_pay   | 否    | Boolean | **参数解释** **：** 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 **约束限制** **：** 不涉及。 **取值范围** **：** - true：为自动支付。  - false：为手动支付。   **默认取值** **：** false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
   
 表6restore_point字段数据结构说明 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| instance_id  | 是    | String | **参数解释** **：** 备份所属实例ID，可通过[查询备份列表 - QueryingBackups](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_068.html)获取，此参数是用户创建实例的唯一标识。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。                                                     |
| backup_id    | 否    | String | **参数解释** **：** 用于恢复的备份ID，可通过[查询备份列表 - QueryingBackups](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_068.html)获取，传入和schema_type相对应的全量备份ID。 **约束限制** **：** 当使用备份文件恢复时需要指定该参数。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。                                                                                                                                                                             |
| type         | 否    | String | **参数解释** **：** 恢复方式。 **约束限制** **：** 不涉及。 **取值范围** **：** - "backup"：表示使用备份文件恢复，按照此方式恢复时，"type"字段为非必选，"backup_id"必选。  - "timestamp"：表示按时间点恢复，按照此方式恢复时，"type"字段必选，"restore_time"必选。   **默认取值** **：** 不涉及。 |
| restore_time | 否    | Long   | **参数解释** **：** 恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                             |
   
 表7backup_strategy字段数据结构说明 
| 参数         | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| start_time | 是    | String  | **参数解释** **：** 废弃字段，无需填写。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 |
| keep_days  | 否    | Integer | **参数解释** **：** 废弃字段，无需填写。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。   |
   
#### 响应参数
表8要素说明 
| 参数       | 参数类型   | 描述                                                                                                                                                                                                                                             |
|:---|:---|:---|
| instance | Object | **参数解释：** 实例信息。 详情请参见[表9]。                                                                        |
| job_id   | String | **参数解释：** 恢复新实例的任务ID。 **取值范围：** 不涉及。                                                                   |
| order_id | string | **参数解释：** 创建实例的订单ID。 仅创建包周期实例时会返回该参数。 **取值范围：** 不涉及。 |
   
 表9instance说明 
| 参数                    | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|
| id                    | String  | **参数解释：** 实例ID。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| name                  | String  | **参数解释：** 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。 **取值范围：** 4\~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| status                | String  | **参数解释：** 实例状态。 **取值范围：** - 值为"BUILD"，表示实例正在创建。  - 值为"BUILD_FAILED"，表示实例创建失败。  - 值为"ACTIVE"，表示实例正常。  - 值为"FAILED"，表示实例异常。  - 值为"FROZEN"，表示实例冻结。  - 值为"MODIFYING"，表示实例正在扩容磁盘或者变更规格。  - 值为"EXPANDING"，表示实例正在添加只读节点或扩容CN或DN。  - 值为"REBOOTING"，表示实例正在重启。  - 值为"REDUCING", 表示实例正在删除只读节点。  - 值为"UPGRADING"，表示实例正在升级。  - 值为"RESTORING"，表示实例正在恢复。  - 值为"SWITCHOVER"，表示实例正在主备切换。  - 值为"MIGRATING"，表示实例正在迁移。  - 值为"BACKING UP"，表示实例正在进行备份。  - 值为"UPGRADE TO BE OBSERVED"，表示实例正在进行升级待观察。  - 值为"MODIFYING DATABASE PORT"，表示实例正在修改数据库端口。  - 值为"STORAGE FULL"，表示实例磁盘空间满。  - 值为"REPAIRING"，表示实例正在修复。  - 值为"SHUTDOWN"，表示实例已停止。   |
| datastore             | Object  | **参数解释：** 数据库信息。 详情请参见[表10]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ha                    | Object  | **参数解释：** 实例部署形态。 详情请参见[表11]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| port                  | String  | **参数解释：** 数据库端口信息。 **取值范围：** 1024-39998。 限制端口： 2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,12016,12017,20049,20050,21731,21732,32122,32123,32124。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| enterprise_project_id | String  | **参数解释：** 项目标签。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| volume                | Object  | **参数解释：** volume信息。 详情请参见[表12]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| backup_strategy       | Object  | **参数解释：** 自动备份策略。 详情请参见[表13]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| replica_num           | Integer | **参数解释：** 实例副本数。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| region                | String  | **参数解释：** 区域ID。 **取值范围：** 非空，请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| flavor_ref            | String  | **参数解释：** 规格码。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| availability_zone     | String  | **参数解释：** 可用区ID。可选部署在同一可用区或三个不同可用区，可用区之间用逗号隔开。 非空，请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| vpc_id                | String  | **参数解释：** 虚拟私有云ID。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| subnet_id             | String  | **参数解释：** 子网ID。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| security_group_id     | String  | **参数解释：** 安全组ID。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| charge_info           | Object  | **参数解释：** 付费方式信息，支持按需和包周期。 详情请参见[表14]。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
   
 表10datastore字段数据结构说明 
| 参数      | 参数类型   | 描述                                                                                                                                                                                       |
|:---|:---|:---|
| type    | String | **参数解释：** 数据库引擎。 **取值范围：** GaussDB：GaussDB引擎。 |
| version | String | **参数解释：** 数据库版本。 **取值范围：** 不涉及。                |
   
 表11ha字段数据结构说明 
| 参数               | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|
| mode             | String | **参数解释：** 模式。 **取值范围：** - independent：分布式独立部署。  - combined：分布式混合部署。  - centralization_standard：集中式。   |
| replication_mode | String | **参数解释：** 备机同步模式。 **取值范围：** 固定取值为sync，表示数据同步方式为"同步模式"。                                                                                                                                                                                                                                                                                                                                                                                                    |
| consistency      | String | **参数解释：** GaussDB的预留参数，指定实例一致性类型。 **取值范围：** - strong：强一致性  - eventual：最终一致性                                                                                                                                     |
   
 表12volume字段数据结构说明 
| 参数   | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|
| type | String  | **参数解释：** 磁盘类型。 **取值范围：** 区分大小写： - ULTRAHIGH，表示SSD。  - ESSD，表示极速云盘   |
| size | Integer | **参数解释：** 磁盘大小。 **取值范围：** GaussDB分布式实例恢复时需指定大小：要求必须为（分片数\*4GB）的倍数，取值范围：（分片数*\*40GB）\~（分片数*\*16TB）。                                                                                                                                                                                                                                                         |
   
 表13backup_strategy字段数据结构说明 
| 参数         | 参数类型    | 描述                                                                                                                                                                                  |
|:---|:---|:---|
| start_time | String  | **参数解释：** 废弃字段。无需关注。 **取值范围：** 不涉及。        |
| keep_days  | Integer | **参数解释：** 废弃字段。无需关注。 **取值范围：** 不涉及。 |
   
 表14charge_info字段数据结构说明 
| 参数            | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|
| charge_mode   | String  | **参数解释** **：** 计费模式。 **取值范围** **：**  - **postPaid**：后付费，即按需付费。  - **prePaid**：预付费，即包年/包月。                                              |
| period_type   | string  | **参数解释** **：** 订购周期类型。"charge_mode"为"prePaid"时生效。 **取值范围** **：** - month：包月。  - year：包年。                                                         |
| period_num    | integer | **参数解释** **：** "charge_mode"为"prePaid"时生效，指定订购的时间。 **取值范围:** - 当"period_type"为"month"时，取值为1\~9。  - 当"period_type"为"year"时，取值为1\~3。                   |
| is_auto_renew | boolean | **参数解释** **：** 包周期实例特有，表示是否自动续订，续订时会自动支付。 按月订购时续订周期默认为1个月，按年订购时续订周期默认为1年，续订周期可自定义修改。 **取值范围:** - true，表示自动续订。  - false，表示不自动续订,默认为该方式。   |
| is_auto_pay   | boolean | **参数解释** **：** 包周期实例时特有，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 **取值范围:** - true：表示自动从账户中支付。  - false：表示手动从账户中支付默认为该支付方式。                                    |
   
#### 请求示例
- 按备份文件恢复到新实例，新实例规格为8U64G，磁盘为160G。
  ```
  POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances
  {
      "name": "targetInst",
      "availability_zone": "aaa,bbb,ccc",
      "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
      "volume": {
          "type": "ULTRAHIGH",
          "size": 160
      },
      "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
      "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
      "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
      "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
      "password": "******",
      "restore_point": {
          "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin14",
          "backup_id": "2f4ddb93b9014b0893d81d2e472f30febr14"
      },
      "enable_parallel_restore": false,
      "configuration_id": "52e86e87445847a79bf807ceda213165pr01",
      "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
      "port": "8000",
      "enable_force_switch": true,
      "time_zone": "UTC+04:00"
  }
  ```
  
- 按备份文件恢复到新实例，新实例规格为8U64G，磁盘为160G。
  ```
  POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances
  {
      "name": "targetInst",
      "availability_zone": "aaa,bbb,ccc",
      "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
      "volume": {
          "type": "ULTRAHIGH",
          "size": 160
      },
      "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
      "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
      "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
      "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
      "password": "******",
      "restore_point": {
          "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin14",
          "backup_id": "2f4ddb93b9014b0893d81d2e472f30febr14",
          "type": "backup"
      },
      "enable_parallel_restore": false,
      "configuration_id": "52e86e87445847a79bf807ceda213165pr01",
      "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
      "port": "8000",
      "enable_force_switch": true,
      "time_zone": "UTC+04:00"
  }
  ```
  
- 按时间点恢复到新实例，新实例规格为8U64G，磁盘为160G。
  ```
  POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances
  {
      "name": "targetInst",
      "availability_zone": "aaa,bbb,ccc",
      "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
      "volume": {
          "type": "ULTRAHIGH",
          "size": 160
      },
      "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
      "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
      "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
      "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
      "password": "******",
      "restore_point": {
          "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin14",
          "type": "timestamp", 
          "restore_time": 1532001446987
      },
      "enable_parallel_restore": false,
      "configuration_id": "52e86e87445847a79bf807ceda213165pr01",
      "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
      "port": "8000",
      "enable_force_switch": true,
      "time_zone": "UTC+04:00"
  }
  ```
  
#### 响应消息
恢复到新实例成功。
```
{
    "instance": {
        "id": "2gfdsh844a4023a776fc5c5fb71fb4in14",
        "name": "gaussdb-instance-rep2",
        "status": "BUILD",
        "datastore": {
            "type": "GaussDB",
            "version": "1.4"
        },
        "ha": {
            "mode": "independent",
            "consistency": "strong",
            "replication_mode": "sync"
        },
        "volume": {
            "type": "ULTRAHIGH",
            
            "size": 160
        },
        "port": "8000",
        "replica_num": 3,
        "region": "regionA",
        "enable_parallel_restore": false,
        "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
        
        "availability_zone": "aaa,bbb,ccc",
        "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
        "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
        "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
        "charge_info": {
            "charge_mode": "postPaid"
        },
        "enterprise_project_id": "fdsa-3rds",
    },
    "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
}
```
#### 状态码
- 正常 202
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。
