云数据库 GEMINIDB-查询实例列表和详情:响应参数

时间：2024-05-10 17:21:41

云数据库 GEMINIDB 实例管理

响应参数

状态码： 200

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

表5 ListInstancesResult
参数	参数类型	描述
id	String	实例ID。
name	String	实例名称。
status	String	实例状态。取值： normal，表示实例正常。 abnormal，表示实例异常。 creating，表示实例创建中。 frozen，表示实例被冻结。 data_disk_full，表示实例磁盘已满。 createfail，表示实例创建失败。 enlargefail，表示实例扩容节点个数失败。
port	String	数据库端口。
mode	String	实例类型。与请求参数相同。
region	String	实例所在区域。
datastore	ListInstancesDatastoreResult object	数据库信息。
engine	String	存储引擎。取值为“rocksDB”。
created	String	实例创建时间。
updated	String	实例操作最新变更的时间。
db_user_name	String	默认用户名。取值为“rwuser”。
vpc_id	String	虚拟私有云ID。
subnet_id	String	子网ID。 GeminiDB Cassandra 实例使用多个子网的场景，请参见表 ListInstancesNodeResult字段数据结构说明中的“subnet_id”。
security_group_id	String	安全组ID。
backup_strategy	ListInstancesBackupStrategyResult object	备份策略。
pay_mode	String	计费方式。取值为“0”，表示按需计费。取值为“1”，表示包年/包月计费。
maintenance_window	String	系统可维护时间窗。
groups	Array of ListInstancesGroupResult objects	组信息。
enterprise_project_id	String	企业项目ID。取值为“0”，表示为default企业项目。
time_zone	String	时区。
actions	Array of strings	实例正在执行的动作。示例： CREATE REBOOT RESTORE
dedicated_resource_id	String	专属资源ID，只有数据库实例属于专属资源池才会返回该参数。
lb_ip_address	String	负载均衡IP，只有存在负载均衡IP，才会返回该参数。
lb_port	String	负载均衡端口，只有存在负载均衡IP，才会返回该参数。
availability_zone	String	可用区。

表6 ListInstancesDatastoreResult
参数	参数类型	描述
type	String	数据库接口。
version	String	数据库版本号。
patch_available	Boolean	当前实例是否有可升级的补丁，返回true时可以通过“数据库补丁升级”进行升级。
whole_version	String	数据库的完整版本号(目前只有GeminiDB Cassandra支持)。

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

表8 ListInstancesGroupResult
参数	参数类型	描述
id	String	组ID。
status	String	组状态。取值： normal，表示组正常。 abnormal，表示组异常。 creating，表示组创建中。 createfail，表示组创建失败。 deleted，表示组被删除。 resizefailed，表示组规格变更失败。 enlargefail，表示组扩容失败。
volume	Volume object	volume信息
nodes	Array of ListInstancesNodeResult objects	节点信息。

表9 Volume
参数	参数类型	描述
size	String	磁盘大小。单位：GB。
used	String	磁盘使用量。单位：GB。

**表10** ListInstancesNodeResult
参数	参数类型	描述
id	String	节点ID。
name	String	节点名称。
status	String	节点状态。取值： normal，表示节点正常。 abnormal，表示节点异常。 creating，表示节点创建中。 createfail，表示节点创建失败。 deleted，表示节点被删除。 resizefailed，表示节点规格变更失败。 enlargefail，表示节点扩容失败。
role	String	节点角色。该参数仅对GeminiDB Mongo接口的副本集实例有效。
subnet_id	String	节点所在的子网的ID。
private_ip	String	节点内网IP。在弹性云服务器创建成功后参数值存在，否则，值为""。
public_ip	String	绑定的公网IP。该参数仅针对绑定了公网IP的节点有效。
spec_code	String	资源规格编码。关于实例的规格信息，请参见查询数据库规格中响应参数“flavors.spec_code”的值。
availability_zone	String	可用区。
support_reduce	Boolean	是否支持节点缩容。 true，表示该节点支持节点缩容。 false，表示该节点不支持节点缩容。