Consulta de bases de datos
Función
Esta API se utiliza para consultar bases de datos de una instancia de GaussDB(for MySQL). Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtener los región y punto de conexión requeridos.
URI
GET /v3/{project_id}/instances/{instance_id}/databases
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto. |
instance_id |
Sí |
String |
ID de instancia. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
offset |
No |
Integer |
Desplazamiento de índice. Si offset se establece en N, la consulta de recursos comienza desde el dato N+1. El valor es 0 de forma predeterminada, lo que indica que la consulta comienza desde el primer dato. El valor no puede ser un número negativo. |
limit |
No |
Integer |
Número de registros a consultar. El valor predeterminado es 100. El valor debe ser un número positivo entero. El valor mínimo es de 1 y el valor máximo de 100. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. |
X-Language |
No |
String |
Idioma. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
databases |
Array of ListGaussMysqlDatabaseInfo objects |
Lista de información de la base de datos. |
total_count |
Integer |
Número total de bases de datos. |
Parámetro |
Tipo |
Descripción |
---|---|---|
name |
String |
Nombre de la base de datos. |
charset |
String |
Conjunto de caracteres de la base de datos, por ejemplo utf8mb4 o gbk. |
users |
Array of GaussMySqlDatabaseInfo objects |
Lista de usuarios autorizados de la base de datos. |
Parámetro |
Tipo |
Descripción |
---|---|---|
name |
String |
Nombre de usuario de base de datos. |
host |
String |
Dirección IP del host. |
readonly |
Boolean |
Si el permiso de la base de datos es de solo lectura. true: de solo lectura. false: de lectura/escritura. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Solicitud de ejemplo
Consulta de bases de datos
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/databases?offset=0&limit=100
Ejemplo de respuesta
Código de estado: 200
Success.
{ "databases" : [ { "name" : "test", "charset" : "utf8mb4", "users" : [ { "name" : "gaussdb-mysql-instance1", "host" : "127.0.0.1", "readonly" : false } ] } ], "total_count" : 1 }
Código de estado
Para obtener más información, consulte Códigos de estado.
Código de error
Para obtener más información, consulte Códigos de error.