创建实例

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。

X-Auth-Token

是

String

用户Token。

name

是

String

实例名称，允许和已有名称重复。

实例名称长度在4个到64个字节之间，必须以字母或中文字开头，区分大小写，可以包含字母、数字、中划线、下划线或中文（一个中文字符占用3个字节），不能包含其他特殊字符。

datastore

是

Datastore object

数据库信息。

region

是

String

区域ID。

取值：非空，请参见地区和终端节点。

availability_zone

是

String

可用区ID。

取值：请参见5.2.2-查询数据库规格中返回的“az_status”，支持创建3可用区实例，中间以逗号隔开。

vpc_id

是

String

虚拟私有云ID，获取方法如下：

• 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。
• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。

subnet_id

是

String

子网的网络ID，获取方法如下：

• 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。
• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。

security_group_id

是

String

安全组ID，获取方法如下：

• 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。
• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。

password

是

String

数据库密码。

取值范围：长度为8~32位。必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。仅GeminiDB Redis至少包含以下字符中的2种：大写字母、小写字母、数字和特殊字符~！@#$%^&*()-_=+？。

建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。

mode

是

String

实例类型。

• GeminiDB Cassandra支持集群类型，取值为“Cluster”。
• GeminiDB Mongo 4.0版本支持副本集类型，取值为“ReplicaSet”。
• GeminiDB Influx支持集群类型，取值为“Cluster”。
• GeminiDB Influx支持单节点类型，取值为“InfluxdbSingle”。
• GeminiDB Redis支持集群类型，取值为“Cluster”。
• GeminiDB Redis支持主备类型，取值为“Replication”。

flavor

是

Array of Flavor objects

实例规格详情。

获取方法请参见查询数据库规格中响应“flavors”字段下参数的值。

configuration_id

否

String

参数模板ID。

backup_strategy

否

BackupStrategy object

高级备份策略。

enterprise_project_id

否

String

企业项目ID。

• 对于未开通企业多项目服务的用户，不传该参数。
• 对于已开通企业多项目服务的用户，不传该参数时，表示为default企业项目。获取方式请参见《企业管理API参考》的“查询企业项目列表”响应消息表“enterprise_project字段数据结构说明”的“id”。

ssl_option

否

String

SSL开关选项。

取值：

• 取“0”，表示默认不启用SSL连接。
• 取“1”，表示默认启用SSL连接。
• 不传该参数时，默认不启用SSL连接。

charge_info

否

ChargeInfo object

计费类型信息，支持包年包月和按需计费，默认为按需计费。

dedicated_resource_id

否

String

专属资源ID，只有开通专属资源池后才可以下发此参数。

restore_info

否

RestoreInfo object

备份信息。支持按指定备份恢复和按指定实例的指定时间点恢复。

目前仅GeminiDB Cassandra和GeminiDB Influx集群支持按指定实例的指定时间点恢复。

port

否

String

数据库访问端口号。

目前仅支持GeminiDB Redis实例支持自定义端口，取值范围为：1024~65535，禁用端口号为：2180、2887、3887、6377、6378、6380、8018、8079、8091、8479、8484、8999、9864、9866、9867、12017、12333、50069。

不指定端口时，创建GeminiDB Redis实例的访问端口默认为6379。

如果该实例计划用于搭建双活容灾场景，请配置为8635端口。

availability_zone_detail

否

object

主备类型实例的多AZ可用区详情。

目前仅支持GeminiDB Redis实例。

当选择单AZ部署时，自动忽略该参数设置。详情请参考表9。

type

是

String

数据库类型。

• 支持GeminiDB Cassandra、GeminiDB Mongo、GeminiDB Influx和GeminiDB Redis数据库实例。
• 取值为“cassandra”，表示创建GeminiDB Cassandra数据库实例。
• 取值为“mongodb”，表示创建GeminiDB Mongo数据库实例。
• 取值为“influxdb”，表示创建GeminiDB Influx数据库实例。
• 取值为“redis”，表示创建GeminiDB Redis数据库实例。

version

是

String

数据库版本。

• GeminiDB Cassandra实例支持3.11版本，取值为“3.11”。
• GeminiDB Mongo实例支持4.0版本，取值为“4.0”。
• GeminiDB Influx实例支持1.7版本，取值为“1.7”。
• GeminiDB Redis实例支持5.0版本，取值为“5.0”。

