Querying a StarRocks Instance

Function

This API is used to query a StarRocks instance. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A
starrocks_instance_id	Yes	String	Definition StarRocks instance ID, which is compliant with the UUID format. Constraints N/A Range The value contains 36 characters with a suffix of in17. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. Constraints N/A Range application/json Default Value application/json
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 3** Response body parameter
Parameter	Type	Description
instances	Array of instances objects	Definition StarRocks instance information.

**Table 4** instances
Parameter	Type	Description
id	String	Definition StarRocks instance ID, which is compliant with the UUID format. Range The value contains 36 characters with a suffix of in17. Only letters and digits are allowed.
name	String	Definition StarRocks instance name. Range N/A
project_id	String	Definition Project ID of a tenant in a region. Range N/A
public_ip	String	Definition Public IP address. Range N/A
data_vip	String	Definition Data IP address of the frontend node. Use commas (,) to separate multiple IP addresses. Range N/A
can_enable_public_access	Boolean	Definition Whether the instance can be accessed from a public network. Range true: The instance can be accessed from a public network. false: The instance cannot be accessed from a public network.
current_backup_node_id	String	Definition ID of the backup node. Range N/A
cluster_mode	String	Definition Deployment mode. Range N/A
status	String	Definition Instance status. Range N/A
is_frozen	Integer	Definition Whether the instance is frozen. Range N/A
frozen_time	Long	Definition Frozen time. Range N/A
db_user	String	Definition Default username. Range N/A
bak_period	String	Definition Backup cycle. Range N/A
bak_keep_day	Integer	Definition Backup retention days. Range N/A
bak_expected_start_time	Long	Definition Estimated backup start time. Range N/A
data_store_version_id	String	Definition DB version ID. Range N/A
data_store_version	String	Definition DB version. Range N/A
data_store_type	String	Definition DB engine. Range N/A
create_at	Long	Definition Time when an instance was created. Range N/A
update_at	Long	Definition Time when an instance was updated. Range N/A
delete_at	Long	Definition Time when an instance was deleted. Range N/A
db_port	String	Definition Database port. Range N/A
param_group	String	Definition Parameter template. Range N/A
actions	Array of QueryAction objects	Definition Instance actions.
create_fail_error_code	String	Definition Error code for an instance creation failure. Range N/A
groups	Array of groups objects	Definition Instance groups.
ops_window	ops_window object	Definition Instance operation time window. Range N/A
tags_info	tags_info object	Definition Instance tags.
time_zone	String	Definition Time zone. Range N/A
backup_used_space	String	Definition Used backup space. Range N/A
az_mode	String	Definition AZ type. Range single: single AZ multi: multiple AZs
enterprise_project_id	String	Definition Enterprise project ID. Range N/A
port_info	port_info object	Definition Port information.
fe_node_volume_code	String	Definition Storage type of the frontend node. Range N/A
be_node_volume_code	String	Definition Storage type of the backend node. Range N/A
fe_node_volume_size	String	Definition Storage space of the frontend node. Range N/A
be_node_volume_size	String	Definition Storage space of the backend node. Range N/A
support_data_replication	Boolean	Definition Whether data replication is supported. Range true: Data replication is supported. false: Data replication is not supported.
new_version_available	Boolean	Definition Whether there is a new DB version available. Range N/A
ssl_option	Boolean	Definition Whether to enable SSL. Range N/A
dedicated_resource_id	String	Definition Dedicated resource pool ID. This parameter is only returned when the instance belongs to a dedicated resource pool. Range N/A
pay_model	String	Definition Payment method. Range N/A

**Table 5** groups
Parameter	Type	Description
id	String	Definition Group ID. Range N/A
name	String	Definition Group name. Range N/A
nodes	Array of nodes objects	Definition Instance node information. Range N/A
group_type_name	String	Definition Instance group type name. Range N/A
group_node_type	String	Definition Type of the node in the instance group. Range N/A

