查询实例列表

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

id

否

String

参数解释：

实例ID。

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

name

否

String

参数解释：

实例名称。

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

type

否

String

参数解释：

按照实例类型查询。

约束限制：

当前仅支持Cluster。

取值范围：

Cluster：集群版。

默认取值：

Cluster。

datastore_type

否

String

参数解释：

数据库类型。

约束限制：

现在只支持gaussdb-mysql。

取值范围：

gaussdb-mysql。

默认取值：

gaussdb-mysql。

vpc_id

否

String

参数解释：

虚拟私有云ID。获取方法如下：

• 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。

• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

subnet_id

否

String

参数解释：

子网的网络ID，获取方法如下：

• 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。

• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

private_ip

否

String

参数解释：

读写内网IP地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

readonly_private_ip

否

String

参数解释：

读内网IP地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

proxy_ip

否

String

参数解释：

读写分离IP地址。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

Integer

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

必须为整数，不能为负数。

取值范围：

≥0

默认取值：

0

limit

否

Integer

参数解释：

查询记录数。

约束限制：

必须为整数，不能为负数。

取值范围：

1-100

默认取值：

100

tags

否

String

参数解释：

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

• {key}表示标签键。

• {value}表示标签值。

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

• en-us

• zh-cn

默认取值：

en-us。

instances

Array of MysqlInstanceListInfoUnifyStatus objects

参数解释：

实例列表信息。

total_count

Integer

参数解释：

总记录数。

取值范围：

不涉及。

id

String

参数解释：

实例ID。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

name

String

参数解释：

创建的实例名称。

取值范围：

不涉及。

status

String

参数解释：

实例状态。

取值范围：

• creating：表示实例正在创建。

• normal：表示实例正常。

• abnormal：表示实例异常。

• createfail：表示实例创建失败。

private_ips

Array of strings

参数解释：

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

取值范围：

不涉及。

proxy_ips

Array of strings

参数解释：

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

取值范围：

不涉及。

readonly_private_ips

Array of strings

参数解释：

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

取值范围：

不涉及。

public_ips

Array of strings

参数解释：

实例外网IP地址列表。

取值范围：

不涉及。

port

String

参数解释：

数据库端口号。

取值范围：

1024-65535，不包含端口5342-5345、12017、20000、20201、20202、33062、33071。

type

String

参数解释：

实例类型。

取值范围：

Cluster：集群版。

region

String

参数解释：

实例所在区域。

取值范围：

不涉及。

datastore

MysqlDatastoreWithKernelVersion object

参数解释：

数据库信息。

created

String

参数解释：

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

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

取值范围：

不涉及。

updated

String

参数解释：

更新时间，格式为"yyyy-mm-ddThh:mm:ssZ"。

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

取值范围：

不涉及。

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：后付费，即按需付费。

默认取值：

postPaid。

period_type

String

参数解释：

包周期付费模式下的订购周期类型。

约束限制：

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

参数解释：

创建包年/包月实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。

约束限制：

charge_mode为prePaid时生效。

取值范围：

• true：自动续订。

• false：不自动续订。

默认取值：

false。

is_auto_pay

String

参数解释：

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

约束限制：

charge_mode为prePaid时生效。

取值范围：

• true：自动支付。

• false：手动支付。

默认取值：

true。

key

String

参数解释：

标签键。

取值范围：

不涉及。

value

String

参数解释：

标签值。

取值范围：

不涉及。

error_code

String

错误码。

error_msg

String

错误消息。

error_code

String

错误码。

error_msg

String

错误消息。

200

Success.

400

Client error.

500

Server error.