storage_engine

是

String

存储引擎。

• GeminiDB Cassandra实例支持RocksDB存储引擎，取值为“rocksDB”。
• GeminiDB Mongo实例支持RocksDB存储引擎，取值为“rocksDB”。
• GeminiDB Influx实例支持RocksDB存储引擎，取值为“rocksDB”。
• GeminiDB Redis实例支持RocksDB存储引擎，取值为“rocksDB”。

num

是

String

节点数量。

• GeminiDB Cassandra实例的节点数量可取3~60。
• GeminiDB Mongo 4.0版本副本集实例的节点数量为3。
• GeminiDB Influx集群实例的节点数量可取3~16。
• GeminiDB Influx单节点实例的节点数量可取1。
• GeminiDB Redis实例的节点数量可取3~12。

size

是

String

磁盘大小。必须为整数，单位为GB。

GeminiDB Cassandra，GeminiDB Mongo，GeminiDB Influx的最小磁盘容量100GB，最大磁盘容量与实例的性能规格有关。GeminiDB Redis的最大和最小磁盘容量与节点数和实例的性能规格有关。

• GeminiDB Cassandra请参见数据库实例规格。
• GeminiDB Mongo请参见数据库实例规格。
• GeminiDB Influx请参见数据库实例规格。
• GeminiDB Redis请参见数据库实例规格。

storage

是

String

磁盘类型。

取值为“ULTRAHIGH”，表示SSD盘。

spec_code

是

String

资源规格编码。

获取方法请参见查询数据库规格中响应参数“spec_code”的值。

start_time

是

String

备份时间段。自动备份将在该时间段内触发。

取值范围：非空，格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。

• HH取值必须比hh大1。
• mm和MM取值必须相同，且取值必须为00、15、30或45。
• 不传该参数，默认的备份时间段为00:00-01:00。
• 取值示例：23:00-00:00

keep_days

否

String

指定已生成的备份文件可以保存的天数。

取值范围：0~35。

• 取0值，表示不设置自动备份策略。
• 不传该参数，默认开启自动备份策略，备份文件默认保存7天。

charge_mode

是

String

计费模式。

取值范围：

• prePaid：预付费，即包年/包月。
• postPaid：后付费，即按需付费。

period_type

否

String

订购周期类型。

取值范围：

• month：包月。
• year：包年。

period_num

否

String

“charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。

取值范围：

• 当“period_type”为“month”时，取值为1~9。
• 当“period_type”为“year”时，取值为1~3

is_auto_renew

否

String

创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。

• true，表示自动续订。
• false，表示不自动续订，默认为该方式。

is_auto_pay

否

String

创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。

• true，表示自动从账户中支付
• false，表示手动从账户中支付，默认为该支付方式。

backup_id

否

String

全量备份文件ID。

用于根据指定备份恢复数据到一个新创建的实例的场景，此场景下该字段取值不能为空。

source_instance_id

否

String

数据恢复参考的指定实例的ID。

用于恢复指定实例的指定时间点的数据到一个新创建的实例的场景，此场景下该字段取值不能为空。

restore_time

否

Long

数据恢复的指定的时间点。

用于恢复指定实例的指定时间点的数据到一个新创建的实例的场景，此场景下该字段取值不能为空。取值为UTC 13位毫秒数，可通过查询实例可恢复的时间段接口进行查询。

primary_availability_zone

是

String

主可用区，应为单可用区且和备可用区不同。

secondary_availability_zone

是

String

备可用区，应为单可用区且和主可用区不同。

enabled

是

Boolean

true 开启，false 关闭。

枚举值：

• true
• false

type

是

String

黑白名单类型，blackList黑名单，whiteList白名单，仅支持设置黑名单或白名单中的一种。

枚举值：

• blackList
• whiteList

ip_groups

是

Array of 表11 objects

IP地址组中包含的IP或网段列表。

ip

是

String

IP地址或网段。支持IPv4。

description

是

String

备注信息，最大长度255个字符。

id

String

实例ID。

name

String

实例名称，与请求参数相同。

datastore

Datastore object

数据库信息，与请求参数相同。

created

String

创建时间为本地时间，格式为“yyyy-mm-dd hh:mm:ss”。

status

String

实例状态，取值为“creating”。

region

String

区域ID，与请求参数相同。

availability_zone

String

可用区ID，与请求参数相同。

