{"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"},"ParamGroup":{"properties":{"id":{"description":"参数组ID。","type":"string"},"name":{"description":"参数组名。","type":"string"}},"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"},"StarRocksInstanceInfo":{"properties":{"instances":{"description":"实例信息。","items":{"properties":{"actions":{"description":"实例动作。","items":{"$ref":"#/definitions/QueryAction"},"type":"array"},"az_mode":{"description":"可用区模式。\n\n取值范围:\n\n- single:单可用区\n- multi:多可用区","example":"single","type":"string"},"backup_used_space":{"description":"备份使用空间。","example":null,"type":"string"},"bak_expected_start_time":{"description":"备份预计开始时间。","example":null,"format":"int64","type":"integer"},"bak_keep_day":{"description":"备份保存天数。","example":null,"format":"int32","type":"integer"},"bak_period":{"description":"备份周期。","example":null,"type":"string"},"be_node_volume_code":{"description":"BE节点磁盘类型。","example":"gaussdb.sr.evs.ultrahighio","type":"string"},"be_node_volume_size":{"description":"BE节点磁盘大小。","example":50000000000,"type":"string"},"can_enable_public_access":{"description":"是否可公网访问。","example":false,"type":"boolean"},"cluster_mode":{"description":"部署模式。","example":"Single","type":"string"},"create_at":{"description":"实例创建时间。","example":1710761348531,"format":"int64","type":"integer"},"create_fail_error_code":{"description":"实例创建失败错误码。","example":null,"type":"string"},"current_backup_node_id":{"description":"备份节点ID。","example":null,"type":"string"},"data_store_type":{"description":"数据库引擎。","example":"star-rocks","type":"string"},"data_store_version":{"description":"数据库版本。","example":"3.1.6.0","type":"string"},"data_store_version_id":{"description":"数据库版本ID。","example":"38197973-8895-36ed-b853-52daeefb6d3a","type":"string"},"data_vip":{"description":"StarRocks FE节点类型数据IP(多个IP使用逗号分隔)","type":"string"},"db_port":{"description":"数据库端口号。","example":3306,"type":"string"},"db_user":{"description":"默认用户名。","example":null,"type":"string"},"dedicated_resource_id":{"description":"专属资源池ID,只有数据库实例属于专属资源池才会返回该参数。","example":null,"type":"string"},"delete_at":{"description":"实例删除时间。","format":"int64","type":"integer"},"enterprise_project_id":{"description":"企业项目ID。","example":null,"type":"string"},"fe_node_volume_code":{"description":"FE节点磁盘类型。","example":"gaussdb.sr.evs.ultrahighio","type":"string"},"fe_node_volume_size":{"description":"FE节点磁盘大小。","example":50000000000,"type":"string"},"frozen_time":{"description":"冻结时间。","example":null,"format":"int64","type":"integer"},"groups":{"description":"实例分组。","items":{"properties":{"group_node_type":{"description":"实例分组节点类型。","example":"fe","type":"string"},"group_type_name":{"description":"实例分组类型名。","example":"starrocks","type":"string"},"id":{"description":"分组ID。","example":"4087c4d72e63464f934cde44dc9d0947gr17","type":"string"},"name":{"description":"分组名。","example":"htap-fjl3_fe_shard01","type":"string"},"nodes":{"description":"实例节点。","items":{"properties":{"actions":{"description":"节点动作。","items":{"$ref":"#/definitions/QueryAction"},"type":"array"},"az_code":{"description":"可用区代码。","example":"cn-southwest-244b","type":"string"},"az_description":{"description":"可用区描述。","example":"az2","type":"string"},"az_type":{"description":"可用区类型。","example":"Center","type":"string"},"cpu":{"description":"实例节点cpu数量。","example":4,"type":"string"},"create_at":{"description":"节点创建时间。","example":1710761348531,"format":"int64","type":"integer"},"datastore":{"description":"数据库信息。","properties":{"id":{"description":"数据库ID。","example":"38197973-8895-36ed-b853-52daeefb6d3a","type":"string"},"type":{"description":"数据库类型。","example":"star-rocks","type":"string"},"version":{"description":"数据库版本。","example":"3.1.6.0","type":"string"}}},"db_port":{"description":"数据库端口号。默认3306。","example":3306,"format":"int32","type":"integer"},"flavor_id":{"description":"节点规格ID。","example":"afef3bfd-ac7c-32e1-ba44-c388acbb196a","type":"string"},"flavor_ref":{"description":"节点规格码。","example":"gaussdb.sr-fe.xlarge.x86.4","type":"string"},"frozen_flag":{"description":"冻结标志。","example":0,"format":"int32","type":"integer"},"iass_flavor_ref":{"description":"IASS规格码。","example":"c6.xlarge.4","type":"string"},"id":{"description":"实例节点ID。","example":"0beba74a630344d397c02acd8cafbca9no17","type":"string"},"max_connections":{"description":"公网最大连接数。","example":0,"type":"string"},"mem":{"description":"实例节点内存大小(GB)。","example":16,"type":"string"},"name":{"description":"实例节点名。","example":"htap-fjl3_fe_shard01_node01","type":"string"},"need_restart":{"description":"参数更新是否需要重启。","example":false,"type":"boolean"},"order_id":{"description":"订单号。","example":null,"type":"string"},"param_group":{"additionalProperties":{"$ref":"#/definitions/ParamGroup"},"description":"参数组信息。","type":"object"},"pay_model":{"description":"支付模式。","example":0,"type":"string"},"period":{"description":"实例节点周期。","example":null,"type":"string"},"priority":{"description":"节点优先级。","example":1,"format":"int32","type":"integer"},"region_code":{"description":"实例所在区域。","example":"cn-southwest-244","type":"string"},"sg_id":{"description":"安全组。","example":"","type":"string"},"status":{"description":"节点状态。\n\n取值:\n\n值为“creating”,表示节点正在创建。\n\n值为“normal”,表示节点正常。\n\n值为“abnormal”,表示节点异常。\n\n值为“createfail”,表示节点创建失败。","example":"normal","type":"string"},"subnet_id":{"description":"子网ID。","example":"8926baca-467a-4556-8603-b4077805ff9d","type":"string"},"traffic_ip":{"description":"数据IP。","example":"192.168.0.248","type":"string"},"traffic_ipv6":{"description":"数据IPV6。","example":"","type":"string"},"type":{"description":"实例节点类型。","example":"fe-leader","type":"string"},"update_at":{"description":"节点更新时间。","example":1710940990014,"format":"int64","type":"integer"},"volume":{"description":"实例节点存储信息。","properties":{"size":{"description":"实例节点存储大小。","example":50000000000,"type":"string"},"type":{"description":"实例节点存储类型。","example":"SSD","type":"string"}}},"vpc_id":{"description":"虚拟私有云ID。","example":"f7876b94-3696-419b-a609-161de4b42d59","type":"string"}}},"type":"array"}}},"type":"array"},"id":{"description":"实例ID,严格匹配UUID规则。","example":"223721cd080e4c9997cbb6238f18d513in17","type":"string"},"is_frozen":{"description":"是否冻结。","example":0,"format":"int32","type":"integer"},"name":{"description":"创建的实例名称。","example":"htap-fjl3","type":"string"},"new_version_available":{"description":"是否有数据库新版本。","example":false,"type":"boolean"},"ops_window":{"description":"实例操作时间窗。","properties":{"end_time":{"description":"时间窗结束时间。","example":"22:00","type":"string"},"period":{"description":"时间窗周期。","type":"string"},"start_time":{"description":"时间窗开始时间。","example":"18:00","type":"string"}}},"param_group":{"description":"参数组。","example":null,"type":"string"},"pay_model":{"description":"支付模式。","example":null,"type":"string"},"port_info":{"description":"端口信息。","properties":{"mysql_port":{"description":"MySQL端口号。默认3306。","example":3306,"format":"int32","type":"integer"}}},"project_id":{"description":"租户在某一Region下的project ID。","example":"23a50154cf494ec9ad6883979a12db0a","type":"string"},"public_ip":{"description":"公网访问IP。","example":"","type":"string"},"ssl_option":{"description":"SSL开关。","example":false,"type":"boolean"},"status":{"description":"实例状态。","example":"normal","type":"string"},"support_data_replication":{"description":"是否支持副本。","example":true,"type":"boolean"},"tags_info":{"description":"实例标签。","properties":{"sys_tags":{"description":"系统标签。","items":{"properties":{"key":{"description":"标签键。最大长度36个unicode字符。key不能为空或者空字符串,不能为空格。\n\n字符集:A-Z,a-z ,0-9,‘-’,‘_’,UNICODE字符(\\u4E00-\\u9FFF)。","example":"_sys_enterprise_project_id","type":"string"},"value":{"description":"标签值。最大长度43个unicode字符。可以为空字符串。\n\n字符集:A-Z,a-z ,0-9,‘.’,‘-’,‘_’,UNICODE字符(\\u4E00-\\u9FFF)。","example":0,"type":"string"}}},"type":"array"},"tags":{"description":"用户标签。","items":{"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"}},"type":"string"},"type":"array"}}},"time_zone":{"description":"时区。","example":"UTC+08:00","type":"string"},"update_at":{"description":"实例更新时间。","example":1710940814084,"format":"int64","type":"integer"}}},"type":"array"}},"type":"object"}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"20cec84e73fb41ecb3f9eff405b123e1","info_version":"v3","method":"get","name":"ListStarrocksInstanceInfo","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/starrocks/{starrocks_instance_id}":{"get":{"description":"查询StarRocks实例。","operationId":"ListStarrocksInstanceInfo","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":"StarRocks实例ID,严格匹配UUID规则。","in":"path","name":"starrocks_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"}],"produces":["application/json"],"responses":{"200":{"description":"Success.","examples":{"application/json":{"instances":[{"actions":[],"az_mode":"single","backup_used_space":null,"bak_expected_start_time":null,"bak_keep_day":null,"bak_period":null,"be_node_volume_code":"gaussdb.sr.evs.ultrahighio","be_node_volume_size":"50000000000","can_enable_public_access":false,"cluster_mode":"Cluster","create_at":1711421838049,"create_fail_error_code":null,"current_backup_node_id":null,"data_store_type":"star-rocks","data_store_version":"3.1.6.0","data_store_version_id":"38197973-8895-36ed-b853-52daeefb6d3a","data_vip":"10.0.0.156,10.0.0.179,10.0.0.199,10.0.0.152","db_port":"3306","db_user":null,"dedicated_resource_id":null,"delete_at":null,"enterprise_project_id":"0","fe_node_volume_code":"gaussdb.sr.evs.ultrahighio","fe_node_volume_size":"50000000000","frozen_time":null,"groups":[{"group_node_type":"fe","group_type_name":"starrocks","id":"73a7c579381041e1867e9facdf11ca7egr17","name":"htap-7ef5_fe_shard01","nodes":[{"actions":[],"az_code":"cn-southwest-244d","az_description":"az4","az_type":"Center","cpu":"4","create_at":1711421838049,"datastore":{"id":"38197973-8895-36ed-b853-52daeefb6d3a","type":"star-rocks","version":"3.1.6.0"},"db_port":3306,"flavor_id":"afef3bfd-ac7c-32e1-ba44-c388acbb196a","flavor_ref":"gaussdb.sr-fe.xlarge.x86.4","frozen_flag":0,"iass_flavor_ref":"c6.xlarge.4","id":"21f14a5974a540f2afb541eaf6e90107no17","max_connections":"0","mem":"16","name":"htap-7ef5_fe_shard01_node04","need_restart":false,"order_id":null,"param_group":null,"pay_model":"0","period":"null","priority":1,"region_code":"cn-southwest-244","sg_id":"967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1","status":"normal","subnet_id":"2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b","traffic_ip":"10.0.0.156","traffic_ipv6":"","type":"fe-follower","update_at":1711422776266,"volume":{"iops":null,"size":"50000000000","type":"SSD","used":null},"vpc_id":"d5a1a29b-1476-490f-9682-c1a59593e7b0"},{"actions":[],"az_code":"cn-southwest-244d","az_description":"az4","az_type":"Center","cpu":"4","create_at":1711421838049,"datastore":{"id":"38197973-8895-36ed-b853-52daeefb6d3a","type":"star-rocks","version":"3.1.6.0"},"db_port":3306,"flavor_id":"afef3bfd-ac7c-32e1-ba44-c388acbb196a","flavor_ref":"gaussdb.sr-fe.xlarge.x86.4","frozen_flag":0,"iass_flavor_ref":"c6.xlarge.4","id":"60c7b1dda3c14366b9e6314de0be905bno17","max_connections":"0","mem":"16","name":"htap-7ef5_fe_shard01_node03","need_restart":false,"order_id":null,"param_group":null,"pay_model":"0","period":"null","priority":1,"region_code":"cn-southwest-244","sg_id":"967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1","status":"normal","subnet_id":"2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b","traffic_ip":"10.0.0.179","traffic_ipv6":"","traffic_vip":"","traffic_vipv6":"","type":"fe-follower","update_at":1711421838049,"volume":{"iops":null,"size":"50000000000","type":"SSD","used":null},"vpc_id":"d5a1a29b-1476-490f-9682-c1a59593e7b0"},{"actions":[],"az_code":"cn-southwest-244d","az_description":"az4","az_type":"Center","cpu":"4","create_at":1711421838049,"datastore":{"id":"38197973-8895-36ed-b853-52daeefb6d3a","type":"star-rocks","version":"3.1.6.0"},"db_port":3306,"flavor_id":"afef3bfd-ac7c-32e1-ba44-c388acbb196a","flavor_ref":"gaussdb.sr-fe.xlarge.x86.4","frozen_flag":0,"iass_flavor_ref":"c6.xlarge.4","id":"c786d7b2593645ffac4544a3107943b4no17","max_connections":"0","mem":"16","name":"htap-7ef5_fe_shard01_node02","need_restart":false,"order_id":null,"param_group":null,"pay_model":"0","period":"null","priority":1,"region_code":"cn-southwest-244","sg_id":"967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1","status":"normal","subnet_id":"2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b","traffic_ip":"10.0.0.199","traffic_ipv6":"","traffic_vip":"","traffic_vipv6":"","type":"fe-follower","update_at":1711421838049,"volume":{"iops":null,"size":"50000000000","type":"SSD","used":null},"vpc_id":"d5a1a29b-1476-490f-9682-c1a59593e7b0"},{"actions":[],"az_code":"cn-southwest-244d","az_description":"az4","az_type":"Center","cpu":"4","create_at":1711421838049,"datastore":{"id":"38197973-8895-36ed-b853-52daeefb6d3a","type":"star-rocks","version":"3.1.6.0"},"db_port":3306,"flavor_id":"afef3bfd-ac7c-32e1-ba44-c388acbb196a","flavor_ref":"gaussdb.sr-fe.xlarge.x86.4","frozen_flag":0,"iass_flavor_ref":"c6.xlarge.4","id":"ffb9f510f9934b0384789a2a4652d3e0no17","max_connections":"0","mem":"16","name":"htap-7ef5_fe_shard01_node01","need_restart":false,"order_id":null,"param_group":null,"pay_model":"0","period":"null","priority":1,"region_code":"cn-southwest-244","sg_id":"967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1","status":"abnormal","subnet_id":"2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b","traffic_ip":"10.0.0.152","traffic_ipv6":"","type":"fe-leader","update_at":1711422932204,"volume":{"iops":null,"size":"50000000000","type":"SSD","used":null},"vpc_id":"d5a1a29b-1476-490f-9682-c1a59593e7b0"}]},{"group_node_type":"be","group_type_name":"starrocks","id":"bf50855824c9485f9368845dfb4457dcgr17","name":"htap-7ef5_be_shard01","nodes":[{"actions":[],"az_code":"cn-southwest-244d","az_description":"az4","az_type":"Center","cpu":"4","create_at":1711421838049,"datastore":{"id":"38197973-8895-36ed-b853-52daeefb6d3a","type":"star-rocks","version":"3.1.6.0"},"db_port":3306,"flavor_id":"de565db8-0a96-37ea-9388-61167624712c","flavor_ref":"gaussdb.sr-be.xlarge.x86.4","frozen_flag":0,"iass_flavor_ref":"c6.xlarge.4","id":"98e7f36d39fb4d9ca7c92c8c1fa4991ano17","max_connections":"0","mem":"16","name":"htap-7ef5_be_shard01_node02","need_restart":false,"order_id":null,"param_group":null,"pay_model":"0","period":"null","priority":1,"region_code":"cn-southwest-244","sg_id":"967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1","status":"normal","subnet_id":"2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b","traffic_ip":"10.0.0.202","traffic_ipv6":"","traffic_vip":"","traffic_vipv6":"","type":"be","update_at":1711422835209,"volume":{"iops":null,"size":"50000000000","type":"SSD","used":null},"vpc_id":"d5a1a29b-1476-490f-9682-c1a59593e7b0"},{"actions":[],"az_code":"cn-southwest-244d","az_description":"az4","az_type":"Center","cpu":"4","create_at":1711421838049,"datastore":{"id":"38197973-8895-36ed-b853-52daeefb6d3a","type":"star-rocks","version":"3.1.6.0"},"db_port":3306,"flavor_id":"de565db8-0a96-37ea-9388-61167624712c","flavor_ref":"gaussdb.sr-be.xlarge.x86.4","frozen_flag":0,"iass_flavor_ref":"c6.xlarge.4","id":"be254b607c5e4f3d97c4d7886043e5bcno17","max_connections":"0","mem":"16","name":"htap-7ef5_be_shard01_node03","need_restart":false,"order_id":null,"param_group":null,"pay_model":"0","period":"null","priority":1,"region_code":"cn-southwest-244","sg_id":"967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1","status":"normal","subnet_id":"2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b","traffic_ip":"10.0.0.115","traffic_ipv6":"","traffic_vip":"","traffic_vipv6":"","type":"be","update_at":1711421838049,"volume":{"iops":null,"size":"50000000000","type":"SSD","used":null},"vpc_id":"d5a1a29b-1476-490f-9682-c1a59593e7b0"},{"actions":[],"az_code":"cn-southwest-244d","az_description":"az4","az_type":"Center","cpu":"4","create_at":1711421838049,"datastore":{"id":"38197973-8895-36ed-b853-52daeefb6d3a","type":"star-rocks","version":"3.1.6.0"},"db_port":3306,"flavor_id":"de565db8-0a96-37ea-9388-61167624712c","flavor_ref":"gaussdb.sr-be.xlarge.x86.4","frozen_flag":0,"iass_flavor_ref":"c6.xlarge.4","id":"c8899a3a68184de6a7fd140028392b27no17","max_connections":"0","mem":"16","name":"htap-7ef5_be_shard01_node01","need_restart":false,"order_id":null,"param_group":null,"pay_model":"0","period":"null","priority":1,"region_code":"cn-southwest-244","sg_id":"967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1","status":"normal","subnet_id":"2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b","traffic_ip":"10.0.0.17","traffic_ipv6":"","traffic_vip":"","traffic_vipv6":"","type":"be","update_at":1711421838049,"volume":{"iops":null,"size":"50000000000","type":"SSD","used":null},"vpc_id":"d5a1a29b-1476-490f-9682-c1a59593e7b0"}]}],"id":"b6280c323ce449f2ad02af74e21f3dc5in17","is_frozen":0,"name":"htap-7ef5","new_version_available":false,"ops_window":{"end_time":"22:00","period":null,"start_time":"18:00"},"param_group":null,"pay_model":"0","port_info":{"mysql_port":3306},"project_id":"23a50154cf494ec9ad6883979a12db0a","public_ip":"","ssl_option":false,"status":"abnormal","support_data_replication":true,"tags_info":{"sys_tags":[{"key":"_sys_enterprise_project_id","value":"0"}],"tags":[]},"time_zone":"UTC+08:00","update_at":1711423400451}]}},"schema":{"$ref":"#/definitions/StarRocksInstanceInfo"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/Erro"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/Erro"}}},"summary":"查询StarRocks实例","tags":["HTAP-标准版"],"x-is-registered":"Y","x-request-examples-description-1":"查询某个StarRocks实例ID。","x-request-examples-url-1":"GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/fb632d1d531a4107804f0f082581810fin07/starrocks/b6280c323ce449f2ad02af74e21f3dc5in17","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询StarRocks实例","tags":"HTAP-标准版","uri":null,"version":"2.0"}