{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"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"]},"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"]},"MysqlInstanceChargeInfo":{"description":"计费类型信息,支持包年包月和按需,默认为按需。","properties":{"charge_mode":{"description":"计费模式。","type":"string"},"order_id":{"description":"订单号。","type":"string"}},"required":["charge_mode"]},"MysqlInstanceInfo":{"properties":{"instance":{"$ref":"#/definitions/MysqlInstanceInfoDetail","description":"实例信息。"}},"required":["instance"]},"MysqlInstanceInfoDetail":{"properties":{"alias":{"description":"实例备注","type":"string"},"az_mode":{"description":"可用区模式,单可用区single或多可用区multi。","type":"string"},"backup_strategy":{"$ref":"#/definitions/MysqlBackupStrategy"},"backup_used_space":{"description":"备份空间使用大小,单位为GB。","format":"double","type":"number"},"charge_info":{"$ref":"#/definitions/MysqlInstanceChargeInfo"},"configuration_id":{"description":"实例创建的模板ID,或者应用到实例的最新参数组模板ID。","type":"string"},"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"},"id":{"description":"实例ID。","type":"string"},"maintenance_window":{"description":"可维护时间窗,为UTC时间。","type":"string"},"master_az_code":{"description":"主可用区。","type":"string"},"name":{"description":"创建的实例名称。","type":"string"},"node_count":{"description":"节点个数。","format":"int32","type":"integer"},"nodes":{"items":{"$ref":"#/definitions/MysqlInstanceNodeInfo"},"type":"array"},"port":{"description":"数据库端口号。","type":"string"},"private_dns_names":{"description":"实例内网域名列表。实例创建成功后,需要手动申请内网域名,否则查询内网域名为空。","items":{"type":"string"},"type":"array"},"private_write_ips":{"description":"实例的写内网IP。","items":{"type":"string"},"type":"array"},"project_id":{"description":"租户在某一region下的project ID。","type":"string"},"proxies":{"items":{"$ref":"#/definitions/MysqlProxyInfo"},"type":"array"},"public_ips":{"description":"实例的公网IP。","type":"string"},"security_group_id":{"description":"安全组ID。","type":"string"},"status":{"description":"实例状态。\n\n取值:\n- 值为“BUILD”,表示实例正在创建。\n- 值为“ACTIVE”,表示实例正常。\n- 值为“FAILED”,表示实例创建失败。\n- 值为“FROZEN”,表示实例冻结。\n- 值为“MODIFYING”,表示实例正在扩容。\n- 值为“REBOOTING”,表示实例正在重启。\n- 值为“RESTORING”,表示实例正在恢复。\n- 值为“SWITCHOVER”,表示实例正在主备切换。\n- 值为“MIGRATING”,表示实例正在迁移。\n- 值为“BACKING UP”,表示实例正在进行备份。\n- 值为“MODIFYING DATABASE PORT”,表示实例正在修改数据库端口。\n- 值为“STORAGE FULL”,表示实例磁盘空间满。","type":"string"},"subnet_id":{"description":"子网的网络ID信息。","type":"string"},"tags":{"description":"实例标签。","items":{"$ref":"#/definitions/MysqlTags"},"type":"array"},"time_zone":{"description":"时区。","type":"string"},"type":{"description":"实例类型,取值为“Cluster”。","type":"string"},"updated":{"description":"更新时间,格式与\"created\"字段对应格式完全相同。说明:创建时返回值为空,数据库实例创建成功后该值不为空。","type":"string"},"vpc_id":{"description":"虚拟私有云ID。","type":"string"}},"required":["id","name","project_id"]},"MysqlInstanceNodeInfo":{"description":"节点信息。","properties":{"az_code":{"description":"可用区。","type":"string"},"created":{"description":"创建时间,格式为\"yyyy-mm-ddThh:mm:ssZ\"。\n\n其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。说明:创建时返回值为空,数据库实例创建成功后该值不为空。","type":"string"},"flavor_id":{"description":"规格ID。","type":"string"},"flavor_ref":{"description":"规格码。","type":"string"},"id":{"description":"实例ID。","type":"string"},"max_connections":{"description":"允许的最大连接数。","type":"string"},"name":{"description":"节点名称。","type":"string"},"need_restart":{"description":"是否需要重启使修改的参数生效。","type":"boolean"},"port":{"description":"数据库端口号。","format":"int32","type":"integer"},"priority":{"description":"主备倒换优先级。","format":"int32","type":"integer"},"private_read_ips":{"description":"节点的读内网地址。","items":{"type":"string"},"type":"array"},"ram":{"description":"内存大小,单位为GB。","type":"string"},"region_code":{"description":"实例所在的区域。","type":"string"},"status":{"description":"节点状态。","type":"string"},"type":{"description":"节点类型,master或slave。","type":"string"},"updated":{"description":"更新时间,格式与\"created\"字段对应格式完全相同。说明:创建时返回值为空,数据库实例创建成功后该值不为空。","type":"string"},"vcpus":{"description":"CPU核数。","type":"string"},"volume":{"$ref":"#/definitions/MysqlInstanceNodeVolumeInfo"}},"required":["id","name"]},"MysqlInstanceNodeVolumeInfo":{"description":"存储盘信息。","properties":{"size":{"description":"包周期购买的存储空间大小,单位GB。","format":"int64","type":"integer"},"type":{"description":"磁盘类型。","type":"string"},"used":{"description":"已使用磁盘大小,单位GB。","type":"string"}},"required":["type","used","size"]},"MysqlProxyInfo":{"description":"Proxy信息。","properties":{"address":{"description":"Proxy读写分离地址。","type":"string"},"name":{"description":"Proxy实例名称。","type":"string"},"pool_id":{"description":"Proxy实例ID。","type":"string"}}},"MysqlTags":{"description":"标签列表,根据标签键值对创建实例。\n- {key}表示标签键,不可以为空或重复。\n- {value}表示标签值,可以为空。\n\n如果创建实例时同时使用多个标签键值对,中间使用逗号分隔开,最多包含10组。","properties":{"key":{"description":"标签键。最大长度36个unicode字符。key不能为空或者空字符串,不能为空格。\n\n字符集:A-Z,a-z ,0-9,‘-’,‘_’,UNICODE字符(\\u4E00-\\u9FFF)。","type":"string"},"value":{"description":"标签值。最大长度43个unicode字符。可以为空字符串。\n\n字符集:A-Z,a-z ,0-9,‘.’,‘-’,‘_’,UNICODE字符(\\u4E00-\\u9FFF)。","type":"string"}},"required":["key","value"]}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"12b453ed08ce4f00a9430823dbd531ed","info_version":"v3","method":"get","name":"ShowGaussMySqlInstanceInfo","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}":{"get":{"description":"查询实例详情信息。","operationId":"ShowGaussMySqlInstanceInfo","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-gaussdbformysql/gaussdbformysql_10_0004.html)。\n","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"实例ID。","in":"path","name":"instance_id","required":true,"type":"string","x-example":"2f7be53812044494a44c08398b188ca3in07"}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"instance":{"alias":"","az_mode":"single","backup_strategy":{"keep_days":7,"start_time":"19:00-20:00"},"backup_used_space":0.24,"charge_info":{"charge_mode":"postPaid","order_id":""},"configuration_id":"53570e0de54e40c5a15f331aa5sd2176pr07","created":"2022-07-14T16:26:58+0800","datastore":{"kernel_version":"2.0.29.1","type":"gaussdb-mysql","version":"8.0.22"},"db_user_name":"root","dedicated_resource_id":"","enterprise_project_id":0,"id":"d738399de028480fabb2b8120d4e01a4in07","maintenance_window":"18:00-22:00","master_az_code":"az1","name":"gaussdb-mysql-instance01","node_count":2,"nodes":[{"az_code":"az1xahz","created":"2022-07-14T16:26:58+0800","flavor_id":"3169caaf-6c2f-41d5-aadd-c8fc3d83597e","flavor_ref":"gaussdb.mysql.xlarge.arm.2.ha","id":"799a0f2fa49a4151bf9f7063c1fbba36no07","max_connections":1500,"name":"gauss-d616-lb07_node01","need_restart":false,"port":3306,"priority":1,"private_read_ips":["192.168.0.163"],"ram":4,"region_code":"cn-xianhz-1","status":"ACTIVE","type":"master","updated":"2022-07-18T09:24:18+0800","vcpus":1,"volume":{"type":"POOL","used":0.07}},{"az_code":"az1xahz","created":"2022-07-14T16:26:58+0800","flavor_id":"3169caaf-6c2f-41d5-aadd-c8fc3d83597e","flavor_ref":"gaussdb.mysql.xlarge.arm.2.ha","id":"799a0f2fa49a4151bf9f7063c1fbba35no07","max_connections":1500,"name":"gauss-d616-lb07_node02","need_restart":false,"port":3306,"priority":1,"private_read_ips":["192.168.0.162"],"ram":4,"region_code":"cn-xianhz-1","status":"ACTIVE","type":"slave","updated":"2022-07-18T09:36:18+0800","vcpus":1,"volume":{"type":"POOL","used":0.07}}],"port":3306,"private_dns_names":["436aaafb689c4250a9a5bb33cb271e8cin07.internal.cn-xianhz-1.gaussdbformysql.myhuaweicloud.com"],"private_write_ips":["192.168.0.142"],"project_id":"3cedfc54-b105-4652-a4e0-847b11576628","proxies":[{"address":"192.168.10.76","name":"proxy-name","pool_id":"dab1cfc5150c4d1ca0e8c6596bfc0d8cpo01"}],"public_ips":"10.154.219.187","security_group_id":"fc577a1a-f202-424a-977f-24faec3fdd55","status":"ACTIVE","subnet_id":"c1cfa53c-65d3-431e-8552-326bf310c7ad","tags":[],"time_zone":"UTC+08:00","type":"Cluster","updated":"2022-07-18T14:20:33+0800","vpc_id":"3cedfc54-b105-4652-a4e0-847b11576b58"}}},"schema":{"$ref":"#/definitions/MysqlInstanceInfo"}},"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":"查询指定实例的详细信息。","x-request-examples-url-1":"GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询实例详情信息","tags":"实例管理","uri":null,"version":"2.0"}