Consulta de bases de datos
Función
Esta API se utiliza para consultar bases de datos de una instancia de base de datos especificada.
- Antes de invocar a una API, debe entender la API de Autenticación.
Restricciones
- Esta operación no se puede realizar cuando la instancia de base de datos está en el estado anormal o congelado.
- Las bases de datos de réplicas de lectura no se pueden consultar.
URI
- Formato de URI
GET /v3/{project_id}/instances/{instance_id}/database/detail?page={page}&limit={limit}&db-name={db-name}&recover_model={recover_model}
- Descripción de parámetro
Tabla 1 Descripción de parámetro Nombre
Obligatorio
Descripción
project_id
Sí
Especifica el ID de proyecto de un tenant en una región.
Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.
instance_id
Sí
Especifica el ID de instancia de base de datos.
page
Sí
Especifica el número de página. El valor comienza desde 1.
limit
Sí
Especifica el número de registros de cada página. El valor varía de 1 (inclusivo) a 100 (inclusivo).
db-name
No
Especifica el nombre de la base de datos. Cuando se especifica este parámetro, es necesario especificar los parámetros page y limit, pero no tienen efecto.
recover_model
No
Especifica los modelos de recuperación de bases de datos. Valor:
- FULL: modelo de recuperación completa
- SIMPLE: modelo de recuperación simple
- BULK_LOGGED: modelo de recuperación a granel
Solicitud
Respuesta
- Respuesta normal
Tabla 2 Descripción de parámetro Nombre
Tipo
Descripción
databases
Array of objects
Cada elemento de la lista indica una base de datos.
Para obtener más información, consulte Tabla 3.
total_count
Integer
Indica el número total de bases de datos.
Tabla 3 descripción de la estructura del elemento de bases de datos Nombre
Tipo
Descripción
name
String
Indica el nombre de la base de datos.
character_set
String
Indica el juego de caracteres utilizado por la base de datos, como Chinese_PRC_CI_AS.
state
String
Indica el estado de la base de datos. Su valor puede ser cualquiera de los siguientes:
- Creating: Se está creando la base de datos.
- Running: la base de datos se está ejecutando.
- Deleting: se está eliminando la base de datos.
- Not Exists: la base de datos no existe.
- Ejemplo de respuesta normal
{ "databases": [ { "name": "master", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "msdb", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "model", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "tempdb", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "rdsadmin", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "rds-test", "character_set": "Chinese_PRC_CI_AS", "state": "Running" } ], "total_count": 6 }
- Respuesta anormal
Para obtener más información, consulte Resultados de solicitud anormales.
Código de estado
- Normal
- Anormal
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.