5.5 实例管理
5.5.1 创建实例
● 异常响应
请参见异常请求结果。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
5.5 实例管理
5.5.1 创建实例
功能介绍
创建数据库实例。
接口约束
该接口支持如下数据库实例
● GaussDB(for Cassandra)
● GaussDB(for Mongo)副本集4.0
● GaussDB(for Influx)
● GaussDB(for Redis)
● 该接口既支持包周期实例，也支持按需实例。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
POST https://{Endpoint}/v3/{project_id}/instances
● URI样例
https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/
v3/375d8d8fad1f43039e23d3b6c0f60a19/instances
● 参数说明
表5-16 参数说明
名称 是否必选 描述
project_id 是 租户在某一region下的project ID。
请求消息
● 参数说明
表5-17 参数说明
名称 是否必选 参数类型 描述
name 是 String 实例名称，允许和已有名称
重复。
取值范围：
● 实例名称不包含中文时，
长度为4~64位，包含中 文时，长度为4~20位。
● 必须以中文或字母开头
（A~Z或a~z），区分大 小写，可以包含中文、字 母、数字（0~9）、中划 线（-）或者下划线
（_），不能包含其他特 殊字符。
datastore 是 Object 数据库信息。详情请参见表
5-18。
region 是 String 区域ID。
取值：非空，请参见地区和 终端节点。
availability_zo
ne 是 String 可用区ID。
取值：请参见查询数据库规 格中返回的
“az_status” ，支持创建3 可用区实例，中间以逗号隔 开。
名称 是否必选 参数类型 描述
vpc_id 是 String 虚拟私有云ID，获取方法如
下：
● 方法1：登录虚拟私有云 服务的控制台界面，在虚 拟私有云的详情页面查找 VPC ID。
● 方法2：通过虚拟私有云 服务的API接口查询，具 体操作可参考查询VPC列 表。
subnet_id 是 String 子网的网络ID，获取方法如 下：
● 方法1：登录虚拟私有云 服务的控制台界面，单击 VPC下的子网，进入子网 详情页面，查找网络ID。
● 方法2：通过虚拟私有云 服务的API接口查询，具 体操作可参考查询子网列 表。
security_grou
p_id 是 String 安全组ID，获取方法如下：
● 方法1：登录虚拟私有云 服务的控制台界面，在安 全组的详情页面查找安全 组ID。
● 方法2：通过虚拟私有云 服务的API接口查询，具 体操作可参考查询安全组 列表。
password 是 String 数据库密码。
取值范围：长度为8~32位，
必须是大写字母（A~Z）、
小写字母（a~z）、数字
（0~9）、特殊字符~!@#
%^*-_=+?的组合。
建议您输入高强度密码，以 提高安全性，防止出现密码 被暴力破解等安全风险。
名称 是否必选 参数类型 描述
mode 是 String 实例类型。
● GaussDB(for Cassandra) 支持集群类型，取值为
“Cluster”。
● GaussDB(for Mongo) 4.0版本支持副本集类 型，取值为
“ReplicaSet”。
● GaussDB(for Influx)支持 集群类型，取值为
“Cluster”。
● GaussDB(for Redis)支持 集群类型，取值为
“Cluster”。
flavor 是 Array of
objects 实例规格详情。详情请参见 表5-19。
获取方法请参见查询数据库 规格中响应“flavors”字段 下参数的值。
configuration
_id 否 String 参数模板ID。
backup_strate
gy 否 Object 高级备份策略。详情请参见
表5-20。
enterprise_pr
oject_id 否 String 企业项目ID。
● 对于未开通企业多项目服 务的用户，不传该参数。
● 对于已开通企业多项目服 务的用户，不传该参数 时，表示为default企业 项目。
获取方式请参见《企业管理 API参考》的“查询企业项 目列表”响应消息表
“enterprise_project字段数 据结构说明”的“id”。
ssl_option 否 String SSL开关选项。
取值：
● 取“0”，表示默认不启 用SSL连接。
● 取“1”，表示默认启用 SSL连接。
● 不传该参数时，默认不启 用SSL连接。
名称 是否必选 参数类型 描述
charge_info 否 Object 计费类型信息，支持包年包 月和按需计费，默认为按需 计费。详细信息请参见表 5-21。
dedicated_res
ource_id 否 String 专属资源ID，只有开通专属
资源池后才可以下发此参 数。
表5-18 datastore 字段数据结构说明
名称 是否必选 参数类型 描述
type 是 String 数据库类型。
支持GaussDB(for
Cassandra)，GaussDB(for Mongo)，GaussDB(for Influx), GaussDB(for Redis) 数据库实例。
取值为“cassandra”，表示 创建GaussDB(for
Cassandra)数据库实例。
取值为“mongodb”，表示 创建GaussDB(for Mongo)数 据库实例。
取值为“influxdb”，表示创 建GaussDB(for Influx)数据 库实例。
取值为“redis”，表示创建 GaussDB(for Redis)数据库 实例。
version 是 String 数据库版本。
GaussDB(for Cassandra)实 例支持3.11版本，取值为
“3.11”。
GaussDB(for Mongo)实例支 持4.0版本，取值为"4.0"。
GaussDB(for Influx)实例支 持1.7版本，取值为“1.7”。
GaussDB(for Redis)实例支 持5.0版本，取值为“5.0”。
名称 是否必选 参数类型 描述 storage_engi
ne 是 String 存储引擎。
GaussDB(for Cassandra)实 例支持RocksDB存储引擎，
取值为“rocksDB”。
GaussDB(for Mongo)实例支 持RocksDB存储引擎，取值 为“rocksDB”。
GaussDB(for Influx)实例支 持RocksDB存储引擎，取值 为“rocksDB”。
GaussDB(for Redis)实例支 持RocksDB存储引擎，取值 为“rocksDB”。
表5-19 flavor 字段数据结构说明
名称 是否必选 参数类型 描述
num 是 String 节点数量。
● GaussDB(for Cassandra) 实例的节点数量可取 3~12。
● GaussDB(for Mongo) 4.0版本副本集实例的节 点数量可取3。
● GaussDB(for Influx)实例 的节点数量可取3~16。
● GaussDB(for Redis)实例 的节点数量可取3~12。
名称 是否必选 参数类型 描述
size 是 String 磁盘大小。必须为整数，单
位为GB。
GaussDB(for Cassandra)，
GaussDB(for Mongo)，
GaussDB(for Influx)的最小 磁盘容量100GB，最大磁盘 容量与实例的性能规格有 关。GaussDB(for Redis)的 最大和最小磁盘容量与节点 数和实例的性能规格有关。
● GaussDB(for Cassandra) 请参见数据库实例规格。
● GaussDB(for Mongo)请 参见数据库实例规格。
● GaussDB(for Influx)请参 见数据库实例规格。
● GaussDB(for Redis)请参 见数据库实例规格。
storage 是 String 磁盘类型。
取值为“ULTRAHIGH”，表 示SSD盘。
spec_code 是 String 资源规格编码。
获取方法请参见查询数据库 规格中响应参数
“spec_code”的值。
表5-20 backup_strategy 字段数据结构说明
名称 是否必选 参数类型 描述
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天。
表5-21 charge_info 字段数据结构说明
名称 是否必选 参数类型 描述
charge_mode 是 String 计费模式。
取值范围：
● prePaid：预付费，即包 年/包月。
● postPaid：后付费，即按 需付费。
period_type 否 String 订购周期类型。
取值范围：
● month：包月。
● year：包年。
说明“charge_mode”为
“prePaid”时生效，且为必选 值。
period_num 否 String “charge_mode”为
“prePaid”时生效，且为必 选值，指定订购的时间。
取值范围：
● 当“period_type”为
“month”时，取值为 1~9。
● 当“period_type”为
“year”时，取值为 1~3。
名称 是否必选 参数类型 描述 is_auto_rene
w 否 String 创建包周期实例时可指定，
表示是否自动续订，续订的 周期和原周期相同，且续订 时会自动支付。
● true，表示自动续订。
● false，表示不自动续订，
默认为该方式。
is_auto_pay 否 String 创建包周期实例时可指定，
表示是否自动从账户中支 付，该字段不影响自动续订 的支付方式。
● true，表示自动从账户中 支付。
● false，表示手动从账户中 支付，默认为该支付方 式。
说明
请求体样例中参数“region”和“availability_zone”的值为示例值，具体取值请以实际环境为 准。
● 请求体样例
创建按需实例请求样例：
{ "name": "test-cassandra-01", "datastore": {
"type": "cassandra", "version": "3.11",
"storage_engine": "rocksDB"
},
"region": "aaa",
"availability_zone": "bbb,ccc,ddd",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "Test@123",
"mode": "Cluster", "flavor": [
{
"num": "3", "size": "500",
"storage": "ULTRAHIGH",
"spec_code": "geminidb.cassandra.4xlarge.4"
} ],
"backup_strategy": {
"start_time": "08:00-09:00", "keep_days": "8"
}, "enterprise_project_id": "0",
"ssl_option": "1"
}
创建包周期实例请求样例：
{ "name": "test-cassandra-01", "datastore": {
"type": "cassandra", "version": "3.11",
"storage_engine": "rocksDB"
}, "region": "aaa",
"availability_zone": "bbb,ccc,ddd",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "Test@123",
"mode": "Cluster", "flavor": [
{
"num": "3", "size": "500",
"storage": "ULTRAHIGH",
"spec_code": "geminidb.cassandra.4xlarge.4"
}
], "backup_strategy": {
"start_time": "08:00-09:00", "keep_days": "8"
}, "enterprise_project_id": "0", "ssl_option": "1",
"charge_info": {
"charge_mode": "prePaid", "period_type": "year", "period_num": 3, "is_auto_renew": "true", "is_auto_pay": "true"
}}
响应消息
● 正常响应要素说明
表5-22 要素说明
名称 参数类型 描述
id String 实例ID。
name String 实例名称，与请求参数相同。
datastore Object 数据库信息，与请求参数相
同。详情请参见表5-18。
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 objects 实例规格详情，与请求参数相 同。详情请参见表5-19。
backup_strategy Object 高级备份策略，与请求参数相 同。详情请参见表5-20。
enterprise_project_i
d String 企业项目ID。取值为“0”，
表示为default企业项目。
ssl_option String SSL开关选项，与请求参数相 同。
job_id String 创建实例的任务ID, 仅创建按需
实例时会返回该参数。
order_id String 创建实例的订单ID，仅创建包
年包月时返回该参数。
charge_info Object 付费方式信息，与请求参数相 同。
dedicated_resource_
id String 专属资源ID。
说明
响应样例中参数“region”和“availability_zone”的值为示例值。
● 正常响应样例
创建按需实例响应样例：
{ "id": "39b6a1a278844ac48119d86512e0000bin06", "name": "test-cassandra-01",
"datastore": { "type": "cassandra", "version": "3.11",
"storage_engine": "rocksDB"
},
"created": "2019-10-28 14:10:54",
"status": "creating", "region": "aaa",
"availability_zone": "bbb,ccc,ddd",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "mode": "Cluster",
"flavor": [ {
"num": "3", "size": "500",
"storage": "ULTRAHIGH",
"spec_code": "geminidb.cassandra.4xlarge.4"
} ],
"backup_strategy": {
"start_time": "08:00-09:00", "keep_days": "8"
} ,
"enterprise_project_id": "0", "ssl_option": "1",
"job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f"
}
创建包周期实例响应样例：
{ "id": "39b6a1a278844ac48119d86512e0000bin06", "name": "test-cassandra-01",
"datastore": { "type": "cassandra", "version": "3.11",
"storage_engine": "rocksDB"
}, "created": "2019-10-28 14:10:54", "status": "creating",
"region": "aaa",
"availability_zone": "bbb,ccc,ddd",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "mode": "Cluster",
"flavor": [ {
"num": "3", "size": "500",
"storage": "ULTRAHIGH",
"spec_code": "geminidb.cassandra.4xlarge.4"
}
], "backup_strategy": {
"start_time": "08:00-09:00", "keep_days": "8"
}, "enterprise_project_id": "0", "ssl_option": "1",
"order_id": "CS20070721568OVO9", "charge_info": {
"charge_mode": "prePaid", "period_type": "year", "period_num": 3, "is_auto_renew": "true", "is_auto_pay": "true"
}}
● 异常响应
请参见异常请求结果。
状态码
详情请参见状态码。
错误码
详情请参见错误码。