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/ GaussDB(for MySQL)/ Referência de API/ APIs (recomendadas)/ Gerenciamento de banco de dados/ Consulta de bancos de dados

Atualizado em 2024-09-29 GMT+08:00

Ver PDF

Consulta de bancos de dados

Função

Essa API é usada para consultar bancos de dados de uma instância do GaussDB(for MySQL). 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}/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.

**Tabela 2** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
offset	Não	Integer	Deslocamento do índice. Se offset for definido como N, a consulta de recursos será iniciada a partir da parte N+1 dos dados. O valor é 0 por padrão, indicando que a consulta começa a partir da primeira parte dos dados. O valor não pode ser um número negativo.
limit	Não	Integer	Número de registros a serem consultados. O valor padrão é 100. O valor deve ser um número inteiro positivo. O valor mínimo é 1 e o valor máximo é 100.
name	Não	String	Nome do banco de dados.
charset	Não	String	Conjunto de caracteres do banco de dados, por exemplo, utf8mb4 ou gbk.

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. Se o corpo de resposta a seguir for retornado para chamar a API usada para obter um token de usuário, a solicitação será bem-sucedida. Depois que a solicitação é processada, o valor de X-Subject-Token no cabeçalho da mensagem é o valor do token.
X-Language	Não	String	Tipo de linguagem da solicitação. O valor padrão é en-us. Valor: 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 ListGaussMysqlDatabaseInfo objects	Lista de informações do banco de dados.
total_count	Integer	Número total de bancos de dados.

**Tabela 5** ListGaussMysqlDatabaseInfo
Parâmetro	Tipo	Descrição
name	String	Nome do banco de dados.
charset	String	Conjunto de caracteres do banco de dados, por exemplo, utf8mb4 ou gbk.
comment	String	Observações do banco de dados.
users	Array of GaussMySqlDatabaseInfo objects	Lista de usuários autorizados do banco de dados.

**Tabela 6** GaussMySqlDatabaseInfo
Parâmetro	Tipo	Descrição
name	String	Nome de usuário do banco de dados.
host	String	Endereço IP do host.
readonly	Boolean	Se a permissão é somente leitura. Valor: true: somente leitura false: leitura/gravação

Código de status: 400

**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.

Código de status: 500

**Tabela 8** 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 bancos de dados

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/databases?offset=0&limit=100&charset=utf8mb4&name=test

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "databases" : [ {
    "name" : "test",
    "charset" : "utf8mb4",
    "comment" : "database_comment",
    "users" : [ {
      "name" : "gaussdb-mysql-instance1",
      "host" : "127.0.0.1",
      "readonly" : false
    } ]
  } ],
  "total_count" : 1
}