# 创建数据库实例（v5） - CreatingaDBInstance
#### 功能介绍
该接口由"创建数据库实例（v3.1）"接口派生而来，接口请求头新增了"Subscription-Agency"字段，该字段用于使用共享密钥创建GaussDB包周期实例的场景。
- 调用接口前，您需要了解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=CreateGaussDbInstance)中调试该接口。
#### 约束
- 当前接口仅支持IAM新平面鉴权。
- 使用共享的KMS密钥创建包周期实例时，需要创建委托给费用中心服务并授权系统策略ServicePolicyForGaussDBFulfillment。获取到委托的URN，格式iam::{account_id}:agency:{agency_name}，调用时增加请求头Subscription-Agency，值为委托的URN。
 
#### URI
POST /v5/{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个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| datastore                  | 是        | Object | **参数解释** **：** 数据库信息。 详情请参见[表4]。 **约束限制** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ha                    | 是   | Object                      | **参数解释** **：** 实例部署形态。详情请参见[表5]。 **约束限制** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| configuration_id         | 否     | String                     | **参数解释** **：** 参数模板ID。获取方法请参考[获取参数模板列表 - ObtainingParameterTemplates](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_049.html)。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 当不传该参数时，使用系统默认的参数模板，且响应体中不返回该参数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| port                  | 否     | String                    | **参数解释** **：** 数据库对外开放端口。 **约束限制** **：** 禁止设置的端口： 2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,12016,12017,20049,20050,21731,21732,32122,32123,32124。 **取值范围**： 1024-39998。 **默认取值**： 8000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| password                | 是   | String                    | **参数解释** **：** 数据库密码。 **约束限制** **：** 不涉及。 **取值范围：** 非空；至少包含大写字母(A-Z)，小写字母(a-z)，数字(0-9)，非字母数字字符(限定为\~!@#%\^\*-_=+?,)四类字符中的三类字符；长度8\~32个字符。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| backup_strategy        | 否   | Object                   | **参数解释** **：** 备份策略。 详情请参见[表6]。 **约束限制** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| enterprise_project_id | 否  | String                     | **参数解释** **：** 企业项目ID。 使用请参考《企业管理 API参考》的"[查询企业项目列表](https://support.huaweicloud.com/api-em/zh-cn_topic_0121230880.html)"响应消息表"enterprise_project字段数据结构说明"的"id"。 **约束限制** **：** 只有企业租户时该参数才生效。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| 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)章节。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 默认为空。                                                                                                                                                                                                                                                                                                                                                                                                         |
| flavor_ref                 | 是        | String                         | **参数解释** **：** 规格码。参考[查询数据库规格 - QueryingInstanceSpecifications](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_084.html)中"spec_code"字段获取。 **约束限制** **：** 不为空。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| volume                     | 是        | Object                    | **参数解释** **：** volume信息。 详情请参见[表7]。 **约束限制** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| region                     | 是         | String                          | **参数解释** **：** 区域ID。 请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 **约束限制** **：** 不为空。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| availability_zone          | 是          | String                         | **参数解释** **：** 可用区ID。 **约束限制** **：** 不为空。 **取值范围** **：** 可选部署在相同可用区或不同可用区，可用区之间用英文逗号隔开。 调用[查询数据库规格](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_084.html)接口可在返回信息中获取到可用区ID。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| 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)。   **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 |
| charge_info             | 否     | Object                    | **参数解释** **：** 计费类型信息，仅支持按需和包周期。 详情请参见[表8]。 **约束限制** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| time_zone                  | 否     | String                       | **参数解释** **：** UTC时区。 **约束限制** **：** 不涉及。 **取值范围** **：** - 不选择时，GaussDB国内站默认为UTC时间。    - 选择填写时，取值范围为UTC-12:00\~UTC+12:00，且只支持整段时间，如UTC+08:00，不支持UTC+08:30。   **默认取值** **：** GaussDB国内站默认为UTC时间。                               |
| sharding_num         | 否   | Integer                   | **参数解释** **：** 分片数量。 **约束限制** **：** 仅分布式形态需要填写该参数。 **取值范围** **：** \[1,256\] **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| coordinator_num       | 否   | Integer                   | **参数解释** **：** 协调节点数量。 **约束限制** **：** 仅分布式形态需要填写该参数。CN数量必须小于或等于两倍的分片数。 **取值范围** **：** \[1,256\] **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| replica_num                                    | 否                           | Integer                                           | **参数解释** **：** 实例副本集数。 **约束限制** **：** 不涉及。 **取值范围** **：** 支持取值3。 **默认取值** **：** 3                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| enable_force_switch                            | 否                           | Boolean                                           | **参数解释** **：** enable_force_switch表示是否开启备机强升主功能。 说明： 备机强升主功能适用场景：在主机发生故障后，为了保障集群的可用性，强制拉起备机作为新主机对外提供服务。本功能在集群故障状态下，以丢失部分数据为代价换取集群尽可能快地恢复服务，是集群状态为不可用时的一个逃生方法。 **约束限制** **：** 仅支持1.2.2及以上版本。 **取值范围** **：** - true，表示开启备机强升主功能。  - false，表示关闭备机强升主功能。   **默认取值** **：** false                                                                                                                               |
| enable_single_float_ip                        | 否                            | Boolean                                            | **参数解释** **：** 单内网地址策略。 **约束限制** **：** 仅V2.0-3.207及以上版本的集中式版实例支持。 **取值范围：** - true：开启单浮动IP策略，实例将只有一个浮动IP绑定主节点，如果发生主备倒换，浮动IP不会发生变化。  - false：不开启单浮动IP策略，每个节点都会绑定一个浮动IP，如果发生主备倒换，浮动IP会发生变化。   **默认取值** **：** false                                                                                                                                                                                                                                                                 |
   
 表4datastore字段数据结构说明 
| 名称      | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| type    | 是    | String | **参数解释** **：** 数据库引擎。 **约束限制** **：** 不涉及。 **取值范围** **：** GaussDB：表示GaussDB引擎，不区分大小写。 **默认取值**： GaussDB                                                                                                                                                  |
| version | 否    | String | **参数解释** **：** 数据库版本。 GaussDB支持的版本参考[查询数据库引擎的版本](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_083.html)查询。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 当前最新版本。 |
   
 表5ha字段数据结构说明 
| 名称          | 是否必选      | 参数类型      | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| mode       | 是          | String | **参数解释** **：** 实例模式。 **约束限制** **：** 不涉及。 **取值范围** **：** GaussDB为分布式模式取值：enterprise(企业版) ，集中式版取值：centralization_standard，不区分大小写。 **默认取值** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| consistency | 是        | String  | **参数解释** **：** 指定事务一致性类型。 **约束限制** **：** 不涉及。 **取值范围** **：** 不区分大小写。 - strong：强一致性。  - eventual：最终一致性。   **默认取值** **：** 不涉及。                                                                        |
| replication_mode                    | 是                                 | String                         | **参数解释** **：** 备机同步模式。 **约束限制** **：** 不涉及。 **取值范围** **：** sync，表示同步模式。 **默认取值** **：** sync                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| instance_mode                       | 否 | String                          | **参数解释** **：** 指定创建实例的产品类型。 **约束限制** **：** 不涉及。 **取值范围** **：** - enterprise：创建企业版实例。  - basic：创建基础版实例。  - ecology：创建生态版实例。   **默认取值** **：** enterprise |
   
 表6backup_strategy字段数据结构说明 
| 名称          | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| start_time | 是     | String | **参数解释** **：** 备份时间段。自动备份将在该时间段内触发。 **约束限制** **：** 不涉及。 **取值范围** **：** 非空且非负，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 - HH取值必须比hh大1。  - mm和MM取值必须相同，且取值必须为00。   取值示例： - 08:00-09:00  - 23:00-00:00   **默认取值** **：** 不涉及。 |
| keep_days      | 否       | Integer    | **参数解释** **：** 指定备份文件的可保存天数。 **约束限制** **：** 不涉及。 **取值范围** **：** 1\~36500。 **默认取值** **：** 该参数缺省时，默认填写为7天。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
   
 表7volume字段数据结构说明 
| 名称    | 是否必选 | 参数类型     | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| type | 是    | String   | **参数解释** **：** 磁盘类型。 **约束限制** **：** 不涉及。 **取值范围** **：** 仅支持ULTRAHIGH和ESSD，区分大小写，分别表示SSD和极速云盘。 **默认取值** **：** 不涉及。                                                           |
| size  | 是    | Integer | **参数解释** **：** 磁盘大小，单位GB。例如：该参数填写为"40"，表示为创建的实例分配40GB的磁盘空间。 **约束限制** **：** 不涉及。 **取值范围** **：** ECS部署方案：（分片数\*40GB）\~（分片数\*24000GB），且大小只能为分片数\*4GB的整数倍。 **默认取值** **：** 不涉及。 |
   
 表8chargeInfo字段数据结构说明 
| 名称           | 是否必选   | 参数类型        | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| 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                                                                                                                                                                            |
   
#### 响应参数
表9响应参数 
| 名称             | 参数类型          | 说明                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|
| instance       | Object    | **参数解释** 实例信息。 详情请参见[表10]。                                                                                         |
| job_id    | String | **参数解释** **：** 实例创建的任务ID。 仅创建按需实例时会返回该参数。 **取值范围** **：** 不涉及。 |
| order_id | String     | **参数解释** **：** 订单号，创建包年包月时返回该参数。 **取值范围** **：** 不涉及。                                                                                                            |
   
 表10instance说明 
| 名称                  | 参数类型     | 说明                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|
| id                    | String     | **参数解释** **：** 实例ID。 **取值范围** **：** 不涉及。                                                                                                                                |
| name                  | String     | **参数解释** **：** 实例名称。用于表示实例的名称，同一租户下，同类型的实例名称可相同。 **取值范围** **：** 4\~64个字符之间，必须以字母开头，不区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。                     |
| status                | String   | **参数解释** **：** 实例状态。 仅创建按需实例时会返回该参数。 **取值范围** **：** BUILD：表示实例正在创建。 |
| datastore          | Object   | **参数解释** **：** 数据库信息。 详情请参见[表11]。                                                                                  |
| ha                  | Object   | **参数解释** **：** 数据库部署形态。 详情请参见[表12]。                                                                            |
| replica_num                                  | Integer                           | **参数解释** **：** 实例副本集数。 **取值范围** **：** 不涉及。                                                                                                                                                   |
| port                   | String   | **参数解释** **：** 数据库端口信息，与请求参数相同。 **取值范围** **：** 不涉及。                                                                                                                   |
| backup_strategy      | Object | **参数解释** **：** 自动备份策略。 详情请参见[表13]。                                                                                 |
| enterprise_project_id | String    | **参数解释** **：** 企业项目ID。 **取值范围** **：** 不涉及。                                                                                                                              |
| flavor_ref             | String  | **参数解释** **：** 规格码。 **取值范围** **：** 不涉及。                                                                                                                                                         |
| volume                 | Object   | **参数解释** **：** volume信息。 详情请参见[表14]。                                                                            |
| region                | String     | **参数解释** **：** 区域ID。 **取值范围** **：** 不涉及。                                                                                                                               |
| availability_zone     | String   | **参数解释** **：** 可用区ID。 **取值范围** **：** 不涉及。                                                                                                                          |
| vpc_id              | String   | **参数解释** **：** 虚拟私有云ID。 **取值范围** **：** 不涉及。                                                                                                                              |
| subnet_id             | String  | **参数解释** **：** 子网的网络ID信息。 **取值范围** **：** 不涉及。                                                                                                                            |
| security_group_id    | String   | **参数解释** **：** 实例所属的安全组。 **取值范围** **：** 不涉及。                                                                                                                          |
| charge_info           | Object  | **参数解释** **：** 付费方式信息。 详情请参见[表15]。                                                                                 |
   
 表11datastore字段数据结构说明 
| 名称     | 参数类型      | 说明                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|
| type    | String | **参数解释** **：** 数据库引擎。 **取值范围** **：** GaussDB：GaussDB引擎。 |
| version | String  | **参数解释** **：** 数据库版本。 **取值范围** **：** 不涉及。              |
   
 表12ha字段数据结构说明 
| 名称             | 参数类型  | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| mode            | String | **参数解释** **：** 实例模式。 **取值范围** **：** GaussDB分布式模式支持取值：enterprise(企业版) ，集中式版取值：centralization_standard，不区分大小写。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| replication_mode | String  | **参数解释** **：** 备机同步模式。 **取值范围** **：** sync，表示数据同步方式为"同步模式"。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| consistency      | String    | **参数解释** **：** GaussDB的预留参数：指定事务一致性类型。 **取值范围** **：** - strong：强一致性。  - eventual：最终一致性。                                                                                                                                                                            |
| consistency_protocol                 | String                         | **参数解释** **：** 指定副本一致性协议类型，不填时，默认为quorum。 **取值范围** **：** - quorum：quorum是主备同步复制机制，客户端发起事务后，必须要等待对应的WAL日志复制到了多个副本后，主库才会响应给客户端，少部分数据节点的宕机不影响全局可用性，保证数据的一致性。  - paxos：DCF模式开关开启后，DN可以支持基于Paxos协议的复制与仲裁能力。DN基于Paxos的选主和日志复制，复制过程中支持压缩及流控，防止带宽占用过高。提供基于Paxos多种角色的节点类型，并能够进行调整。支持查询当前数据库实例的状态。   |
   
 表13backup_strategy字段数据结构说明 
| 名称      | 参数类型     | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|
| start_time | String | **参数解释** **：** 备份时间段。自动备份将在该时间段内触发。 **取值范围** **：** 非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 - HH取值必须比hh大1。  - mm和MM取值必须相同，且取值必须为00。   取值示例： - 08:00-09:00  - 23:00-00:00   如果请求体中不填写"backup_strategy"字段，则响应体中 "start_time"默认返回"02:00-03:00"。 |
| keep_days | Integer | **参数解释** **：** 指定已生成备份文件的可保存天数。 **取值范围** **：** 1～732。如果请求体中不填写"backup_strategy"字段，则响应体中 "keep_days"默认填写为7天。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
   
 表14volume字段数据结构说明 
| 名称     | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|
| type  | String  | **参数解释** **：** 磁盘类型。 **取值范围** **：** 区分大小写。 - ULTRAHIGH，表示SSD盘。  - ESSD，表示极速云盘。   |
| size | Integer | **参数解释** **：** 磁盘大小，单位GB。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
   
 表15charge_Info字段数据结构说明 
| 名称        | 参数类型 | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|
| charge_mode | String | **参数解释** **：** 计费模式。 **取值范围** **：**  **postPaid**：后付费，即按需付费。 **prePaid**：预付费，即包年/包月。                                                                                                                                                                                                                                                                                                    |
| period_type                     | String                    | **参数解释** **：** 订购周期类型。说明："charge_mode"为"prePaid"时生效，且为必选值。 **取值范围** **：** - **month**：包月  - **year**：包年                                                |
| period_num                     | Integer                     | **参数解释** **：** "charge_mode"为"prePaid"时生效，指定订购的时间。 当period_type为month时，单位为月，当period_type为year时，单位为年。 **取值范围：** 当"period_type"为"month"时，取值为1\~9。当"period_type"为"year"时，取值为1\~3。                                                                                                                                                                                                              |
| is_auto_renew                    | Boolean                      | **参数解释** **：** 创建包周期实例时可指定，表示是否自动续订，续订时会自动支付。 按月订购时续订周期默认为1个月,按年订购时续订周期默认为1年，续订周期可自定义修改。 **取值范围** **：** - true，表示自动续订。  - false，表示不自动续订，默认为该方式。   |
| is_auto_pay                   | Boolean                    | **参数解释** **：** 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 **取值范围** **：** - true，表示自动从账户中支付。  - false，表示手动从账户中支付。                                        |
   
#### 请求示例
- 创建一个GaussDB实例，实例部署形态为分布式独立部署，包周期付费（1年），引擎版本为V2.0-2.7，三个不同可用区下，3个协调节点，3个分片，3个副本，规格为8U64G。
  ```
  POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v5/054b61972980d4552f0bc00ac8d3f5cd/instances
  {
      "name": "user1-v3-independent-02", 
      "datastore": {
          "type": "GaussDB", 
          "version": "V2.0-2.7"
      }, 
      "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", 
      "volume": {
          "type": "ULTRAHIGH", 
          "size": 120
      },
      "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab",
      "region": "aaa",
      "availability_zone": "bbb,ccc,ddd", 
      "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", 
      "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", 
      "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", 
      "backup_strategy": {
          "start_time": "17:00-18:00", 
          "keep_days": 7
      }, 
      "charge_info": {
          "charge_mode": "prePaid",
          "period_type": "year",
          "period_num": 1
      },
      "password": "********", 
      "configuration_id": "", 
      "enterprise_project_id": "", 
      "time_zone": "UTC+08:00",
      "ha":{
          "mode":"enterprise",
          "consistency":"strong",
          "replication_mode":"sync"
      },
      "sharding_num": 3,
      "coordinator_num": 3,
      "replica_num": 3,
      "port":"8000",
      "enable_force_switch":true
  }
  ```
  
- 创建一个GaussDB实例，实例部署形态为集中式版高可用（1主2备），按需付费，引擎版本为V2.0-2.7，同一可用区下，规格为8U64G。
  ```
  POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v5/054b61972980d4552f0bc00ac8d3f5cd/instances
  {
      "name": "user1-v3-ha-01",
      "datastore": {
          "type": "GaussDB",
          "version": "V2.0-2.7"
      },
      "flavor_ref": "gaussdb.opengauss.ee.km1.2xlarge.arm8.ha",
      "volume": {
          "type": "ULTRAHIGH",
          "size": 120
      },
      "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab",
      "region": "aaa",
      "availability_zone": "bbb,bbb,bbb", 
      "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
      "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
      "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
      "backup_strategy": {
          "start_time": "17:00-18:00",
          "keep_days": 7
      },
      "charge_info": {
          "charge_mode": "postPaid"
      },
      "password": "********",
      "configuration_id": "", 
      "enterprise_project_id": "",
      "time_zone": "UTC+08:00",
      "ha": {
          "mode": "centralization_standard",
          "consistency": "strong",
          "replication_mode": "sync"
      },
      "replica_num": 3,
      "port": "8000",
      "enable_force_switch": true
  }
  ```
  
- 创建一个GaussDB实例，实例部署形态为集中式版高可用（1主2备），包周期付费（1年），引擎版本为V2.0-2.7，三个不同可用区下，规格为8U64G。
  ```
  POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v5/054b61972980d4552f0bc00ac8d3f5cd/instances
  {
      "name": "user1-v3-ha-02",
      "datastore": {
          "type": "GaussDB",
          "version": "V2.0-2.7"
      },
      "flavor_ref": "gaussdb.opengauss.ee.km1.2xlarge.arm8.ha",
      "volume": {
          "type": "ULTRAHIGH",
          "size": 120
      },
      "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab",
      "region": "aaa",
      "availability_zone": "bbb,ccc,ddd", 
      "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
      "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
      "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
      "backup_strategy": {
          "start_time": "17:00-18:00",
          "keep_days": 7
      },
      "charge_info": {
          "charge_mode": "prePaid",
          "period_type": "year",
          "period_num": 1
      },
      "password": "********",
      "configuration_id": "", 
      "enterprise_project_id": "",
      "time_zone": "UTC+08:00",
      "ha": {
          "mode": "centralization_standard",
          "consistency": "strong",
          "replication_mode": "sync"
      },
      "replica_num": 3,
      "port": "8000",
      "enable_force_switch": true
  }
  ```
  
 
#### 响应示例
- **创建一个GaussDB分布式独立部署，按需付费，引擎版本为V2.0-2.7，同一可用区下，3个协调节点，3个分片，3个副本，规格为8U64G的实例：**
  ```
  {
   "instance": {
          "id": "ad8cd1440aa94a02ae4580fcbebb3143in14",
          "name": "user1-v3-independent-01",
          "status": "BUILD",
          "datastore": {
              "type": "GaussDB",
              "version": "V2.0-2.7"
          },
          "ha": {
              "mode": "Enterprise",
              "replication_mode": "sync",
              "consistency": "strong"
              
          },
          "port": "8000",
          "volume": {
              "type": "ULTRAHIGH",
              "size": 120
          },
          "replica_num": 3,
          "region": "aaa",
          "backup_strategy": {
              "start_time": "17:00-18:00",
              "keep_days": 7
          },
          "enterprise_project_id": "0",
          "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
          "availability_zone": "bbb,bbb,bbb",
          "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
          "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
          "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
          "charge_info": {
              "charge_mode": "postPaid"
          }
      },
      "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af"
  }
  ```
  

- **GaussDB分布式部署形态，包周期付费（1年），引擎版本为V2.0-2.7，三个不同可用区下，3个协调节点，3个分片，3个副本，规格为8U64G的实例响应：**
  ```
  {
      "instance": {
          "id": "ad8cd1440aa94a02ae4580fcbebb3143in14",
          "name": "user1-v3-independent-02",
          "datastore": {
              "type": "GaussDB",
              "version": "V2.0-2.7"
          },
          "ha": {
              "mode": "Enterprise",
              "replication_mode": "sync",
              "consistency": "strong"
              
          },
          "port": "8000",
          "volume": {
              "type": "ULTRAHIGH",
              "size": 120
          },
          "replica_num": 3,
          "region": "aaa",
          "backup_strategy": {
              "start_time": "17:00-18:00",
              "keep_days": 7
          },
          "enterprise_project_id": "0",
          "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
          "availability_zone": "bbb,bbb,bbb",
          "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
          "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
          "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
          "charge_info": {
              "charge_mode": "prePaid",
              "period_type": "year",
              "period_num": 1,
              "is_auto_renew": false,
              "is_auto_pay": false
          }
      },
      "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af"
  }
  ```
  
- **GaussDB集中式版高可用（1主2备），按需付费，引擎版本为V2.0-2.7，同一可用区下，规格为8U64G的实例响应：**
  ```
  {
      "instance": {
          "id": "ad8cd1440aa94a02ae4580fcbebb3143in14",
          "name": "user1-v3-ha-01",
          "status": "BUILD",
          "datastore": {
              "type": "GaussDB",
              "version": "V2.0-2.7"
          },
          "ha": {
              "mode": "centralization_standard",
              "replication_mode": "sync",
              "consistency": "strong"
              
          },
          "port": "8000",
          "volume": {
              "type": "ULTRAHIGH",
              "size": 120
          },
          "region": "aaa",
          "replica_num": 3,
          "backup_strategy": {
              "start_time": "17:00-18:00",
              "keep_days": 7
          },
          "enterprise_project_id": "0",
          "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
          "availability_zone": "bbb,bbb,bbb",
          "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
          "charge_info": {
              "charge_mode": "postPaid"
          },
          "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
          "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f"
      },
      "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af"
  }
  ```
  

- **GaussDB集中式版高可用（1主2备），包周期付费（1年），引擎版本为V2.0-2.7，三个不同可用区下，规格为8U64G的实例响应：**
  ```
  {
      "instance": {
          "id": "ad8cd1440aa94a02ae4580fcbebb3143in14",
          "name": "user1-v3-ha-02",
          "datastore": {
              "type": "GaussDB",
              "version": "V2.0-2.7"
          },
          "ha": {
              "mode": "centralization_standard",
              "replication_mode": "sync",
              "consistency": "strong"
              
          },
          "port": "8000",
          "volume": {
              "type": "ULTRAHIGH",
              "size": 120
          },
          "replica_num": 3,
          "region": "aaa",
          "backup_strategy": {
              "start_time": "17:00-18:00",
              "keep_days": 7
          },
          "enterprise_project_id": "0",
          "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
          "availability_zone": "bbb,bbb,bbb",
          "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
          "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
          "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
          "charge_info": {
              "charge_mode": "prePaid",
              "period_type": "year",
              "period_num": 1,
              "is_auto_renew": false,
              "is_auto_pay": false
          }
      },
      "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af"
  }
  ```
  
 
#### 状态码
- 正常 202
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。
