云数据库 GaussDB-恢复到新实例:响应参数

时间:2025-02-12 15:00:56

响应参数

表7 要素说明

参数

参数类型

描述

instance

Object

实例信息。

详情请参见表8

job_id

String

恢复新实例的任务id。

order_id

string

创建实例的订单ID。

仅创建包周期实例时会返回该参数。

表8 instance说明

参数

参数类型

描述

id

String

实例id。

name

String

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

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

status

String

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

datastore

Object

数据库信息。

详情请参见表9

ha

Object

实例部署形态。

详情请参见表10

port

String

数据库端口信息。 当不传该参数时,默认端口8000。

enterprise_project_id

String

项目标签。

volume

Object

volume信息。

详情请参见表11

backup_strategy

Object

自动备份策略。

详情请参见表12

replica_num

Integer

实例副本数。

region

String

区域ID。

取值范围:非空,请参见地区和终端节点

flavor_ref

String

规格码。

availability_zone

String

可用区ID。可选部署在同一可用区或三个不同可用区,可用区之间用逗号隔开。

取值范围:非空,请参见地区和终端节点

vpc_id

String

虚拟私有云ID。

subnet_id

String

子网ID。

security_group_id

String

安全组ID。

charge_info

Object

付费方式信息,支持按需和包周期。

详情请参见表13

表9 datastore字段数据结构说明

参数

参数类型

描述

type

String

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

枚举值:

  • GaussDB

version

String

数据库版本。

表10 ha字段数据结构说明

参数

参数类型

描述

mode

String

GaussDB 分布式模式,返回值为:enterprise(企业版);主备版,返回值为:centralization_standard(主备版)。

replication_mode

String

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

consistency

String

GaussDB的预留参数:指定实例一致性类型,取值范围:strong(强一致性) | eventual(最终一致性)。

枚举值:

  • strong
  • eventual
表11 volume字段数据结构说明

参数

参数类型

描述

type

String

磁盘类型。

取值如下,区分大小写:

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

枚举值:

  • ULTRAHIGH
  • ESSD

size

Integer

磁盘大小。

GaussDB分布式实例恢复时需指定大小:要求必须为(分片数*4GB)的倍数,取值范围:(分片数*40GB)~(分片数*16TB)。

表12 backup_strategy字段数据结构说明

参数

参数类型

描述

start_time

String

废弃字段。无需关注。

keep_days

Integer

废弃字段。无需关注。

表13 charge_info字段数据结构说明

参数

参数类型

描述

charge_mode

String

计费模式。支持postPaid,后付费,即按需付费;perPaid,先付费,即包周期。

period_type

string

订购周期类型。month:包月。year:包年。 说明: “charge_mode”为“prePaid”时生效,且为必选值。

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_074.html