Consulta de bancos de dados
Função
Essa API é usada para consultar bancos de dados. 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}/clickhouse/databases
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 ClickHouse, que é compatível com o formato UUID. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
limit |
Não |
Integer |
Número de registros a serem consultados. O valor padrão é 10. O valor não pode ser um número negativo. O valor mínimo é 1 e o valor máximo é 100. |
offset |
Não |
Integer |
Deslocamento do índice. O valor padrão é 0. 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. |
Parâmetros 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:
|
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
databases |
Array of strings |
Lista de bancos de dados. |
total_count |
Integer |
Número total de bancos de dados. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
Consulta dos 10 primeiros bancos de dados de uma instância
GET https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/databases?limit=10&offset=1&database_name=
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "databases": [ "black_0003_47852503", "blackwhite_0017_22525694", "blackwhite_0022_05703881", "blackwhite_0022_74636728", "db_par_00473111", "db_par_06456394", "db_par_09021212", "db_par_12417082", "db_par_14323386", "db_par_19408230" ], "total_count": 42, }
Código de status
Código de status |
Descrição |
---|---|
200 |
Bem-sucedido. |
400 |
Erro do cliente. |
500 |
Erro no servidor. |
Código de erro
Para obter detalhes, consulte Códigos de erro.