Consulta de complementos
Función
Esta API se utiliza para obtener información del complemento de una base de datos especificada.
- Antes de invocar a una API, debe entender la API de Autenticación.
Restricciones
- Esta API está en OBT. Para utilizar esta API, póngase en contacto con el servicio de atención al cliente.
- Esta operación no se puede realizar cuando la instancia de base de datos se encuentra en cualquiera de los siguientes estados: creación, cambio de clase de instancia, cambio de puerto, congelado, o anormal.
URI
- Formato de URI
GET /v3/{project_id}/instances/{instance_id}/extensions?database_name={database_name}&offset={offset}&limit={limit}
- Descripción de parámetro
Tabla 1 Parámetros Parámetro
Obligatorio
Descripción
project_id
Sí
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í
ID de instancia.
database_name
Sí
Nombre de la base de datos.
offset
No
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 debe ser un número pero no puede ser un número negativo.
limit
No
Número de registros a consultar. El valor predeterminado es 100. El valor debe ser un entero positivo. El valor mínimo es de 1 y el valor máximo de 100.
Solicitud
Respuesta
- Respuesta normal
Tabla 2 Parámetros Parámetro
Tipo
Descripción
extensions
Array of objects
Lista de complemento.
Para obtener más información, consulte Tabla 3.
total_count
Integer
Número total de complementos.
Tabla 3 descripción de la estructura del elemento de extensiones Parámetro
Tipo
Descripción
name
String
Nombre del complemento.
database_name
String
Nombre de la base de datos.
version
String
Versión del complemento.
shared_preload_libraries
String
Biblioteca precargada dependiente.
created
Boolean
Si el complemento ha sido creado.
description
String
Descripción del complemento.
- Ejemplo de respuesta normal
{ "extensions" : [ { "name" : "pg_cron", "database_name" : "db1", "version" : "1.0", "shared_preload_libraries" : "pg_cron", "created" : false, "description" : "pg_cron access method - signature file based index" }, { "name" : "dblink", "database_name" : "db1", "version" : "1.2", "shared_preload_libraries" : "", "created" : false, "description" : "connect to other PostgreSQL databases from within a database" } ], "total_count" : 2 }
- 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.