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 contas de banco de dados
Atualizado em 2025-05-23 GMT+08:00
Ver PDF
Compartilhar

Consulta de contas de banco de dados

Função

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

URI

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

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

user_name

Não

String

Conta do banco de dados.

limit

Sim

Integer

Número de registros a serem consultados. O valor não pode ser um número negativo. O valor mínimo é 1 e o valor máximo é 100.

offset

Sim

Integer

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.

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

Não

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

user_details

Array of user_details objects

Informações da conta do banco de dados.

total_count

Integer

Número de contas do banco de dados.

Tabela 5 user_details

Parâmetro

Tipo

Descrição

user_name

String

Nome de usuário da conta do banco de dados.

data_bases

Array of strings

Bancos de dados autorizados.

dml

Integer

Permissões DML.

  • 0: permissões de leitura/gravação
  • 1: permissões somente leitura
  • 2: permissões somente leitura e de configuração
  • 3: permissões de leitura/gravação e configuração

ddl

Integer

Se as permissões DDL são concedidas.

  • 0: não
  • 1: sim

Código de status: 400

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.

Código de status: 500

Tabela 7 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 contas de banco de dados

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/starrocks/users?limit=10

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "user_details" : [ {
    "user_name" : "root",
    "databases" : [ "*" ],
    "dml" : 2,
    "ddl" : 0
  }, {
    "user_name" : "user_test",
    "databases" : [ "*" ],
    "dml" : 2,
    "ddl" : 0
  } ],
  "total_count" : 2
}

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)