云数据库 GAUSSDB-创建数据库实例(v3.1):响应参数

时间:2024-10-11 17:18:04

响应参数

表8 响应参数

名称

参数类型

说明

instance

Object

实例信息。

详情请参见表9

job_id

String

实例创建的任务ID。

仅创建按需实例时会返回该参数。

order_id

String

订单号,创建包年包月时返回该参数。

表9 instance说明

名称

参数类型

说明

id

String

实例ID。

name

String

实例名称。用于表示实例的名称,同一租户下,同类型的实例名称可相同。

取值范围:4~64个字符之间,必须以字母开头,不区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符。

status

String

实例状态。如BUILD,表示创建中。

仅创建按需实例时会返回该参数。

datastore

Object

数据库信息。

详情请参见表10

ha

Object

数据库部署形态。

详情请参见表11

replica_num

Integer

实例副本集数。

port

String

数据库端口信息,与请求参数相同。

backup_strategy

Object

自动备份策略。

详情请参见表12

enterprise_project_id

String

项目标签。

flavor_ref

String

规格码,取值范围:非空。

volume

Object

volume信息。

详情请参见表13

region

String

区域ID。

availability_zone

String

可用区ID。

vpc_id

String

虚拟私有云ID。

subnet_id

String

子网的网络ID信息。

security_group_id

String

实例所属的安全组。

charge_info

Object

付费方式信息。

详情请参见表14

表10 datastore字段数据结构说明

名称

参数类型

说明

type

String

数据库引擎,返回值如下:

GaussDB

version

String

数据库版本。

表11 ha字段数据结构说明

名称

参数类型

说明

mode

String

GaussDB分布式模式支持取值:enterprise(企业版) ,combined(基础版混合部署),主备版取值:centralization_standard,不区分大小写。

replication_mode

String

备机同步模式。固定取值为sync,表示数据同步方式为“同步模式”。

consistency

String

GaussDB的预留参数:指定事务一致性类型,取值范围:

  • strong:强一致性。
  • eventual:最终一致性。

consistency_protocol

String

指定副本一致性协议类型,取值范围:quorum 、paxos。不填时,默认为quorum。

表12 backup_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天。

表13 volume字段数据结构说明

名称

参数类型

说明

type

String

磁盘类型。

取值如下,区分大小写:

  • ULTRAHIGH,表示SSD盘。
  • ESSD,表示极速云盘。

size

Integer

磁盘大小。

表14 charge_Info字段数据结构说明

名称

参数类型

说明

charge_mode

String

计费模式。

postPaid:后付费,即按需付费。

prePaid:预付费,即包年/包月。

period_type

String

订购周期类型。month:包月。year:包年。说明:“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,表示手动从账户中支付,默认为该支付方式。

support.huaweicloud.com/api-gaussdb/gaussdb_api_017.html