**Table 6** nodes
Parameter	Type	Description
id	String	Definition Instance node ID. Range N/A
name	String	Definition Instance node name. Range N/A
type	String	Definition Instance node type. Range N/A
status	String	Definition Node status. Range creating: A node is being created. normal: A node is available. abnormal: A node is abnormal. createfail: A node failed to be created.
period	String	Definition Whether the instance node is billed on a yearly/monthly basis. 1: The instance node is billed on a yearly/monthly basis. Range N/A
volume	volume object	Definition Instance node storage information. Range N/A
cpu	String	Definition vCPUs of the instance node. Range N/A
mem	String	Definition Memory size (GB) of the instance node. Range N/A
datastore	datastore object	Definition Database information. Range N/A
actions	Array of QueryAction objects	Definition Node actions. Range N/A
priority	Integer	Definition Node priority. Range N/A
frozen_flag	Integer	Definition Frozen flag. Range N/A
db_port	Integer	Definition Database port. The default value is 3306. Range N/A
pay_model	String	Definition Payment method. Range N/A
order_id	String	Definition Order ID. Range N/A
traffic_ip	String	Definition Data IP address. Range N/A
traffic_ipv6	String	Definition Data IPv6 address. Range N/A
az_code	String	Definition AZ code. Range N/A
az_description	String	Definition AZ description. Range N/A
az_type	String	Definition AZ type. Range N/A
region_code	String	Definition Region where the instance is deployed. Range N/A
create_at	Long	Definition Time when a node was created. Range N/A
update_at	Long	Definition Time when a node was updated. Range N/A
flavor_id	String	Definition Node specification ID. Range N/A
flavor_ref	String	Definition Node specification code. Range N/A
iass_flavor_ref	String	Definition IaaS specification code. Range N/A
max_connections	String	Definition Maximum number of public network connections. Range N/A
vpc_id	String	Definition VPC ID. Range N/A
subnet_id	String	Definition Subnet ID. Range N/A
need_restart	Boolean	Definition Whether a reboot is required for parameter updates. Range true: A reboot is required. false: A reboot is not required.
sg_id	String	Definition Security group. Range N/A
param_group	Map<String,ParamGroup>	Definition Parameter template information. Range N/A

**Table 7** volume
Parameter	Type	Description
type	String	Definition Storage type of the instance node. Range N/A
size	String	Definition Storage space of the instance node. Range N/A

**Table 8** datastore
Parameter	Type	Description
id	String	Definition Database ID. Range N/A
type	String	Definition Database type. Range N/A
version	String	Definition Database version. Range N/A

**Table 9** QueryAction
Parameter	Type	Description
id	String	Definition Instance or node action ID. Range N/A
action	String	Definition Instance or node action name. Range N/A
object_id	String	Definition Object ID of the instance or node action. Range N/A
type	String	Definition Instance or node action type. Range N/A
job_id	String	Definition Task ID of the instance or node action. Range N/A
status	String	Definition Instance or node action status. Range N/A
created_at	Long	Definition Time when the instance or node action was created. Range N/A
updated_at	Long	Definition Time when the instance or node action was updated. Range N/A

**Table 10** ParamGroup
Parameter	Type	Description
id	String	Definition Parameter template ID. Range N/A
name	String	Definition Parameter template name. Range N/A

**Table 11** ops_window
Parameter	Type	Description
period	String	Definition Time window period. Range N/A
start_time	String	Definition Start time of the time window. Range N/A
end_time	String	Definition End time of the time window. Range N/A

**Table 12** tags_info
Parameter	Type	Description
tags	Array of tags objects	Definition User tags.
sys_tags	Array of sys_tags objects	Definition System tags.

**Table 13** tags
Parameter	Type	Description
key	String	Definition Tag key. Range The value can contain 1 to 128 characters. It cannot be an empty string, a space, or left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed.
value	String	Definition Tag value. Range The value can contain 0 to 255 Unicode characters. It can be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.

**Table 14** sys_tags
Parameter	Type	Description
key	String	Definition Tag key. The value can contain a maximum of 36 Unicode characters. It cannot be an empty string, a space, or left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed. Range N/A
value	String	Definition Tag value. The value contains a maximum of 43 Unicode characters. It can be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed. Range N/A

**Table 15** port_info
Parameter	Type	Description
mysql_port	Integer	Definition Port number. The default value is 3306. Range N/A

Status code: 400

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 17** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying the ID of a StarRocks instance

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

Example Response

Status code: 200

Success.

