云数据库 GAUSSDB-查询数据库实例列表:响应参数

时间：2024-10-23 09:53:40

云数据库 GAUSSDB

响应参数

表3 响应参数
参数	参数类型	描述
instances	Array of 表4 objects	实例信息。
total_count	Integer	总记录数。

表4 instances
参数	参数类型	描述
id	String	实例ID。
name	String	创建的实例名称。
status	String	实例状态。取值：值为“BUILD”，表示实例正在创建。值为“ACTIVE”，表示实例正常。值为“FAILED”，表示实例异常。值为“FROZEN”，表示实例冻结。值为“MODIFYING”，表示实例正在扩容磁盘或者变更规格。值为“EXPANDING”，表示实例正在添加只读节点或扩容CN或DN。值为“REBOOTING”，表示实例正在重启。值为“REDUCING”, 表示实例正在删除只读节点。值为“UPGRADING”，表示实例正在升级。值为“RESTORING”，表示实例正在恢复。值为“SWITCHOVER”，表示实例正在主备切换。值为“MIGRATING”，表示实例正在迁移。值为“BACKING UP”，表示实例正在进行备份。值为“UPGRADE TO BE OBSERVED”，表示实例正在进行升级待观察。值为“REDUCING REPLICATION”，表示实例正在降副本。值为“STORAGE FULL”，表示实例磁盘空间满。
private_ips	Array of strings	实例内网IP地址列表。分布式CN所在的弹性云服务器创建成功后该值存在，主备版DN所在的弹性云服务器创建成功后该值存在，其他情况下为空字符串。
public_ips	Array of strings	实例外网IP地址列表。绑定弹性公网IP后，该值不为空。
port	Integer	数据库端口号。 GaussDB数据库端口设置范围为1024~39998（其中2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,20049,20050,21731,21732被系统占用不可设置）。当不传该参数时，默认端口8000。
type	String	实例类型，区分大小写。 Enterprise：分布式实例（企业版）。 centralization_standard：主备版实例。 Combined：分布式实例（混合部署）。
ha	表5 object	获取分布式/主备版实例时返回。
replica_num	Integer	实例副本数。
region	String	实例所在区域。
datastore	表6 object	数据库信息。
created	String	创建时间，格式为“yyyy-mm-dd hh:mm:ss timezone”。其中timezone是指时区。说明：创建时该值为实例下发创建的时间，创建完成后，该值为创建完成时间。例如：2024-07-02 08:32:07 UTC。
updated	String	更新时间，格式与“created”字段对应格式完全相同。说明：创建时返回值为空，数据库实例创建成功后该值不为空。
db_user_name	String	默认用户名。
vpc_id	String	虚拟私有云ID。
subnet_id	String	子网的网络ID信息。
security_group_id	String	安全组ID。
flavor_ref	String	规格码。参考查询数据库规格中“spec_code”字段获取。
flavor_info	表8 object	规格信息。
volume	表9 object	Volume信息。
switch_strategy	String	数据库切换策略。如果创建实例时没有选择切换策略，则该字段不显示。取值为“Reliability”或“Availability”，分别对应于可靠性优先和可用性优先。若创建时没有选择切换策略，则不予显示。
backup_strategy	表10 object	备份策略。
maintenance_window	String	可维护时间窗，为UTC时间。
nodes	Array of 表11 objects	实例节点信息列表。
disk_encryption_id	String	磁盘加密密钥ID。只有创建磁盘加密实例才会显示该参数。
enterprise_project_id	String	企业项目标签ID。非企业项目账号的实例，企业项目默认0。
instance_mode	String	实例类型。 basic：基础版。 enterprise：企业版。
disk_encryption_id	String	磁盘加密密钥ID。只有创建磁盘加密实例才会显示该参数。
charge_info	表12 object	计费类型信息，支持按需和包周期。
time_zone	String	时区。
tags	Array of 表13 objects	标签列表，没有标签不返回该参数。
disk_usage	String	实例磁盘的可使用率，值范围[0-1]，值保留四位小数。
mysql_compatibility	表14 mysql_compatibility object	实例M兼容配置。

表5 ha
参数	参数类型	描述
consistency	String	数据库一致性类型，仅支持分布式实例。取值范围： strong：强一致性。 eventual：最终一致性。
replication_mode	String	备机同步参数，非空，支持“sync”，表示同步模式。

表6 datastore
参数	参数类型	描述
type	String	数据库引擎。
version	String	数据库大版本。
complete_version	String	数据库小版本。
target_version	String	数据库正在升级的目标版本。
complete_kernel_version	String	数据库内核版本。
hotfix_version_infos	Array of 表7 objects	热补丁信息列表。

表7 hotfix_version_infos
参数	参数类型	描述
version	String	热补丁版本。
upgrade_finished_time	String	热补丁升级完成时间列表。热补丁升级完成时间，格式为“yyyy-mm-dd hh:mm:ss timezone”。其中timezone是指时区。

表8 flavor_info
参数	参数类型	描述
vcpu	Integer	CPU核数。
mem	Integer	内存大小。

表9 volume
参数	参数类型	描述
type	String	磁盘类型。仅支持ULTRAHIGH和ESSD，区分大小写，分别表示SSD和极速云盘。
size	Integer	磁盘大小。

**表10** backup_strategy
参数	参数类型	描述
start_time	String	备份时间段。自动备份将在该时间段内触发。当前时间指UTC时间。
keep_days	Integer	已生成的备份文件可以保存的天数。取值范围：1～732。

**表11** nodes
参数	参数类型	描述
id	String	节点ID。
name	String	节点名称。
role	String	节点类型。 master：主节点。 slave：备节点。 secondary：日志节点。 readreplica：只读节点。
status	String	节点状态。值为“BUILD_FAILED”，表示节点创建失败。
availability_zone	String	可用区。
private_ip	String	节点内网IP。分布式实例类型下该参数仅针对CN节点有效，主备版实例类型下该参数对所有节点有效，且在弹性云服务器创建成功后参数值存在。
public_ip	String	绑定的外网IP。分布式实例类型下该参数仅针对CN节点有效，主备版实例类型下该参数对所有节点有效，且在弹性云服务器创建成功并绑定弹性公网IP后参数值存在。
component_names	String	节点上组件信息（例组件ID:分布式ID），多个组件信息用;隔开。