Consulta de bases de datos
Función
Esta API se utiliza para consultar las bases de datos de una instancia de TaurusDB. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
URI
GET /v3/{project_id}/instances/{instance_id}/databases
Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
project_id | Sí | String | Explicación: ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto. Restricciones: Ninguno Rango de valores: El valor puede contener 32 caracteres. Solo se permiten letras y dígitos. Valor predeterminado: Ninguno |
instance_id | Sí | String | Explicación: ID de instancia, que identifica de forma única una instancia. Restricciones: Ninguno Rango de valores: El valor puede contener 36 caracteres con in07 como el sufijo. Solo se permiten letras y dígitos. Valor predeterminado: Ninguno |
Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
offset | No | Integer | Explicación: Desplazamiento de índice. La consulta comienza a partir de la siguiente pieza de datos indexada por este parámetro. Restricciones: El valor debe ser un número entero y no puede ser un número negativo. Rango de valores: ≥0 Valor predeterminado: 0 |
limit | No | Integer | Explicación: Número de registros que se van a consultar. Restricciones: El valor debe ser un número entero y no puede ser un número negativo. Rango de valores: 1–100 Valor predeterminado: 100 |
name | No | String | Explicación: Nombre de la base de datos. Restricciones: Ninguno Rango de valores: Ninguno Valor predeterminado: Ninguno |
charset | No | String | Explicación: Conjunto de caracteres utilizado por la base de datos. Para obtener este valor, véase Consulta de conjuntos de caracteres de base de datos disponibles. Restricciones: Ninguno Rango de valores: Ninguno Valor predeterminado: Ninguno |
Parámetros de solicitud
Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
X-Auth-Token | Sí | String | Explicación: Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token. Restricciones: Ninguna Rango de valor: Ninguna Valor predeterminado: Ninguna |
X-Language | No | String | Explicación: Tipo de idioma de solicitud. Restricciones: Ninguna Rango de valor:
Valor predeterminado: en-us |
Parámetros de respuesta
Código de estado: 200
Parámetro | Tipo | Descripción |
|---|---|---|
databases | Array of ListGaussMysqlDatabaseInfo objects | Explicación: Lista de bases de datos. |
total_count | Integer | Explicación: Número total de bases de datos. Rango de valores: ≥0 |
Parámetro | Tipo | Descripción |
|---|---|---|
name | String | Explicación: Nombre de la base de datos. Rango de valores: Ninguno |
charset | String | Explicación: Conjunto de caracteres utilizado por la base de datos. Rango de valores: Ninguno |
comment | String | Explicación: Notas de la base de datos. Rango de valores: Ninguno |
users | Array of GaussMySqlDatabaseInfo objects | Explicación: Lista de usuarios autorizados de la base de datos. |
Parámetro | Tipo | Descripción |
|---|---|---|
name | String | Explicación: Nombre de usuario de base de datos. Rango de valores: Ninguno |
host | String | Explicación: Dirección IP del host. Rango de valores: Ninguno |
readonly | Boolean | Explicación: Si el permiso es de solo lectura. Rango de valores:
|
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. |
Ejemplo de la solicitud
Consulta de bases de datos
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/databases?offset=0&limit=100&charset=utf8mb4&name=test Ejemplo de respuesta
Código de estado: 200
Operación exitosa.
{
"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 estado
Para más detalles, véase Códigos de estado.
Código de error
Para más detalles, véase Códigos de error.

