云数据库 GaussDB-批量查询实例详情:响应参数

时间：2023-11-01 16:20:15

云数据库 GaussDB

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
instances	Array of MysqlInstanceInfoDetail objects	实例详情。

表5 MysqlInstanceInfoDetail
参数	参数类型	描述
id	String	实例ID。
name	String	创建的实例名称。
project_id	String	租户在某一region下的project ID。
status	String	实例状态。取值：值为“BUILD”，表示实例正在创建。值为“ACTIVE”，表示实例正常。值为“FAILED”，表示实例创建失败。值为“FROZEN”，表示实例冻结。值为“MODIFYING”，表示实例正在扩容。值为“REBOOTING”，表示实例正在重启。值为“RESTORING”，表示实例正在恢复。值为“SWITCHOVER”，表示实例正在主备切换。值为“MIGRATING”，表示实例正在迁移。值为“BACKING UP”，表示实例正在进行备份。值为“MODIFYING DATABASE PORT”，表示实例正在修改数据库端口。值为“STORAGE FULL”，表示实例磁盘空间满。
port	String	数据库端口号。
alias	String	实例备注
type	String	实例类型，取值为“Cluster”。
charge_info	MysqlInstanceChargeInfo object	计费类型信息，支持包年包月和按需，默认为按需。
node_count	Integer	节点个数。
datastore	MysqlDatastoreWithKernelVersion object	数据库信息。
backup_used_space	Double	备份空间使用大小，单位为GB。
created	String	创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。说明：创建时返回值为空，数据库实例创建成功后该值不为空。
updated	String	更新时间，格式与"created"字段对应格式完全相同。说明：创建时返回值为空，数据库实例创建成功后该值不为空。
private_write_ips	Array of strings	实例的写内网IP。
public_ips	String	实例的公网IP。
db_user_name	String	默认用户名。
vpc_id	String	虚拟私有云ID。
subnet_id	String	子网的网络ID信息。
security_group_id	String	安全组ID。
configuration_id	String	实例创建的模板ID，或者应用到实例的最新参数组模板ID。
backup_strategy	MysqlBackupStrategy object	自动备份策略
nodes	Array of MysqlInstanceNodeInfo objects	节点信息。
enterprise_project_id	String	企业项目ID。
time_zone	String	时区。
az_mode	String	可用区模式，单可用区single或多可用区multi。
master_az_code	String	主可用区。
maintenance_window	String	可维护时间窗，为UTC时间。
tags	Array of MysqlTags objects	实例标签。
dedicated_resource_id	String	专属资源池ID，只有数据库实例属于专属资源池才会返回该参数。
proxies	Array of MysqlProxyInfo objects	Proxy信息。

表6 MysqlInstanceChargeInfo
参数	参数类型	描述
charge_mode	String	计费模式。
order_id	String	订单号。

表7 MysqlDatastoreWithKernelVersion
参数	参数类型	描述
type	String	数据库引擎，现在只支持gaussdb-mysql
version	String	数据库版本。数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。
kernel_version	String	数据库内核版本

表8 MysqlBackupStrategy
参数	参数类型	描述
start_time	String	自动备份开始时间段。自动备份将在该时间一个小时内触发。取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。
keep_days	String	自动备份保留天数，取值范围：1-732

表9 MysqlInstanceNodeInfo
参数	参数类型	描述
id	String	实例ID。
name	String	节点名称。
type	String	节点类型，master或slave。
status	String	节点状态。
port	Integer	数据库端口号。
private_read_ips	Array of strings	节点的读内网地址。
volume	MysqlInstanceNodeVolumeInfo object	存储盘信息。
az_code	String	可用区。
region_code	String	实例所在的区域。
created	String	创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。说明：创建时返回值为空，数据库实例创建成功后该值不为空。
updated	String	更新时间，格式与"created"字段对应格式完全相同。说明：创建时返回值为空，数据库实例创建成功后该值不为空。
flavor_id	String	规格ID。
flavor_ref	String	规格码。
max_connections	String	允许的最大连接数。
vcpus	String	CPU核数。
ram	String	内存大小，单位为GB。
need_restart	Boolean	是否需要重启使修改的参数生效。
priority	Integer	主备倒换优先级。

**表10** MysqlInstanceNodeVolumeInfo
参数	参数类型	描述
type	String	磁盘类型。
used	String	已使用磁盘大小，单位GB。
size	Long	包周期购买的存储空间大小，单位GB。

**表11** MysqlTags
参数	参数类型	描述
key	String	标签键。最大长度36个unicode字符。key不能为空或者空字符串，不能为空格。字符集：A-Z，a-z ，0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。
value	String	标签值。最大长度43个unicode字符。可以为空字符串。字符集：A-Z，a-z ，0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。