{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"Erro":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200082","type":"string"},"error_msg":{"description":"错误消息。","example":"The available IP addresses in the selected subnet are insufficient.","type":"string"}},"type":"object"},"HtapInstanceList":{"properties":{"instances":{"description":"HTAP实例信息。","items":{"properties":{"alter_order_id":{"description":"包周期计费备用订单ID。","example":"","type":"string"},"available_zones":{"description":"可用区信息。","items":{"properties":{"az_type":{"description":"可用区类型。","example":"Center","type":"string"},"code":{"description":"可用区码。","example":"cn-southwest-244b","type":"string"},"description":{"description":"可用区描述。","example":"az2","type":"string"}}},"type":"array"},"ch_master_node_id":{"description":"ClickHouse主节点ID。","example":null,"type":"string"},"create_at":{"description":"HTAP实例创建时间。","example":1711094408228,"format":"int64","type":"integer"},"current_actions":{"description":"实例动作。","items":{"$ref":"#/definitions/QueryAction"},"type":"array"},"data_vip":{"description":"读写内网地址。","example":"192.168.0.207","type":"string"},"data_vip_v6":{"description":"读写内网地址IPV6。","example":null,"type":"string"},"dedicated_resource_id":{"description":"专属资源池ID,只有开通专属资源池后才支持此参数。","example":"","type":"string"},"engine_name":{"description":"HTAP数据库引擎名。","example":"star-rocks","type":"string"},"engine_version":{"description":"HTAP数据库引擎版本。","example":"3.1.6","type":"string"},"enterprise_project_id":{"description":"企业项目ID。如果帐户开通企业项目服务则该参数必选,未开启该参数不可选。","example":0,"type":"string"},"ha_mode":{"description":"HTAP实例部署模式。","example":"Single","type":"string"},"id":{"description":"HTAP实例ID,严格匹配UUID规则。","example":"bfc970d8e9b34a399b4c422aabe11409in17","type":"string"},"instance_state":{"description":"HTAP实例状态信息。","properties":{"create_fail_error_code":{"description":"HTAP实例创建失败错误码。","example":null,"type":"string"},"fail_message":{"description":"HTAP实例创建失败错误信息。","example":null,"type":"string"},"instance_status":{"description":"HTAP实例状态。","example":"normal","type":"string"},"wait_restart_for_params":{"description":"是否需要重启更新参数。","example":false,"type":"boolean"}}},"is_frozen":{"description":"HTAP实例是否冻结。","example":false,"type":"boolean"},"name":{"description":"HTAP实例名。","example":"htap-fjld","type":"string"},"network":{"description":"网络信息。","properties":{"security_group_id":{"description":"安全组ID。","example":"","type":"string"},"sub_net_id":{"description":"子网ID。","example":"8926baca-467a-4556-8603-b4077805ff9d","type":"string"},"vpc_id":{"description":"虚拟私有云ID。","example":"f7876b94-3696-419b-a609-161de4b42d59","type":"string"}}},"node_num":{"description":"节点个数。","example":2,"format":"int32","type":"integer"},"order_id":{"description":"包周期计费订单ID。","example":null,"type":"string"},"pay_model":{"description":"计费模式。当前仅支持按需计费。\n0:按需计费\n1:包周期","example":0,"type":"string"},"port":{"description":"数据库访问端口。","example":3306,"format":"int32","type":"integer"},"project_id":{"description":"租户在某一region下的project ID","example":"23a50154cf494ec9ad6883979a12db0a","type":"string"},"proxy_ips":{"description":"代理IP。","items":{"type":"string"},"type":"array"},"readable_node_infos":{"description":"可读节点信息","example":["192.168.0.207"],"items":{"$ref":"#/definitions/ReadableNodeInfos"},"type":"array"},"server_type":{"description":"服务器类型。","example":"KVM","type":"string"},"volume_type":{"description":"存储类型。","example":"SSD","type":"string"}}},"type":"array"},"max_htap_instance_num_of_taurus":{"description":"最大HTAP实例个数。","example":10,"format":"int32","type":"integer"},"total":{"description":"HTAP实例个数。","example":4,"format":"int32","type":"integer"}},"type":"object"},"QueryAction":{"properties":{"action":{"description":"实例或节点动作名称。","type":"string"},"created_at":{"description":"实例或节点动作创建时间。","format":"int64","type":"integer"},"id":{"description":"实例或节点动作ID。","type":"string"},"job_id":{"description":"实例或节点动作任务ID。","type":"string"},"object_id":{"description":"实例或节点动作对象ID。","type":"string"},"status":{"description":"实例或节点动作状态。","enum":["OK_TO_RUN","DELETED"],"type":"string"},"type":{"description":"实例或节点动作类型。","type":"string"},"updated_at":{"description":"实例或节点动作更新时间。","format":"int64","type":"integer"}},"type":"object"},"ReadableNodeInfos":{"description":"可读节点信息。","properties":{"data_ip":{"description":"可读节点IP。","type":"string"},"node_id":{"description":"可读节点ID。","type":"string"},"node_name":{"description":"可读节点名称。","type":"string"}},"type":"object"}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"3092e5d0620b4ff68d74d56c1d35b148","info_version":"v3","method":"get","name":"ListHtapInstanceInfo","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/htap":{"get":{"description":"查询HTAP实例列表。","operationId":"ListHtapInstanceInfo","parameters":[{"description":"租户在某一Region下的project ID。\n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。","in":"path","name":"project_id","required":true,"type":"string"},{"description":"TaurusDB实例ID,严格匹配UUID规则。","in":"path","name":"instance_id","required":true,"type":"string"},{"description":"用户Token。\n\n通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。\n\n请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"内容类型。 取值:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"请求语言类型。默认en-us。\n取值范围:\n- en-us\n- zh-cn","in":"header","name":"X-Language","required":false,"type":"string"}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"instances":[{"alter_order_id":"","available_zones":[{"az_type":"Center","code":"cn-southwest-244b","description":"az2"}],"ch_master_node_id":null,"create_at":1711094408228,"current_actions":[],"data_ips":{"node_id":"36d62cd6a77a4e80a335077867e7912bno16","node_ip":"192.168.0.207","node_name":"htap-1244_shard01_node01"},"data_vip":"192.168.0.207","data_vip_v6":null,"dedicated_resource_id":"","engine_name":"star-rocks","engine_version":"3.1.6","enter_prise_project_id":"0","ha_mode":"Single","id":"bfc970d8e9b34a399b4c422aabe11409in17","instance_state":{"create_fail_error_code":null,"fail_message":null,"instance_status":"normal","wait_restart_for_params":false},"is_frozen":false,"name":"htap-fjld","network":{"security_group_id":"","sub_net_id":"8926baca-467a-4556-8603-b4077805ff9d","vpc_id":"f7876b94-3696-419b-a609-161de4b42d59"},"node_num":2,"order_id":null,"pay_model":"0","port":3306,"project_id":"23a50154cf494ec9ad6883979a12db0a","proxy_ips":[],"server_type":"KVM","volume_type":"SSD"},{"alter_order_id":"","available_zones":[{"az_type":"Center","code":"cn-southwest-244b","description":"az2"}],"ch_master_node_id":null,"create_at":1711094228737,"current_actions":[],"data_ips":["192.168.0.201"],"data_vip":"192.168.0.201","data_vip_v6":null,"dedicated_resource_id":"","engine_name":"star-rocks","engine_version":"3.1.6","enter_prise_project_id":"0","ha_mode":"Single","id":"656c539296bd47b49fe29983368b9fb2in17","instance_state":{"create_fail_error_code":null,"fail_message":null,"instance_status":"normal","wait_restart_for_params":false},"is_frozen":false,"name":"HTAP-1711093893","network":{"security_group_id":"","sub_net_id":"8926baca-467a-4556-8603-b4077805ff9d","vpc_id":"f7876b94-3696-419b-a609-161de4b42d59"},"node_num":2,"order_id":null,"pay_model":"0","port":3306,"project_id":"23a50154cf494ec9ad6883979a12db0a","proxy_ips":[],"server_type":"KVM","volume_type":"SSD"},{"alter_order_id":"","available_zones":[{"az_type":"Center","code":"cn-southwest-244b","description":"az2"}],"ch_master_node_id":null,"create_at":1711075260516,"current_actions":[],"data_ips":["192.168.0.183","192.168.0.7","192.168.0.41"],"data_vip":"192.168.0.249","data_vip_v6":null,"dedicated_resource_id":"","engine_name":"star-rocks","engine_version":"3.1.6","enter_prise_project_id":"0","ha_mode":"Cluster","id":"04c48d11f0d24c8d8aee254981a3b94fin17","instance_state":{"create_fail_error_code":null,"fail_message":null,"instance_status":"normal","wait_restart_for_params":false},"is_frozen":false,"name":"htap-fjlc","network":{"security_group_id":"","sub_net_id":"8926baca-467a-4556-8603-b4077805ff9d","vpc_id":"f7876b94-3696-419b-a609-161de4b42d59"},"node_num":6,"order_id":null,"pay_model":"0","port":3306,"project_id":"23a50154cf494ec9ad6883979a12db0a","proxy_ips":[],"server_type":"KVM","volume_type":"SSD"},{"alter_order_id":"","available_zones":[{"az_type":"Center","code":"cn-southwest-244b","description":"az2"}],"ch_master_node_id":null,"create_at":1711021269903,"current_actions":[],"data_ips":["192.168.0.151","192.168.0.209"],"data_vip":"192.168.0.209","data_vip_v6":null,"dedicated_resource_id":"","engine_name":"star-rocks","engine_version":"3.1.6","enter_prise_project_id":"0","ha_mode":"Single","id":"f2d2441a88384023b2e30f0b600a0013in17","instance_state":{"create_fail_error_code":null,"fail_message":null,"instance_status":"normal","wait_restart_for_params":false},"is_frozen":false,"name":"htap-fjlb","network":{"security_group_id":"","sub_net_id":"8926baca-467a-4556-8603-b4077805ff9d","vpc_id":"f7876b94-3696-419b-a609-161de4b42d59"},"node_num":2,"order_id":null,"pay_model":"0","port":3306,"project_id":"23a50154cf494ec9ad6883979a12db0a","proxy_ips":[],"server_type":"KVM","volume_type":"SSD"}],"max_htap_instance_num_of_taurus":10,"total":4}},"schema":{"$ref":"#/definitions/HtapInstanceList"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/Erro"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/Erro"}}},"summary":"查询HTAP实例列表","tags":["HTAP-标准版"],"x-is-registered":"Y","x-request-examples-description-1":"查询TaurusDB下HTAP实例列表","x-request-examples-url-1":"GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/18c3eeb7b788479eb8b93b209946a83bin07/htap","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询HTAP实例列表","tags":"HTAP-标准版","uri":null,"version":"2.0"}