Consulta de uma instância do StarRocks
Função
Essa API é usada para consultar uma instância do StarRocks. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
GET /v3/{project_id}/instances/{instance_id}/starrocks/{starrocks_instance_id}
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
|
instance_id |
Sim |
String |
ID da instância do TaurusDB, que é compatível com o formato UUID. |
|
starrocks_instance_id |
Sim |
String |
ID da instância do StarRocks, que é compatível com o formato UUID. |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Token do usuário. Para obter esse valor, chame a API do IAM para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o valor do token. |
|
Content-Type |
Sim |
String |
Tipo de conteúdo. Valor: application/json |
|
X-Language |
Não |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Valores:
|
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
instances |
Array of instances objects |
Informações da instância. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID da instância, que é compatível com o formato UUID. |
|
name |
String |
Nome da instância. |
|
project_id |
String |
ID do projeto de um locatário numa região. |
|
public_ip |
String |
Endereço IP público. |
|
data_vip |
String |
Endereço IP de dados do nó de front-end. Use vírgulas (,) para separar vários endereços IP. |
|
can_enable_public_access |
Boolean |
Se a instância pode ser acessada de uma rede pública. |
|
current_backup_node_id |
String |
ID do nó de backup. |
|
cluster_mode |
String |
Modo de implementação. |
|
status |
String |
Status da instância. |
|
is_frozen |
Integer |
Se a instância está congelada. |
|
frozen_time |
Long |
Tempo congelado. |
|
db_user |
String |
Nome de usuário padrão. |
|
bak_period |
String |
Ciclo de backup. |
|
bak_keep_day |
Integer |
Dias de retenção de backup. |
|
bak_expected_start_time |
Long |
Hora estimada de início do backup. |
|
data_store_version_id |
String |
ID da versão do BD. |
|
data_store_version |
String |
Versão de BD. |
|
data_store_type |
String |
Mecanismo de BD. |
|
create_at |
Long |
Hora de criação da instância. |
|
update_at |
Long |
Hora de atualização da instância. |
|
delete_at |
Long |
Hora de exclusão da instância. |
|
db_port |
String |
Porta do banco de dados. |
|
param_group |
String |
Modelo de parâmetro. |
|
actions |
Array of QueryAction objects |
Ações de instância. |
|
create_fail_error_code |
String |
Código de erro para falha de criação. |
|
groups |
Array of groups objects |
Grupos de instâncias. |
|
ops_window |
ops_window object |
Janela de tempo de operação da instância. |
|
tags_info |
tags_info object |
Tags de instância. |
|
time_zone |
String |
Fuso horário. |
|
backup_used_space |
String |
Espaço de backup usado. |
|
az_mode |
String |
Tipo de AZ. Valores:
|
|
enterprise_project_id |
String |
ID do projeto empresarial. |
|
port_info |
port_info object |
Informações da porta. |
|
fe_node_volume_code |
String |
Tipo de armazenamento do nó de front-end. |
|
be_node_volume_code |
String |
Tipo de armazenamento do nó de back-end. |
|
fe_node_volume_size |
String |
Espaço de armazenamento do nó de front-end. |
|
be_node_volume_size |
String |
Espaço de armazenamento do nó de back-end. |
|
support_data_replication |
Boolean |
Se a replicação de dados é suportada. |
|
new_version_available |
Boolean |
Se há uma nova versão de BD disponível. |
|
ssl_option |
Boolean |
Opção de SSL. |
|
dedicated_resource_id |
String |
ID do pool de recursos dedicado. Esse parâmetro é retornado somente quando a instância pertence a um pool de recursos dedicado. |
|
pay_model |
String |
Modo de cobrança. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID do grupo. |
|
name |
String |
Nome de grupo. |
|
nodes |
Array of nodes objects |
Informações do nó da instância. |
|
group_type_name |
String |
Nome do tipo de grupo de instâncias. |
|
group_node_type |
String |
Tipo do nó no grupo de instâncias. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID do nó da instância. |
|
name |
String |
Nome do nó da instância. |
|
type |
String |
Tipo de nó de instância. |
|
status |
String |
Status do nó. Valores:
|
|
period |
String |
Período de assinatura do nó da instância. |
|
volume |
volume object |
Informações de armazenamento do nó da instância. |
|
cpu |
String |
vCPUs do nó da instância. |
|
mem |
String |
Tamanho da memória (GB) do nó da instância. |
|
datastore |
datastore object |
Informações do banco de dados. |
|
actions |
Array of QueryAction objects |
Ações de nó. |
|
priority |
Integer |
Prioridade do nó. |
|
frozen_flag |
Integer |
Bandeira congelada. |
|
db_port |
Integer |
Número da porta do banco de dados. O valor padrão é 3306. |
|
pay_model |
String |
Modo de cobrança. |
|
order_id |
String |
ID do pedido. |
|
traffic_ip |
String |
Endereço IP dos dados. |
|
traffic_ipv6 |
String |
Endereço IPv6 de dados. |
|
az_code |
String |
Código de AZ. |
|
az_description |
String |
Descrição da AZ. |
|
az_type |
String |
Tipo de AZ. |
|
region_code |
String |
Região onde a instância é implementada. |
|
create_at |
Long |
Hora em que o nó foi criado. |
|
update_at |
Long |
Hora em que o nó foi atualizado. |
|
flavor_id |
String |
ID de especificação do nó. |
|
flavor_ref |
String |
Código de especificação do nó. |
|
iaas_flavor_ref |
String |
Código de especificação de IaaS. |
|
max_connections |
String |
Número máximo de conexões de rede pública. |
|
vpc_id |
String |
ID de VPC |
|
subnet_id |
String |
ID da sub-rede. |
|
need_restart |
Boolean |
Se uma reinicialização é necessária para a atualização de parâmetros. |
|
sg_id |
String |
Grupo de segurança. |
|
param_group |
Map<String,ParamGroup> |
Informações do modelo de parâmetro. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
type |
String |
Tipo de armazenamento do nó da instância. |
|
size |
String |
Espaço de armazenamento do nó da instância. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID do banco de dados. |
|
type |
String |
Tipo de banco de dados. |
|
version |
String |
Versão de BD. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID de ação da instância ou do nó. |
|
action |
String |
Nome da ação da instância ou do nó. |
|
object_id |
String |
ID do objeto da instância ou ação de nó. |
|
type |
String |
Tipo de ação de instância ou nó. |
|
job_id |
String |
ID da tarefa da instância ou ação do nó. |
|
status |
String |
Status da ação da instância ou do nó. Valores enumerados:
|
|
created_at |
Long |
Hora em que a instância ou a ação de nó foi criada. |
|
updated_at |
Long |
Hora em que a instância ou a ação do nó foi atualizada. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID do modelo de parâmetro. |
|
name |
String |
Nome do modelo de parâmetro. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
period |
String |
Período da janela de tempo. |
|
start_time |
String |
Hora de início da janela de tempo. |
|
end_time |
String |
Hora de término da janela de tempo. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
tags |
Array of tags objects |
Tags do usuário. |
|
sys_tags |
Array of sys_tags objects |
Tags do sistema. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
key |
String |
Chave da tag.
|
|
value |
String |
Valor da tag.
|
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
key |
String |
Chave da tag.
|
|
value |
String |
Valor da tag.
|
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
mysql_port |
Integer |
Porta de TaurusDB. O valor padrão é 3306. |
Código de status: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Código de status: 500
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
Consulta do ID de uma instância do StarRocks
GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/fb632d1d531a4107804f0f082581810fin07/starrocks/b6280c323ce449f2ad02af74e21f3dc5in17
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{
"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"
} ]
}
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.