Consulta de una instancia de StarRocks
Función
Esta API se utiliza para consultar una instancia de StarRocks. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
URI
GET /v3/{project_id}/instances/{instance_id}/starrocks/{starrocks_instance_id}
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| project_id | Sí | String | ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto. |
| instance_id | Sí | String | ID de instancia de TaurusDB, que es compatible con el formato UUID. |
| starrocks_instance_id | Sí | String | ID de instancia de StarRocks, que es compatible con el formato UUID. |
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| X-Auth-Token | Sí | String | Token de usuario. Para obtener este valor, invoque a la API de IAM para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token. |
| Content-Type | Sí | String | Tipo de contenido. Valor: application/json |
| X-Language | No | String | Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores:
|
Parámetros de respuesta
Código de estado: 200
| Parámetro | Tipo | Descripción |
|---|---|---|
| instances | Array of instances objects | información sobre instancias |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de instancia, que es compatible con el formato UUID. |
| name | String | Nombre de instancia. |
| project_id | String | ID de proyecto de un tenant en una región. |
| public_ip | String | Dirección IP pública. |
| data_vip | String | Dirección IP de datos del nodo frontend. Utilice comas (,) para separar varias direcciones IP. |
| can_enable_public_access | Boolean | Si se puede acceder a la instancia desde una red pública. |
| current_backup_node_id | String | ID del nodo de copia de respaldo. |
| cluster_mode | String | Modo del despliegue. |
| status | String | Estado de la instancia. |
| is_frozen | Integer | Si la instancia está congelada. |
| frozen_time | Long | Tiempo congelado. |
| db_user | String | Nombre de usuario predeterminado. |
| bak_period | String | Ciclo de copia de respaldo. |
| bak_keep_day | Integer | Días de retención de copia de respaldo. |
| bak_expected_start_time | Long | Hora estimada de inicio de copia de respaldo. |
| data_store_version_id | String | ID de versión de la base de datos. |
| data_store_version | String | Versión de base de datos. |
| data_store_type | String | Motores de BD. |
| create_at | Long | Tiempo de creación de instancias. |
| update_at | Long | Hora de actualización de instancia. |
| delete_at | Long | Tiempo de borrado de instancia. |
| db_port | String | Puerto de base de datos. |
| param_group | String | Plantilla de parámetros. |
| actions | Array of QueryAction objects | Acciones de instancia. |
| create_fail_error_code | String | Código de error para error de creación. |
| groups | Array of groups objects | Grupos de instancias. |
| ops_window | ops_window object | Ventana de tiempo de operación de instancia. |
| tags_info | tags_info object | Etiquetas de instancia. |
| time_zone | String | Zona horaria. |
| backup_used_space | String | Espacio usado de copia de respaldo. |
| az_mode | String | Tipo de zona de disponibilidad. Valores:
|
| enterprise_project_id | String | ID de proyecto de empresa. |
| port_info | port_info object | Información del puerto. |
| fe_node_volume_code | String | Tipo de almacenamiento del nodo frontend. |
| be_node_volume_code | String | Tipo de almacenamiento del nodo backend. |
| fe_node_volume_size | String | Espacio de almacenamiento del nodo frontend. |
| be_node_volume_size | String | Espacio de almacenamiento del nodo backend. |
| support_data_replication | Boolean | Si se admite la replicación de datos. |
| new_version_available | Boolean | Si existe una nueva versión de BD disponible. |
| ssl_option | Boolean | Conmutador de SSL. |
| dedicated_resource_id | String | ID del grupo de recursos dedicado. Este parámetro se devuelve solo cuando la instancia pertenece a un grupo de recursos dedicado. |
| pay_model | String | Modo de facturación. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de grupo. |
| name | String | Nombre del grupo. |
| nodes | Array of nodes objects | Información del nodo de instancia. |
| group_type_name | String | Nombre del tipo de grupo de instancias. |
| group_node_type | String | Tipo del nodo en el grupo de instancias. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de nodo de instancia. |
| name | String | Nombre del nodo de instancia. |
| type | String | Tipo de nodo de instancia. |
| status | String | Node status. Valores:
|
| period | String | Período de suscripción del nodo de instancia. |
| volume | volume object | Información de almacenamiento del nodo de instancia. |
| cpu | String | vCPU del nodo de instancia. |
| mem | String | Tamaño de memoria (GB) del nodo de instancia. |
| datastore | datastore object | Información de la base de datos. |
| actions | Array of QueryAction objects | Acciones de nodo. |
| priority | Integer | Prioridad de nodo. |
| frozen_flag | Integer | Bandera congelada. |
| db_port | Integer | Número de puerto de la base de datos. El valor predeterminado es 3306. |
| pay_model | String | Modo de facturación. |
| order_id | String | ID de pedido. |
| traffic_ip | String | Dirección IP de datos. |
| traffic_ipv6 | String | Dirección IPv6 de datos. |
| az_code | String | Código de zona de disponibilidad. |
| az_description | String | Descripción de zona de disponibilidad. |
| az_type | String | Tipo de zona de disponibilidad. |
| region_code | String | Región donde se despliega la instancia. |
| create_at | Long | Hora en la que se creó el nodo. |
| update_at | Long | Hora en la que se actualizó el nodo. |
| flavor_id | String | ID de especificación de nodo. |
| flavor_ref | String | Código de especificación del nodo. |
| iaas_flavor_ref | String | Código de especificación de IaaS. |
| max_connections | String | Cantidad máxima de conexiones de red pública. |
| vpc_id | String | ID de VPC. |
| subnet_id | String | ID de subred. |
| need_restart | Boolean | Si es necesario reiniciar para actualizar los parámetros. |
| sg_id | String | Grupo de seguridad. |
| param_group | Map<String,ParamGroup> | Información de la plantilla de parámetros. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| type | String | Tipo de almacenamiento del nodo de instancia. |
| size | String | Espacio de almacenamiento del nodo de instancia. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de base de datos. |
| type | String | Tipo de base de datos. |
| version | String | Versión de base de datos. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de la acción de instancia o de nodo. |
| action | String | Nombre de la acción de instancia o de nodo. |
| object_id | String | ID de objeto de la acción de instancia o de nodo. |
| type | String | Tipo de la acción de instancia o de nodo. |
| job_id | String | ID de tarea de la acción de instancia o de nodo. |
| status | String | Estado de la acción de instancia o de nodo. Valores enumerados:
|
| created_at | Long | Hora en la que se creó la acción de instancia o de nodo. |
| updated_at | Long | Hora en la que se actualizó la acción de instancia o de nodo. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de plantilla de parámetros. |
| name | String | Nombre de la plantilla del parámetro. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| period | String | Período de ventana de tiempo. |
| start_time | String | Hora de inicio de la ventana de tiempo. |
| end_time | String | Hora de finalización de la ventana de tiempo. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| tags | Array of tags objects | Etiquetas de usuario. |
| sys_tags | Array of sys_tags objects | Etiquetas del sistema. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| key | String | Clave de etiqueta.
|
| value | String | Valor de etiqueta.
|
| Parámetro | Tipo | Descripción |
|---|---|---|
| key | String | Clave de etiqueta.
|
| value | String | Valor de etiqueta.
|
| Parámetro | Tipo | Descripción |
|---|---|---|
| mysql_port | Integer | Puerto de TaurusDB. El valor predeterminado es 3306. |
Código de estado: 400
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 500
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Ejemplo de la solicitud
Consulta del ID de una instancia de StarRocks
GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/fb632d1d531a4107804f0f082581810fin07/starrocks/b6280c323ce449f2ad02af74e21f3dc5in17 Ejemplo de la respuesta
Código de estado: 200
Operación exitosa.
{
"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 estado
Para más detalles, véase Códigos de estado.
Código de error
Para más detalles, véase Códigos de error.