Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/TaurusDB/Referencia de la API/Las API (recomendadas)/HTAP (Edición estándar)/Consulta de bases de datos de una instancia de StarRocks
Actualización más reciente 2025-03-21 GMT+08:00
Ver PDF
Compartir

Consulta de bases de datos de una instancia de StarRocks

Función

Esta API se utiliza para consultar bases de datos de una instancia de StarRocks. Antes de invocar a esta API:

URI

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

Tabla 1 Parámetros de URI

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 StarRocks, que es compatible con el formato UUID.

Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

limit

No

String

Número de registros que se van a consultar.

offset

No

String

Desplazamiento de índice. Si offset se establece en N, la consulta de recursos comienza desde el dato N+1. Si el valor está establecido en 0, indica que la consulta comienza desde el primer dato. El valor debe ser un número pero no puede ser un número negativo.

database_name

No

String

Nombre de la base de datos que se va a consultar. Se soporta la búsqueda difusa. El valor puede contener de 3 a 128 caracteres. Solo se permiten mayúsculas, minúsculas, dígitos y guiones bajos (_).

Parámetros de solicitud

Tabla 3 Parámetros de encabezado 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.

X-Language

Sí

String

Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores:

  • en-us
  • zh-cn

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

databases

Array of strings

Nombre de la base de datos.

total_count

Integer

Cantidad de bases de datos.

timestamp

Integer

Consultar la marca de tiempo.

Código de estado: 400

Tabla 5 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 500

Tabla 6 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Ejemplo de la solicitud

Consulta de las primeras 10 bases de datos de una instancia de StarRocks con el ID de instancia especificado

GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases?limit=10&offset=1&database_name=

Ejemplo de la respuesta

Código de estado: 200

Operación exitosa.

{
  "databases" : [ "INFORMATION_SCHEMA", "connections_db1_08759", "connections_db1_31465", "default", "information_schema", "system" ],
  "total_count" : 6,
  "timestamp" : 1706257484
}

Código de estado: 400

Error de cliente.

{
  "error_code" : "DBS.200022",
  "error_msg" : "Instance not found."
}

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.