查询实例列表

project_id

是

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

id

否

String

实例ID。“*”为系统保留字符，如果id是以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照id精确匹配查询。不能只传入“*”。

name

否

String

实例名称。

“*”为系统保留字符，如果name是以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照name精确匹配查询。不能只传入“*”。

type

否

String

按照实例类型查询。目前仅支持Cluster。

datastore_type

否

String

数据库类型，现在只支持gaussdb-mysql。

vpc_id

否

String

虚拟私有云ID。

subnet_id

否

String

子网的网络ID信息。

private_ip

否

String

读写内网IP地址。

readonly_private_ip

否

String

读内网IP地址。

proxy_ip

否

String

读写分离IP地址。

offset

否

Integer

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

limit

否

Integer

查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

tags

否

String

根据实例标签键值对进行查询。

• {key}表示标签键。
• {value}表示标签值。

如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，表示查询同时包含指定标签键值对的实例。key不能重复，key之间是与的关系。

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

• en-us
• zh-cn

instances

Array of MysqlInstanceListInfo objects

实例列表信息。

total_count

Integer

总记录数。

id

String

实例ID，严格匹配UUID规则。

name

String

创建的实例名称。

status

String

实例状态。

取值：

• BUILD：表示实例正在创建。
• ACTIVE：表示实例正常。
• FAILED：表示实例创建失败。
• FROZEN：表示实例冻结。
• MODIFYING：表示实例正在扩容。
• REBOOTING：表示实例正在重启。
• RESTORING：表示实例正在恢复。
• SWITCHOVER：表示实例正在主备切换。
• MIGRATING：表示实例正在迁移。
• BACKING UP：表示实例正在进行备份。
• MODIFYING DATABASE PORT：表示实例正在修改数据库端口。
• STORAGE FULL：表示实例磁盘空间满。

private_ips

Array of strings

实例写内网IP地址列表。弹性云服务器创建成功后该值存在，其他情况下为空字列表。

proxy_ips

Array of strings

实例读写分离IP地址列表。GaussDB(for MySQL)实例开启代理成功后该值存在，其他情况下为空列表。

readonly_private_ips

Array of strings

实例读内网IP地址列表。弹性云服务器创建成功后该值存在，其他情况下为空列表。

public_ips

Array of strings

实例外网IP地址列表。

port

String

数据库端口号。

type

String

实例类型，取值为“Cluster”。

region

String

实例所在区域。

datastore

MysqlDatastoreWithKernelVersion object

数据库信息。

created

String

创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。

其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。

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，只有数据库实例属于专属资源池才会返回该参数。

tags

Array of InstanceTagItem objects

标签列表。

type

String

数据库引擎，现在只支持gaussdb-mysql。

version

String

数据库版本。

kernel_version

String

数据库内核版本。

vcpus

String

CPU核数。

ram

String

内存大小，单位GB。

type

String

磁盘类型。

size

String

已使用磁盘大小，单位GB。

start_time

String

自动备份开始时间段。自动备份将在该时间一个小时内触发。

取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。

1. HH取值必须比hh大1。
2. mm和MM取值必须相同，且取值必须为00。

keep_days

String

自动备份保留天数，取值范围：1-732。

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：为不自动续订，默认该方式。

is_auto_pay

String

创建包年/包月实例时可指定，表示是否自动从客户的帐户中支付，此字段不影响自动续订的支付方式。

• true：为自动支付，默认该方式。
• false：为手动支付。

key

String

标签键。

value

String

标签值。

error_code

String

错误码。

error_msg

String

错误消息。

error_code

String

错误码。

error_msg

String

错误消息。

200

Success.

400

Client error.

500

Server error.