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

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

云数据库 GaussDB

状态码： 200

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

表5 MysqlInstanceListInfo
参数	参数类型	描述
id	String	实例ID。
name	String	创建的实例名称。
status	String	实例状态。
private_ips	Array of strings	实例写内网IP地址列表。弹性云服务器创建成功后该值存在，其他情况下为空字符串。
public_ips	Array of strings	实例外网IP地址列表。
port	String	数据库端口号。
type	String	实例类型，取值为“Cluster”。
region	String	实例所在区域。
datastore	MysqlDatastore object	数据库信息。
created	String	创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。说明：创建时返回值为空，数据库实例创建成功后该值不为空。
updated	String	更新时间，格式与"created"字段对应格式完全相同。说明：创建时返回值为空，数据库实例创建成功后该值不为空。
db_user_name	String	默认用户名。
vpc_id	String	虚拟私有云ID。
subnet_id	String	子网的网络ID信息。
security_group_id	String	安全组ID。
flavor_ref	String	规格码。
flavor_info	MysqlFlavorInfo object	flavor规格信息。
volume	MysqlVolumeInfo object	存储盘信息。
backup_strategy	MysqlBackupStrategy object	自动备份策略
enterprise_project_id	String	企业项目ID。
time_zone	String	时区。
charge_info	MysqlChargeInfo object	计费类型信息，支持包年包月和按需，默认为按需。
dedicated_resource_id	String	专属资源池ID，只有数据库实例属于专属资源池才会返回该参数。

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

表7 MysqlFlavorInfo
参数	参数类型	描述
vcpus	String	CPU核数。
ram	String	内存大小，单位GB。

表8 MysqlVolumeInfo
参数	参数类型	描述
type	String	磁盘类型。
size	String	已使用磁盘大小，单位GB。

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

**表10** MysqlChargeInfo
参数	参数类型	描述
charge_mode	String	计费模式。取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。枚举值： prePaid postPaid
period_type	String	订购周期类型。取值范围： month：包月。 year：包年。说明：“charge_mode”为“prePaid”时生效，且为必选值。枚举值： month year
period_num	Integer	“charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。取值范围：当“period_type”为“month”时，取值为1~9。当“period_type”为“year”时，取值为1~3。
is_auto_renew	String	创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 true，为自动续订。 false，为不自动续订，默认该方式。枚举值： true false
is_auto_pay	String	创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 true，为自动支付，默认该方式。 false，为手动支付。枚举值： true false