Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ TaurusDB/ Referência de API/ APIs (recomendadas)/ HTAP (edição padrão)/ Consulta de bancos de dados de uma instância do StarRocks
Atualizado em 2025-05-23 GMT+08:00
Ver PDF
Compartilhar

Consulta de bancos de dados de uma instância do StarRocks

Função

Essa API é usada para consultar bancos de dados de uma instância do StarRocks. Antes de chamar essa API:

URI

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

Tabela 1 Parâmetros de URI

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 StarRocks, que é compatível com o formato UUID.
Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

limit

Não

String

Número de registros a serem consultados.

offset

Não

String

Deslocamento do índice. Se offset estiver definido como N, a consulta de recursos começará a partir da parte de dados N+1. Se o valor for definido como 0, indicando que a consulta começa a partir do primeiro dado. O valor deve ser um número, mas não pode ser um número negativo.

database_name

Não

String

Nome do banco de dados a ser consultado. Pesquisa difusa é suportada. O valor pode conter de 3 a 128 caracteres. Somente letras maiúsculas, letras minúsculas, dígitos e sublinhados (_) são permitidos.

Parâmetros de solicitação

Tabela 3 Parâmetros de cabeçalho 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.

X-Language

Sim

String

Tipo de linguagem da solicitação. O valor padrão é en-us. Valores:

  • en-us
  • zh-cn

Parâmetros de resposta

Código de status: 200

Tabela 4 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

databases

Array of strings

Nome do banco de dados.

total_count

Integer

Número de bases de dados.

timestamp

Integer

Carimbo de data/hora da consulta.

Código de status: 400

Tabela 5 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 500

Tabela 6 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Exemplo de solicitação

Consulta de 10 primeiros bancos de dados de uma instância do StarRocks com ID de instância especificado

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

Exemplo de resposta

Código de status: 200

Bem-sucedido.

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

Código de status: 400

Erro do cliente.

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

Código de status

Para mais detalhes, consulte Códigos de status.

Código de erro

Para mais detalhes, consulte Códigos de erro.

Tópico principal: HTAP (edição padrão)