# 查询实例列表 #### 功能介绍 根据指定条件查询实例列表。 ![](https://support.huaweicloud.com/api-taurusdb/public_sys-resources/notice_3.0-zh-cn.png) **当前页面API为历史版本API，未来可能停止维护。建议及时切换到新接口[查询实例列表](https://support.huaweicloud.com/api-taurusdb/ListGaussMySqlInstances.html)。** #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。 #### URI GET /mysql/v3/{project_id}/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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信息。 | | offset | 否 | Integer | 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 | | limit | 否 | Integer | 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 | | X-Language | 否 | String | 请求语言类型。默认en-us。 取值范围： - en-us - zh-cn | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instances | Array of [MysqlInstanceListInfo] objects | 实例列表信息。 | | total_count | Integer | 总记录数。 | 表5MysqlInstanceListInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 实例ID。 | | 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地址列表。弹性云服务器创建成功后该值存在，其他情况下为空字符串。 | | 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，只有数据库实例属于专属资源池才会返回该参数。 | 表6MysqlDatastore | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 数据库引擎，现在只支持gaussdb-mysql | | version | String | 数据库版本。 数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。 | 表7MysqlFlavorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | vcpus | String | CPU核数。 | | ram | String | 内存大小，单位GB。 | 表8MysqlVolumeInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 磁盘类型。 | | size | String | 已使用磁盘大小，单位GB。 | 表9MysqlBackupStrategy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | start_time | String | 自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 1. HH取值必须比hh大1。 2. mm和MM取值必须相同，且取值必须为00。 | | keep_days | String | 自动备份保留天数，取值范围：1-732。 | 表10MysqlChargeInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | charge_mode | String | 计费模式。 取值范围： - prePaid：预付费，即包年/包月。 - postPaid：后付费，即按需付费。 | | period_type | String | 订购周期类型。 取值范围： - month：包月。 - year：包年。 说明："charge_mode"为"prePaid"时生效，且为必选值。 | | 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，为手动支付。 | **状态码： 400** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | **状态码： 500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | #### 请求示例 查询实例列表。 ``` GET https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10 ``` #### 响应示例 **状态码： 200** Success. ``` { "instances" : [ { "id" : "d738399de028480fabb2b8120d4e01a4in07", "status" : "ACTIVE", "name" : "gaussdb-mysql-instance01", "private_ips": ["192.168.100.136"], "readonly_private_ips": ["192.168.100.78","192.168.100.147"], "proxy_ips": ["192.168.100.83"], "port": "3306", "type" : "Cluster", "private_ips" : [ "192.168.0.142" ], "db_user_name" : "root", "region" : "cn-north-4", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0", "kernel_version": "2.0.54.240600" }, "created" : "2018-08-20T02:33:49_0800", "updated" : "2018-08-20T02:33:49_0800", "volume" : { "type" : "POOL", "used_size" : 100 }, "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "flavor_ref" : "gaussdb.mysql.c3.small.4", "flavor_info" : { "vcpus" : 8, "ram" : 16 }, "backup_strategy" : { "start_time" : "19:00-20:00", "keep_days" : 7 }, "charge_info" : { "charge_mode" : "postPaid" }, "enterprise_project_id" : 0, "time_zone" : "UTC", "tags" : [ ], "dedicated_resource_id" : "" } ], "total_count" : 1 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。