{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"InstanceTagItem":{"properties":{"key":{"description":"标签键。","type":"string"},"value":{"description":"标签值。","type":"string"}},"required":["key","value"]},"MysqlBackupStrategy":{"description":"自动备份策略","properties":{"keep_days":{"description":"自动备份保留天数,取值范围:1-732","type":"string"},"start_time":{"description":"自动备份开始时间段。自动备份将在该时间一个小时内触发。\n\n取值范围:非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。\n\n1. HH取值必须比hh大1。\n2. mm和MM取值必须相同,且取值必须为00。","example":"23:00-00:00","type":"string"}},"required":["start_time"]},"MysqlChargeInfo":{"description":"计费类型信息,支持包年包月和按需,默认为按需。","properties":{"charge_mode":{"description":"计费模式。\n\n取值范围:\n\n- prePaid:预付费,即包年/包月。\n- postPaid:后付费,即按需付费。","enum":["prePaid","postPaid"],"type":"string"},"is_auto_pay":{"description":"创建包周期时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。\n\n- true,为自动支付,默认该方式。\n- false,为手动支付。","type":"string"},"is_auto_renew":{"description":"创建包周期实例时可指定,表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。\n\n- true,为自动续订。\n- false,为不自动续订,默认该方式。","type":"string"},"period_num":{"description":"“charge_mode”为“prePaid”时生效,且为必选值,指定订购的时间。\n\n取值范围:\n\n当“period_type”为“month”时,取值为1~9。\n当“period_type”为“year”时,取值为1~3。","format":"int32","type":"integer"},"period_type":{"description":"订购周期类型。\n\n取值范围:\n\n- month:包月。\n- year:包年。\n\n说明:“charge_mode”为“prePaid”时生效,且为必选值。","enum":["month","year"],"type":"string"}},"required":["charge_mode"]},"MysqlDatastoreWithKernelVersion":{"description":"数据库信息。","properties":{"kernel_version":{"description":"数据库内核版本","type":"string"},"type":{"description":"数据库引擎,现在只支持gaussdb-mysql。","type":"string"},"version":{"description":"兼容的开源数据库版本号,返回三位开源版本号。","type":"string"}},"required":["type","version","kernel_version"]},"MysqlErrorResponse":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200022","type":"string"},"error_msg":{"description":"错误消息。","example":"实例不存在","type":"string"}},"required":["error_code","error_msg"]},"MysqlFlavorInfo":{"description":"flavor规格信息。","properties":{"ram":{"description":"内存大小,单位GB。","type":"string"},"vcpus":{"description":"CPU核数。","type":"string"}},"required":["vcpus","ram"]},"MysqlInstanceList":{"properties":{"instances":{"description":"实例列表信息。","items":{"$ref":"#/definitions/MysqlInstanceListInfo"},"type":"array"},"total_count":{"description":"总记录数。","format":"int32","type":"integer"}},"required":["instances","total_count"]},"MysqlInstanceListInfo":{"properties":{"backup_strategy":{"$ref":"#/definitions/MysqlBackupStrategy"},"charge_info":{"$ref":"#/definitions/MysqlChargeInfo"},"created":{"description":"创建时间,格式为\"yyyy-mm-ddThh:mm:ssZ\"。\n\n其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。\n\n说明:创建时返回值为空,数据库实例创建成功后该值不为空。","type":"string"},"datastore":{"$ref":"#/definitions/MysqlDatastoreWithKernelVersion"},"db_user_name":{"description":"默认用户名。","type":"string"},"dedicated_resource_id":{"description":"专属资源池ID,只有数据库实例属于专属资源池才会返回该参数。","type":"string"},"enterprise_project_id":{"description":"企业项目ID。","type":"string"},"flavor_info":{"$ref":"#/definitions/MysqlFlavorInfo"},"flavor_ref":{"description":"规格码。","type":"string"},"id":{"description":"实例ID。","type":"string"},"name":{"description":"创建的实例名称。","type":"string"},"port":{"description":"数据库端口号。","type":"string"},"private_ips":{"description":"实例写内网IP地址列表。弹性云服务器创建成功后该值存在,其他情况下为空字列表。","items":{"type":"string"},"type":"array"},"proxy_ips":{"description":"实例读写分离IP地址列表。TaurusDB实例开启代理成功后该值存在,其他情况下为空列表。","items":{"type":"string"},"type":"array"},"public_ips":{"description":"实例外网IP地址列表。","items":{"type":"string"},"type":"array"},"readonly_private_ips":{"description":"实例读内网IP地址列表。弹性云服务器创建成功后该值存在,其他情况下为空列表。","items":{"type":"string"},"type":"array"},"region":{"description":"实例所在区域。","type":"string"},"security_group_id":{"description":"安全组ID。","type":"string"},"status":{"description":"实例状态。","type":"string"},"subnet_id":{"description":"子网的网络ID信息。","type":"string"},"tags":{"description":"标签列表。","items":{"$ref":"#/definitions/InstanceTagItem"},"type":"array"},"time_zone":{"description":"时区。","type":"string"},"type":{"description":"实例类型,取值为“Cluster”。","type":"string"},"updated":{"description":"更新时间,格式与\"created\"字段对应格式完全相同。\n\n说明:创建时返回值为空,数据库实例创建成功后该值不为空。","type":"string"},"volume":{"$ref":"#/definitions/MysqlVolumeInfo"},"vpc_id":{"description":"虚拟私有云ID。","type":"string"}},"required":["id","name"]},"MysqlVolumeInfo":{"description":"存储盘信息。","properties":{"size":{"description":"已使用磁盘大小,单位GB。","type":"string"},"type":{"description":"磁盘类型。","type":"string"}},"required":["type","size"]}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"503dea6cce9f414b807781012957c850","info_version":"v3","method":"get","name":"ListGaussMySqlInstances","parameters":{},"paths":{"/v3/{project_id}/instances":{"get":{"description":"根据指定条件查询实例列表。","operationId":"ListGaussMySqlInstances","parameters":[{"description":"用户Token。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"******"},{"description":"语言。","in":"header","name":"X-Language","required":false,"type":"string","x-example":"zh-cn"},{"description":"租户在某一region下的project ID。\n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。\n","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"实例ID。\n“\\*”为系统保留字符,如果id是以“\\*”起始,表示按照“\\*”后面的值模糊匹配,否则,按照id精确匹配查询。不能只传入“\\*”。","in":"query","name":"id","type":"string","x-example":"2f7be53812044494a44c08398b188ca3in07"},{"description":"实例名称。\n\n“\\*”为系统保留字符,如果name是以“\\*”起始,表示按照“\\*”后面的值模糊匹配,否则,按照name精确匹配查询。不能只传入“\\*”。","in":"query","name":"name","type":"string","x-example":"gauss_0926"},{"description":"按照实例类型查询。目前仅支持Cluster。","in":"query","name":"type","type":"string","x-example":"Cluster"},{"description":"数据库类型,现在只支持gaussdb-mysql。","in":"query","name":"datastore_type","type":"string","x-example":"gaussdb-mysql"},{"description":"虚拟私有云ID。","in":"query","name":"vpc_id","type":"string","x-example":"f7ee62e2-9705-4523-ba49-a85ea1a1fa87"},{"description":"子网的网络ID信息。","in":"query","name":"subnet_id","type":"string","x-example":"f4254a92-70d3-4c80-b38d-4a72f2a4357c"},{"description":"读写内网IP。","in":"query","name":"private_ip","type":"string","x-example":"192.168.0.142"},{"description":"读内网IP。","in":"query","name":"readonly_private_ip","type":"string","x-example":"192.168.0.228"},{"description":"读写分离IP。","in":"query","name":"proxy_ip","type":"string","x-example":"192.168.0.15"},{"description":"索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。","format":"int32","in":"query","name":"offset","type":"integer","x-example":"0"},{"description":"查询记录数。默认为100,不能为负数,最小值为1,最大值为100。","format":"int32","in":"query","name":"limit","type":"integer","x-example":"100"},{"description":"根据实例标签键值对进行查询。\n- {key}表示标签键。\n- {value}表示标签值。\n\n如果同时使用多个标签键值对进行查询,中间使用逗号分隔开,表示查询同时包含指定标签键值对的实例。key不能重复,key之间是与的关系。","in":"query","name":"tags","required":false,"type":"string"}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"instances":[{"backup_strategy":{"keep_days":7,"start_time":"19:00-20:00"},"charge_info":{"charge_mode":"postPaid"},"created":"2018-08-20T02:33:49_0800","datastore":{"kernel_version":"2.0.29.1","type":"gaussdb-mysql","version":"8.0.22"},"db_user_name":"root","enterprise_project_id":0,"flavor_info":{"ram":16,"vcpus":8},"flavor_ref":"gaussdb.mysql.c3.small.4","id":"d738399de028480fabb2b8120d4e01a4in07","name":"gaussdb-mysql-instance01","port":3306,"private_ips":["192.168.0.142"],"proxy_ips":["192.168.0.15"],"readonly_private_ips":["192.168.0.228","192.168.0.165"],"region":"cn-north-4","security_group_id":"fc577a1a-f202-424a-977f-24faec3fdd55","status":"ACTIVE","subnet_id":"c1cfa53c-65d3-431e-8552-326bf310c7ad","tags":[],"time_zone":"UTC","type":"Cluster","updated":"2018-08-20T02:33:49_0800","volume":{"size":100,"type":"POOL"},"vpc_id":"3cedfc54-b105-4652-a4e0-847b11576b58"}],"total_count":1}},"schema":{"$ref":"#/definitions/MysqlInstanceList"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}}},"summary":"查询实例列表","tags":["实例管理"],"x-is-registered":"N","x-request-examples-description-1":"查询TaurusDB实例列表,读写内网IP是192.168.0.142。","x-request-examples-url-1":"GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances?id=61a4ea66210545909d74a05c27a7179ein07&name=hyAbc&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&private_ip=192.168.0.142&offset=0&limit=10&tags=taurusKey1=value1","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询实例列表","tags":"实例管理","uri":null,"version":"2.0"}