文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（推荐）/ HTAP-标准版/ 查询StarRocks实例

更新时间：2024-09-12 GMT+08:00

在线调试

CLI示例

查看PDF

查询StarRocks实例

功能介绍

查询StarRocks实例。

调用接口前，您需要了解API认证鉴权。
调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

URI

GET /v3/{project_id}/instances/{instance_id}/starrocks/{starrocks_instance_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户在某一Region下的project ID。获取方法请参见获取项目ID。
instance_id	是	String	GaussDB(forMySQL)实例ID，严格匹配UUID规则。
starrocks_instance_id	是	String	StarRocks实例ID，严格匹配UUID规则。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。
Content-Type	是	String	内容类型。取值：application/json。
X-Language	否	String	请求语言类型。默认en-us。取值范围： en-us zh-cn

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
instances	Array of instances objects	实例信息。

表4 instances
参数	参数类型	描述
id	String	实例ID，严格匹配UUID规则。
name	String	创建的实例名称。
project_id	String	租户在某一Region下的project ID。
public_ip	String	公网访问IP。
data_vip	String	StarRocks FE节点类型数据IP（多个IP使用逗号分隔）。
can_enable_public_access	Boolean	是否可公网访问。
current_backup_node_id	String	备份节点ID。
cluster_mode	String	部署模式。
status	String	实例状态。
is_frozen	Integer	是否冻结。
frozen_time	Long	冻结时间。
db_user	String	默认用户名。
bak_period	String	备份周期。
bak_keep_day	Integer	备份保存天数。
bak_expected_start_time	Long	备份预计开始时间。
data_store_version_id	String	数据库版本ID。
data_store_version	String	数据库版本。
data_store_type	String	数据库引擎。
create_at	Long	实例创建时间。
update_at	Long	实例更新时间。
delete_at	Long	实例删除时间。
db_port	String	数据库端口号。
param_group	String	参数组。
actions	Array of QueryAction objects	实例动作。
create_fail_error_code	String	实例创建失败错误码。
groups	Array of groups objects	实例分组。
ops_window	ops_window object	实例操作时间窗。
tags_info	tags_info object	实例标签。
time_zone	String	时区。
backup_used_space	String	备份使用空间。
az_mode	String	可用区模式。取值范围： single：单可用区 multi：多可用区
enterprise_project_id	String	企业项目ID。
port_info	port_info object	端口信息。
fe_node_volume_code	String	FE节点磁盘类型。
be_node_volume_code	String	BE节点磁盘类型。
fe_node_volume_size	String	FE节点磁盘大小。
be_node_volume_size	String	BE节点磁盘大小。
support_data_replication	Boolean	是否支持数据同步。
new_version_available	Boolean	是否有数据库新版本。
ssl_option	Boolean	SSL开关。
dedicated_resource_id	String	专属资源池ID，只有数据库实例属于专属资源池才会返回该参数。
pay_model	String	付费模式。

表5 groups
参数	参数类型	描述
id	String	分组ID。
name	String	分组名。
nodes	Array of nodes objects	实例节点。
group_type_name	String	实例分组类型名。
group_node_type	String	实例分组节点类型。

表6 nodes
参数	参数类型	描述
id	String	实例节点ID。
name	String	实例节点名。
type	String	实例节点类型。
status	String	节点状态。取值： “creating”，表示节点正在创建。 “normal”，表示节点正常。 “abnormal”，表示节点异常。 “createfail”，表示节点创建失败。
period	String	实例节点周期。
volume	volume object	实例节点存储信息。
cpu	String	实例节点CPU数量。
mem	String	实例节点内存大小（GB）。
datastore	datastore object	数据库信息。
actions	Array of QueryAction objects	节点动作。
priority	Integer	节点优先级。
frozen_flag	Integer	冻结标志。
db_port	Integer	数据库端口号，默认3306。
pay_model	String	付费模式。
order_id	String	订单号。
traffic_ip	String	数据IP。
traffic_ipv6	String	数据IPV6。
az_code	String	可用区码。
az_description	String	可用区描述。
az_type	String	可用区类型。
region_code	String	实例所在区域。
create_at	Long	节点创建时间。
update_at	Long	节点更新时间。
flavor_id	String	节点规格ID。
flavor_ref	String	节点规格码。
iaas_flavor_ref	String	IaaS规格码。
max_connections	String	公网最大连接数。
vpc_id	String	虚拟私有云ID。
subnet_id	String	子网ID。
need_restart	Boolean	参数更新是否需要重启。
sg_id	String	安全组。
param_group	Map<String,ParamGroup>	参数组信息。

表7 volume
参数	参数类型	描述
type	String	实例节点存储类型。
size	String	实例节点存储大小。

表8 datastore
参数	参数类型	描述
id	String	数据库ID。
type	String	数据库类型。
version	String	数据库版本。

表9 QueryAction
参数	参数类型	描述
id	String	实例或节点动作ID。
action	String	实例或节点动作名称。
object_id	String	实例或节点动作对象ID。
type	String	实例或节点动作类型。
job_id	String	实例或节点动作任务ID。
status	String	实例或节点动作状态。枚举值： OK_TO_RUN DELETED
created_at	Long	实例或节点动作创建时间。
updated_at	Long	实例或节点动作更新时间。

**表10** ParamGroup
参数	参数类型	描述
id	String	参数组ID。
name	String	参数组名。

**表11** ops_window
参数	参数类型	描述
period	String	时间窗周期。
start_time	String	时间窗开始时间。
end_time	String	时间窗结束时间。

**表12** tags_info
参数	参数类型	描述
tags	Array of tags objects	用户标签。
sys_tags	Array of sys_tags objects	系统标签。

**表13** tags
参数	参数类型	描述
key	String	标签键。最大长度36个UNICODE字符。不能为空或者空字符串，不能为空格。支持的字符集：A-Z，a-z ，0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。
value	String	标签值。最大长度43个UNICODE字符。可以为空字符串。支持的字符集：A-Z，a-z ，0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。

**表14** sys_tags
参数	参数类型	描述
key	String	标签键。最大长度36个UNICODE字符。不能为空或者空字符串，不能为空格。支持的字符集：A-Z，a-z ，0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。
value	String	标签值。最大长度43个UNICODE字符。可以为空字符串。支持的字符集：A-Z，a-z ，0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。

**表15** port_info
参数	参数类型	描述
mysql_port	Integer	GaussDB(for MySQL)端口号。默认3306。

状态码： 400

**表16** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

状态码： 500

**表17** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

请求示例

查询某个StarRocks实例ID。

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/fb632d1d531a4107804f0f082581810fin07/starrocks/b6280c323ce449f2ad02af74e21f3dc5in17

响应示例

状态码： 200

Success.

{
  "instances" : [ {
    "id" : "b6280c323ce449f2ad02af74e21f3dc5in17",
    "name" : "htap-7ef5",
    "project_id" : "23a50154cf494ec9ad6883979a12db0a",
    "public_ip" : "",
    "data_vip" : "10.0.0.156,10.0.0.179,10.0.0.199,10.0.0.152",
    "can_enable_public_access" : false,
    "current_backup_node_id" : null,
    "cluster_mode" : "Cluster",
    "status" : "abnormal",
    "is_frozen" : 0,
    "frozen_time" : null,
    "db_user" : null,
    "bak_period" : null,
    "bak_keep_day" : null,
    "bak_expected_start_time" : null,
    "data_store_version_id" : "38197973-8895-36ed-b853-52daeefb6d3a",
    "data_store_version" : "3.1.6.0",
    "data_store_type" : "star-rocks",
    "create_at" : 1711421838049,
    "update_at" : 1711423400451,
    "delete_at" : null,
    "db_port" : "3306",
    "param_group" : null,
    "actions" : [ ],
    "create_fail_error_code" : null,
    "groups" : [ {
      "id" : "73a7c579381041e1867e9facdf11ca7egr17",
      "name" : "htap-7ef5_fe_shard01",
      "nodes" : [ {
        "id" : "21f14a5974a540f2afb541eaf6e90107no17",
        "name" : "htap-7ef5_fe_shard01_node04",
        "type" : "fe-follower",
        "status" : "normal",
        "period" : "null",
        "volume" : {
          "type" : "SSD",
          "size" : "50000000000",
          "used" : null,
          "iops" : null
        },
        "cpu" : "4",
        "mem" : "16",
        "datastore" : {
          "id" : "38197973-8895-36ed-b853-52daeefb6d3a",
          "type" : "star-rocks",
          "version" : "3.1.6.0"
        },
        "actions" : [ ],
        "priority" : 1,
        "frozen_flag" : 0,
        "db_port" : 3306,
        "pay_model" : "0",
        "order_id" : null,
        "traffic_ip" : "10.0.0.156",
        "traffic_ipv6" : "",
        "az_code" : "az",
        "az_description" : "az1",
        "az_type" : "Center",
        "region_code" : "region1",
        "create_at" : 1711421838049,
        "update_at" : 1711422776266,
        "flavor_id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a",
        "flavor_ref" : "gaussdb.sr-fe.xlarge.x86.4",
        "iaas_flavor_ref" : "c6.xlarge.4",
        "max_connections" : "0",
        "vpc_id" : "d5a1a29b-1476-490f-9682-c1a59593e7b0",
        "subnet_id" : "2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b",
        "need_restart" : false,
        "sg_id" : "967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1",
        "param_group" : null
      }, {
        "id" : "60c7b1dda3c14366b9e6314de0be905bno17",
        "name" : "htap-7ef5_fe_shard01_node03",
        "type" : "fe-follower",
        "status" : "normal",
        "period" : "null",
        "volume" : {
          "type" : "SSD",
          "size" : "50000000000",
          "used" : null,
          "iops" : null
        },
        "cpu" : "4",
        "mem" : "16",
        "datastore" : {
          "id" : "38197973-8895-36ed-b853-52daeefb6d3a",
          "type" : "star-rocks",
          "version" : "3.1.6.0"
        },
        "actions" : [ ],
        "priority" : 1,
        "frozen_flag" : 0,
        "db_port" : 3306,
        "pay_model" : "0",
        "order_id" : null,
        "traffic_ip" : "10.0.0.179",
        "traffic_vip" : "",
        "traffic_ipv6" : "",
        "traffic_vipv6" : "",
        "az_code" : "az",
        "az_description" : "az1",
        "az_type" : "Center",
        "region_code" : "region1",
        "create_at" : 1711421838049,
        "update_at" : 1711421838049,
        "flavor_id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a",
        "flavor_ref" : "gaussdb.sr-fe.xlarge.x86.4",
        "iaas_flavor_ref" : "c6.xlarge.4",
        "max_connections" : "0",
        "vpc_id" : "d5a1a29b-1476-490f-9682-c1a59593e7b0",
        "subnet_id" : "2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b",
        "need_restart" : false,
        "sg_id" : "967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1",
        "param_group" : null
      }, {
        "id" : "c786d7b2593645ffac4544a3107943b4no17",
        "name" : "htap-7ef5_fe_shard01_node02",
        "type" : "fe-follower",
        "status" : "normal",
        "period" : "null",
        "volume" : {
          "type" : "SSD",
          "size" : "50000000000",
          "used" : null,
          "iops" : null
        },
        "cpu" : "4",
        "mem" : "16",
        "datastore" : {
          "id" : "38197973-8895-36ed-b853-52daeefb6d3a",
          "type" : "star-rocks",
          "version" : "3.1.6.0"
        },
        "actions" : [ ],
        "priority" : 1,
        "frozen_flag" : 0,
        "db_port" : 3306,
        "pay_model" : "0",
        "order_id" : null,
        "traffic_ip" : "10.0.0.199",
        "traffic_vip" : "",
        "traffic_ipv6" : "",
        "traffic_vipv6" : "",
        "az_code" : "az",
        "az_description" : "az1",
        "az_type" : "Center",
        "region_code" : "region1",
        "create_at" : 1711421838049,
        "update_at" : 1711421838049,
        "flavor_id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a",
        "flavor_ref" : "gaussdb.sr-fe.xlarge.x86.4",
        "iaas_flavor_ref" : "c6.xlarge.4",
        "max_connections" : "0",
        "vpc_id" : "d5a1a29b-1476-490f-9682-c1a59593e7b0",
        "subnet_id" : "2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b",
        "need_restart" : false,
        "sg_id" : "967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1",
        "param_group" : null
      }, {
        "id" : "ffb9f510f9934b0384789a2a4652d3e0no17",
        "name" : "htap-7ef5_fe_shard01_node01",
        "type" : "fe-leader",
        "status" : "abnormal",
        "period" : "null",
        "volume" : {
          "type" : "SSD",
          "size" : "50000000000",
          "used" : null,
          "iops" : null
        },
        "cpu" : "4",
        "mem" : "16",
        "datastore" : {
          "id" : "38197973-8895-36ed-b853-52daeefb6d3a",
          "type" : "star-rocks",
          "version" : "3.1.6.0"
        },
        "actions" : [ ],
        "priority" : 1,
        "frozen_flag" : 0,
        "db_port" : 3306,
        "pay_model" : "0",
        "order_id" : null,
        "traffic_ip" : "10.0.0.152",
        "traffic_ipv6" : "",
        "az_code" : "az",
        "az_description" : "az1",
        "az_type" : "Center",
        "region_code" : "region1",
        "create_at" : 1711421838049,
        "update_at" : 1711422932204,
        "flavor_id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a",
        "flavor_ref" : "gaussdb.sr-fe.xlarge.x86.4",
        "iaas_flavor_ref" : "c6.xlarge.4",
        "max_connections" : "0",
        "vpc_id" : "d5a1a29b-1476-490f-9682-c1a59593e7b0",
        "subnet_id" : "2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b",
        "need_restart" : false,
        "sg_id" : "967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1",
        "param_group" : null
      } ],
      "group_type_name" : "starrocks",
      "group_node_type" : "fe"
    }, {
      "id" : "bf50855824c9485f9368845dfb4457dcgr17",
      "name" : "htap-7ef5_be_shard01",
      "nodes" : [ {
        "id" : "98e7f36d39fb4d9ca7c92c8c1fa4991ano17",
        "name" : "htap-7ef5_be_shard01_node02",
        "type" : "be",
        "status" : "normal",
        "period" : "null",
        "volume" : {
          "type" : "SSD",
          "size" : "50000000000",
          "used" : null,
          "iops" : null
        },
        "cpu" : "4",
        "mem" : "16",
        "datastore" : {
          "id" : "38197973-8895-36ed-b853-52daeefb6d3a",
          "type" : "star-rocks",
          "version" : "3.1.6.0"
        },
        "actions" : [ ],
        "priority" : 1,
        "frozen_flag" : 0,
        "db_port" : 3306,
        "pay_model" : "0",
        "order_id" : null,
        "traffic_ip" : "10.0.0.202",
        "traffic_vip" : "",
        "traffic_ipv6" : "",
        "traffic_vipv6" : "",
        "az_code" : "az",
        "az_description" : "az1",
        "az_type" : "Center",
        "region_code" : "region1",
        "create_at" : 1711421838049,
        "update_at" : 1711422835209,
        "flavor_id" : "de565db8-0a96-37ea-9388-61167624712c",
        "flavor_ref" : "gaussdb.sr-be.xlarge.x86.4",
        "iaas_flavor_ref" : "c6.xlarge.4",
        "max_connections" : "0",
        "vpc_id" : "d5a1a29b-1476-490f-9682-c1a59593e7b0",
        "subnet_id" : "2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b",
        "need_restart" : false,
        "sg_id" : "967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1",
        "param_group" : null
      }, {
        "id" : "be254b607c5e4f3d97c4d7886043e5bcno17",
        "name" : "htap-7ef5_be_shard01_node03",
        "type" : "be",
        "status" : "normal",
        "period" : "null",
        "volume" : {
          "type" : "SSD",
          "size" : "50000000000",
          "used" : null,
          "iops" : null
        },
        "cpu" : "4",
        "mem" : "16",
        "datastore" : {
          "id" : "38197973-8895-36ed-b853-52daeefb6d3a",
          "type" : "star-rocks",
          "version" : "3.1.6.0"
        },
        "actions" : [ ],
        "priority" : 1,
        "frozen_flag" : 0,
        "db_port" : 3306,
        "pay_model" : "0",
        "order_id" : null,
        "traffic_ip" : "10.0.0.115",
        "traffic_vip" : "",
        "traffic_ipv6" : "",
        "traffic_vipv6" : "",
        "az_code" : "az",
        "az_description" : "az1",
        "az_type" : "Center",
        "region_code" : "region1",
        "create_at" : 1711421838049,
        "update_at" : 1711421838049,
        "flavor_id" : "de565db8-0a96-37ea-9388-61167624712c",
        "flavor_ref" : "gaussdb.sr-be.xlarge.x86.4",
        "iaas_flavor_ref" : "c6.xlarge.4",
        "max_connections" : "0",
        "vpc_id" : "d5a1a29b-1476-490f-9682-c1a59593e7b0",
        "subnet_id" : "2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b",
        "need_restart" : false,
        "sg_id" : "967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1",
        "param_group" : null
      }, {
        "id" : "c8899a3a68184de6a7fd140028392b27no17",
        "name" : "htap-7ef5_be_shard01_node01",
        "type" : "be",
        "status" : "normal",
        "period" : "null",
        "volume" : {
          "type" : "SSD",
          "size" : "50000000000",
          "used" : null,
          "iops" : null
        },
        "cpu" : "4",
        "mem" : "16",
        "datastore" : {
          "id" : "38197973-8895-36ed-b853-52daeefb6d3a",
          "type" : "star-rocks",
          "version" : "3.1.6.0"
        },
        "actions" : [ ],
        "priority" : 1,
        "frozen_flag" : 0,
        "db_port" : 3306,
        "pay_model" : "0",
        "order_id" : null,
        "traffic_ip" : "10.0.0.17",
        "traffic_vip" : "",
        "traffic_ipv6" : "",
        "traffic_vipv6" : "",
        "az_code" : "az",
        "az_description" : "az1",
        "az_type" : "Center",
        "region_code" : "region1",
        "create_at" : 1711421838049,
        "update_at" : 1711421838049,
        "flavor_id" : "de565db8-0a96-37ea-9388-61167624712c",
        "flavor_ref" : "gaussdb.sr-be.xlarge.x86.4",
        "iaas_flavor_ref" : "c6.xlarge.4",
        "max_connections" : "0",
        "vpc_id" : "d5a1a29b-1476-490f-9682-c1a59593e7b0",
        "subnet_id" : "2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b",
        "need_restart" : false,
        "sg_id" : "967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1",
        "param_group" : null
      } ],
      "group_type_name" : "starrocks",
      "group_node_type" : "be"
    } ],
    "ops_window" : {
      "period" : null,
      "start_time" : "18:00",
      "end_time" : "22:00"
    },
    "tags_info" : {
      "tags" : [ ],
      "sys_tags" : [ {
        "key" : "_sys_enterprise_project_id",
        "value" : "0"
      } ]
    },
    "time_zone" : "UTC+08:00",
    "backup_used_space" : null,
    "az_mode" : "single",
    "enterprise_project_id" : "0",
    "port_info" : {
      "mysql_port" : 3306
    },
    "fe_node_volume_code" : "gaussdb.sr.evs.ultrahighio",
    "be_node_volume_code" : "gaussdb.sr.evs.ultrahighio",
    "fe_node_volume_size" : "50000000000",
    "be_node_volume_size" : "50000000000",
    "support_data_replication" : true,
    "new_version_available" : false,
    "ssl_option" : false,
    "dedicated_resource_id" : null,
    "pay_model" : "0"
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版

上一篇：创建StarRocks实例

下一篇：删除StarRocks实例

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消