vpc_id

String

虚拟私有云ID，与请求参数相同。

subnet_id

String

子网ID，与请求参数相同。

security_group_id

String

安全组ID，与请求参数相同。

mode

String

实例类型，与请求参数相同。

flavor

Array of Flavor objects

实例规格详情，与请求参数相同。

backup_strategy

BackupStrategy object

高级备份策略，与请求参数相同。

enterprise_project_id

String

企业项目ID。取值为“0”，表示为default企业项目。

ssl_option

String

SSL开关选项，与请求参数相同。

job_id

String

创建实例的工作流ID, 仅创建按需实例时会返回该参数。

order_id

String

创建实例的订单ID，仅创建包年包月时返回该参数。

charge_info

ChargeInfo object

计费类型信息，支持包年包月和按需计费，默认为按需计费。

dedicated_resource_id

String

专属资源ID，只有创建在专属资源上的实例才会返回该字段。

type

String

数据库类型。

• 支持GeminiDB Cassandra、GeminiDB Mongo、GeminiDB Influx和GeminiDB Redis数据库实例。
• 取值为“cassandra”，表示创建GeminiDB Cassandra数据库实例。
• 取值为“mongodb”，表示创建GeminiDB Mongo数据库实例。
• 取值为“influxdb”，表示创建GeminiDB Influx数据库实例。
• 取值为“redis”，表示创建GeminiDB Redis数据库实例。

version

String

数据库版本。

• GeminiDB Cassandra实例支持3.11版本，取值为“3.11”。
• GeminiDB Mongo实例支持4.0版本，取值为“4.0”。
• GeminiDB Influx实例支持1.7版本，取值为“1.7”。
• GeminiDB Redis实例支持5.0版本，取值为“5.0”。

storage_engine

String

存储引擎。

• GeminiDB Cassandra实例支持RocksDB存储引擎，取值为“rocksDB”。
• GeminiDB Mongo实例支持RocksDB存储引擎，取值为“rocksDB”。
• GeminiDB Influx实例支持RocksDB存储引擎，取值为“rocksDB”。
• GeminiDB Redis实例支持RocksDB存储引擎，取值为“rocksDB”。

num

String

节点数量。

• GeminiDB Cassandra实例的节点数量可取3~60。
• GeminiDB Mongo 4.0版本副本集实例的节点数量为3。
• GeminiDB Influx实例的节点数量可取3~16。
• GeminiDB Redis实例的节点数量可取3~12。

size

String

磁盘大小。必须为整数，单位为GB。

GeminiDB Cassandra，GeminiDB Mongo，GeminiDB Influx的最小磁盘容量100GB，最大磁盘容量与实例的性能规格有关。GeminiDB Redis的最大和最小磁盘容量与节点数和实例的性能规格有关。

• GeminiDB Cassandra请参见数据库实例规格。
• GeminiDB Mongo请参见数据库实例规格。
• GeminiDB Influx请参见数据库实例规格。
• GeminiDB Redis请参见数据库实例规格。

storage

String

磁盘类型。

取值为“ULTRAHIGH”，表示SSD盘。

spec_code

String

资源规格编码。

获取方法请参见查询数据库规格中响应参数“spec_code”的值。

start_time

String

备份时间段。自动备份将在该时间段内触发。

取值范围：非空，格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。

• HH取值必须比hh大1。
• mm和MM取值必须相同，且取值必须为00、15、30或45。
• 不传该参数，默认的备份时间段为00:00-01:00。
• 取值示例：23:00-00:00

keep_days

String

指定已生成的备份文件可以保存的天数。

取值范围：0~35。

• 取0值，表示不设置自动备份策略。
• 不传该参数，默认开启自动备份策略，备份文件默认保存7天。

charge_mode

String

计费模式。

取值范围：

• prePaid：预付费，即包年/包月。
• postPaid：后付费，即按需付费。

period_type

String

订购周期类型。

取值范围：

• month：包月。
• year：包年。

period_num

String

“charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。

取值范围：

• 当“period_type”为“month”时，取值为1~9。
• 当“period_type”为“year”时，取值为1~3

is_auto_renew

String

创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。

• true，表示自动续订。
• false，表示不自动续订，默认为该方式。

is_auto_pay

String

创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。

• true，表示自动从账户中支付
• false，表示手动从账户中支付，默认为该支付方式。