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

时间:2025-02-28 11:20:29

响应参数

状态码: 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

参数解释:

实例类型。

取值范围:

与请求参数相同。

product_type

String

参数解释:

产品类型。GeminiDB Redis云原生部署模式集群涉及此字段。

取值范围:

  • Standard 标准型
  • Capacity 容量型

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,可以通过升级补丁接口进行数据库升级。
  • false,不可以通过升级补丁接口进行数据库升级。

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,表示该节点不支持节点缩容。
support.huaweicloud.com/api-nosql/nosql_05_0016.html