{
  "instances" : [ {
    "id" : "914481def3574d5189baee926a26512din17",
    "name" : "htap-5d98",
    "project_id" : "23a50154cf494ec9ad6883979a12db0a",
    "public_ip" : "",
    "data_vip" : "192.168.8.4",
    "can_enable_public_access" : false,
    "current_backup_node_id" : null,
    "cluster_mode" : "Single",
    "status" : "normal",
    "is_frozen" : 0,
    "frozen_time" : null,
    "db_user" : "root",
    "bak_period" : null,
    "bak_keep_day" : null,
    "bak_expected_start_time" : null,
    "data_store_version_id" : "717b683b-9d89-3e3b-9100-7893bee47d95",
    "data_store_version" : "3.1.11.0",
    "data_store_type" : "star-rocks",
    "create_at" : 1716344516418,
    "update_at" : 1716347522157,
    "delete_at" : null,
    "db_port" : "3306",
    "param_group" : null,
    "actions" : [ ],
    "create_fail_error_code" : "500000",
    "groups" : [ {
      "id" : "8d9d63263ece41619ba819f8d85c5cafgr17",
      "name" : "htap-5d98_fe_shard01",
      "nodes" : [ {
        "id" : "7739bfbc4e244a8bac0662d63683c808no17",
        "name" : "htap-5d98_fe_shard01_node01",
        "type" : "fe-leader",
        "status" : "normal",
        "period" : "null",
        "volume" : {
          "type" : "SSD",
          "size" : "50000000000"
        },
        "cpu" : "4",
        "mem" : "16",
        "datastore" : {
          "id" : "717b683b-9d89-3e3b-9100-7893bee47d95",
          "type" : "star-rocks",
          "version" : "3.1.11.0"
        },
        "actions" : [ ],
        "priority" : 1,
        "frozen_flag" : 0,
        "db_port" : 3306,
        "pay_model" : "0",
        "order_id" : null,
        "traffic_ip" : "192.168.8.4",
        "traffic_ipv6" : "",
        "az_code" : "cn-southwest-244d",
        "az_description" : "az4",
        "az_type" : "Center",
        "region_code" : "cn-southwest-244",
        "create_at" : 1716344516418,
        "update_at" : 1716361751849,
        "flavor_id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a",
        "flavor_ref" : "gaussdb.sr-fe.xlarge.x86.4",
        "iass_flavor_ref" : "c6.xlarge.4",
        "max_connections" : "0",
        "vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
        "subnet_id" : "09249318-4a97-4e48-b314-ffaab86d4295",
        "need_restart" : false,
        "sg_id" : "",
        "param_group" : null
      } ],
      "group_type_name" : "starrocks",
      "group_node_type" : "fe"
    }, {
      "id" : "fc416acdc4c1439e85100e9a7c161932gr17",
      "name" : "htap-5d98_be_shard01",
      "nodes" : [ {
        "id" : "ccab0ba176e642c69d598f2f3c0f06efno17",
        "name" : "htap-5d98_be_shard01_node01",
        "type" : "be",
        "status" : "normal",
        "period" : "null",
        "volume" : {
          "type" : "SSD",
          "size" : "50000000000"
        },
        "cpu" : "4",
        "mem" : "16",
        "datastore" : {
          "id" : "717b683b-9d89-3e3b-9100-7893bee47d95",
          "type" : "star-rocks",
          "version" : "3.1.11.0"
        },
        "actions" : [ ],
        "priority" : 1,
        "frozen_flag" : 0,
        "db_port" : 3306,
        "pay_model" : "0",
        "order_id" : null,
        "traffic_ip" : "192.168.8.194",
        "traffic_ipv6" : "",
        "az_code" : "cn-southwest-244d",
        "az_description" : "az4",
        "az_type" : "Center",
        "region_code" : "cn-southwest-244",
        "create_at" : 1716344516418,
        "update_at" : 1716358866767,
        "flavor_id" : "de565db8-0a96-37ea-9388-61167624712c",
        "flavor_ref" : "gaussdb.sr-be.xlarge.x86.4",
        "iass_flavor_ref" : "c6.xlarge.4",
        "max_connections" : "0",
        "vpc_id" : "f7876b94-3696-419b-a609-161de4b42d59",
        "subnet_id" : "09249318-4a97-4e48-b314-ffaab86d4295",
        "need_restart" : false,
        "sg_id" : "",
        "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"
  } ]
}