Consulta de bancos de dados
Função
Essa API é usada para consultar bancos de dados de uma instância do TaurusDB. 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
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
Explicação: ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. Restrições: Nenhuma Intervalo de valores: O valor pode conter 32 caracteres. Apenas letras e dígitos são permitidos. Valor padrão: Nenhum |
instance_id |
Sim |
String |
Explicação: ID da instância, que identifica exclusivamente uma instância. Restrições: Nenhuma Intervalo de valores: O valor pode conter 36 caracteres com um sufixo de in07. Apenas letras e dígitos são permitidos. Valor padrão: Nenhum |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
offset |
Não |
Integer |
Explicação: Deslocamento do índice. A consulta começa a partir da próxima parte dos dados indexados por este parâmetro. Restrições: O valor deve ser um número inteiro e não pode ser um número negativo. Intervalo de valores: ≥0 Valor padrão: 0 |
limit |
Não |
Integer |
Explicação: Número de registros a serem consultados. Restrições: O valor deve ser um número inteiro e não pode ser um número negativo. Intervalo de valores: 1–100 Valor padrão: 100 |
name |
Não |
String |
Explicação: Nome do banco de dados. Restrições: Nenhuma Intervalo de valores: Nenhum Valor padrão: Nenhum |
charset |
Não |
String |
Explicação: Conjunto de caracteres usado pelo banco de dados. Para obter esse valor, consulte Consulta de conjuntos de caracteres de banco de dados disponíveis. Restrições: Nenhuma Intervalo de valores: Nenhum Valor padrão: Nenhum |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Explicação: Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o valor do token. Restrições: Nenhuma Intervalo de valores: Nenhum Valor padrão: Nenhum |
X-Language |
Não |
String |
Explicação: Tipo de linguagem da solicitação. Restrições: Nenhuma Intervalo de valores:
Valor padrão: en-us |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
databases |
Array of ListGaussMysqlDatabaseInfo objects |
Explicação: Lista de bancos de dados. |
total_count |
Integer |
Explicação: Número total de bancos de dados. Intervalo de valores: ≥0 |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Explicação: Nome do banco de dados. Intervalo de valores: Nenhum |
charset |
String |
Explicação: Conjunto de caracteres usado pelo banco de dados. Intervalo de valores: Nenhum |
comment |
String |
Explicação: Observações do banco de dados. Intervalo de valores: Nenhum |
users |
Array of GaussMySqlDatabaseInfo objects |
Explicação: Lista de usuários autorizados do banco de dados. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Explicação: Nome de usuário do banco de dados. Intervalo de valores: Nenhum |
host |
String |
Explicação: Endereço IP do host. Intervalo de valores: Nenhum |
readonly |
Boolean |
Explicação: Se a permissão é somente leitura. Intervalo de valores:
|
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 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 }
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.