API REST de Amazon RDS: una alternativa a la API de datos de RDS para cualquier motor.

API REST · Amazon RDS a un punto final

Gira un Amazon RDS Consulta SQL en una API REST punto final

Para guardar una consulta en el Generador de consultas, haga clic aquí. Nuevo punto finalTienes una URL en api.querystreams.com con su propia clave. La consulta SQL se ejecuta en modo de solo lectura en el agente que ya está integrado en tu base de datos Amazon RDS; quien realiza la llamada recibe JSON o CSV y nunca ve la consulta SQL, el esquema ni la contraseña. No necesitas alojar nada ni abrir ningún puerto. El proceso tarda aproximadamente 90 segundos desde una consulta guardada, y el plan gratuito cubre tu primer punto final.

Aproximadamente 90 segundos desde una consulta guardada No hay servidor que alojar Las credenciales permanecen contigo Una clave por persona que llama, revocable en cualquier momento.

Lo que obtendrás al final

Una URL en api.querystreams.com que devuelve las filas de tu consulta guardada de Amazon RDS como JSON o CSV a cualquier persona que tenga una clave, probada desde la consola en el portal antes de compartirla. Así:

{
  "ciudad": "Seattle"
}

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"city": "Seattle"}'

{
  "columnas": [ { "nombre": "id_cliente", "tipo": "entero" }, { "nombre": "nombre", "tipo": "cadena" }, { "nombre": "ciudad", "tipo": "cadena" } ],
  "filas": [
    { "id_cliente": 1042, "nombre": "Comerciantes del Viento del Norte", "ciudad": "Seattle" },
    { "id_cliente": 1057, "nombre": "Alpine Outfitters", "ciudad": "Denver" },
    { "id_cliente": 1063, "nombre": "Comida del puerto", "ciudad": "Halifax" }
  ],
  "meta": { "row_count": 3, "agent_duration_ms": 41, "id_solicitud": "req_7Hq2mKd9" }
}

Amazon RDS almacena tus datos en la nube, gestionados por su proveedor. Si alguien necesita acceder a ellos en su aplicación, panel de control o script, las soluciones habituales suelen implicar demasiados pasos: un inicio de sesión de base de datos que queda obsoleto, una exportación diaria que se desactualiza antes del desayuno o un pequeño servidor API que alguien debe gestionar y actualizar. Query Streams convierte el punto final en una consulta guardada con una clave. El agente que ya está integrado en tu base de datos Amazon RDS ejecuta la consulta, api.querystreams.com verifica la clave y el límite de solicitudes, y quien realiza la llamada recibe las filas. El código SQL, el esquema y las credenciales nunca salen de tu cuenta.

La API de datos RDS de Amazon solo admite Aurora y devuelve filas con su propio formato de columnas y metadatos. Funciona con cualquier motor que utilice RDS (MySQL, PostgreSQL, SQL Server, MariaDB u Oracle) y devuelve JSON sin formato.

Lo que necesitarás

Una cuenta de Query Streams

Todos los planes incluyen la API REST. El plan gratuito ofrece un endpoint, dos claves y 250 filas por llamada, suficiente para crear esta guía. Regístrese en mi.querystreams.com.

El agente en cualquier ordenador siempre encendido, con la conexión Amazon RDS añadida.

Solo necesita acceso a internet.

Una consulta guardada en el Generador de consultas

El punto final encapsula exactamente una consulta guardada. Escriba la sentencia SELECT, ejecútela una vez y guárdela. Agregue un filtro dinámico (un @variable en la cláusula WHERE) si los que llaman deberían poder filtrar.

Configúralo en cuatro pasos.

1. Guardar la consulta

   En Generador de consultas Selecciona tu conexión a Amazon RDS, escribe la consulta SELECT que deseas publicar y ejecútala una vez para que puedas ver las filas. Limita la consulta a las columnas que necesita quien la realiza; el punto final devuelve exactamente lo que devuelve la consulta.

   Consulta guardada · clientes

   SELECCIONE ID del cliente, nombre, ciudad
   DESDE clientes
   ORDEN POR nombre
   LÍMITE 100;

   Si los usuarios deben poder filtrar, agregue un filtro dinámico, por ejemplo. DONDE ciudad = @ciudad. Cada @variable se convierte en un parámetro de API en el paso 3. Haga clic Guardar y asigna un nombre a la consulta; ese nombre se convierte en el nombre para mostrar del punto final.

2. Crear el punto final

   Abrir API en la barra superior y haga clic Nuevo punto final. El mago tiene cuatro pasos, Seleccionar consulta, Configurar, Parámetros de bloqueo y Compartir. En Seleccionar consultaHaga clic en la consulta que acaba de guardar; las consultas cuyo agente está desconectado aparecen atenuadas. Haga clic Siguiente.

   API abierta

   Atajo. Desde el Generador de consultas puede exponer la consulta abierta directamente; el asistente entonces comienza en Configurar con la consulta ya seleccionada.

3. Configurar y bloquear parámetros

   En Configurar Los valores predeterminados son correctos para un primer punto final: Nombre para mostrar rellenado a partir de la consulta, Esperanza de vida Permanente (elegir Caducando (por una participación temporal), Modo de respuesta Estático (una respuesta JSON; seleccione Transmisión para resultados que superen el límite de filas estático de su plan), Formato interior JSON. El modo y el formato de respuesta son fijos una vez creados, así que decídalos aquí. Haga clic aquí. Siguiente.

   En Parámetros de bloqueo Se enumeran todos los filtros dinámicos de la consulta. Deje los que los llamantes pueden configurar como Llamable y dar a cada uno un Nombre de la cadena de consulta; garrapata Obligatorio Si una llamada sin él debería fallar. Fije un valor que el llamante no debe cambiar con Bloqueadoo un escenario de citas como por ejemplo Comienzo de mes. Oculto Mantiene la configuración predeterminada de la consulta y rechaza cualquier intento de modificarla. Haga clic. Siguiente.

4. Comparte y obtén tu clave.

   En Compartir puedes invitar Gente por correo electrónico o agregar un Clave de servicio para un servidor o una herramienta de automatización, o omita ambos por ahora. Haga clic Crea y obtén mi clave. La pantalla de éxito muestra la URL del punto final y su clave: una cadena de 49 caracteres que comienza qsapi_Cópialo. Puedes volver a mostrarlo más tarde desde el punto final. Compartir pestaña, para que no se pierda si cierras la pantalla.

   Haga clic en Enviar en la consola para realizar la primera llamada desde el propio portal. El panel de respuesta muestra Estado, Tiempo y Tamaño, el Cuerpo La pestaña muestra el JSON y la llamada aparece en el Actividad pulsa la pestaña unos segundos después.

Llámalo desde cualquier lugar

Reemplace el ID del punto final con el suyo desde la barra de URL de la consola y qsapi_TU_CLAVE con su clave. Los parámetros invocables van en la cadena de consulta en GET; aquí la consulta guardada expone ciudad:

curl "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19?city=Seattle" \ -H "X-API-Key: qsapi_YOUR_KEY"

{
  "columnas": [ { "nombre": "id_cliente", "tipo": "entero" }, { "nombre": "nombre", "tipo": "cadena" }, { "nombre": "ciudad", "tipo": "cadena" } ],
  "filas": [
    { "id_cliente": 1042, "nombre": "Comerciantes del Viento del Norte", "ciudad": "Seattle" },
    { "id_cliente": 1057, "nombre": "Alpine Outfitters", "ciudad": "Denver" },
    { "id_cliente": 1063, "nombre": "Comida del puerto", "ciudad": "Halifax" }
  ],
  "meta": { "row_count": 3, "agent_duration_ms": 41, "id_solicitud": "req_7Hq2mKd9" }
}

Las filas se devuelven como objetos indexados por nombre de columna, con la lista de columnas y un meta Bloque que indica cuántas filas hay, si el resultado se recortó y el ID de la solicitud que puede citar para respaldar. La misma llamada como una POST coloca los parámetros en un cuerpo JSON, que es la opción correcta para listas largas de valores:

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"params": {"city": "Seattle"}}'

?formato=csv

CSV en lugar de JSON, con fila de encabezado incluida. Aceptar: texto/csv hace lo mismo. Los puntos finales de transmisión devuelven NDJSON (un objeto JSON por línea) con un final {"_summary": true, "row_count": N} línea; revisa esa última línea.

?muestra=verdadero

Máximo cinco filas, sin costo. Ideal para conectar a un cliente.

?compresión=lz4

Un cuerpo de bastidor LZ4 para llamadas de alto volumen con decodificador; Código La pestaña tiene el fragmento del decodificador por idioma. El gzip simple se realiza automáticamente cuando su cliente envía Codificación aceptada: gzip.

Autorización: Portador qsapi_…

Aceptado como alias de Clave X-APIÚsalo desde el código del navegador.

Dónde se enchufa

Lo que permiten los planes

Cada llamada tiene un tiempo de espera fijo de 60 segundos para la consulta y un límite de respuesta de 8 MiB. Los bytes que devuelve se descuentan del límite de datos mensual de tu plan, el mismo que utilizan los complementos de Excel y Google Sheets. El plan gratuito incluye un punto final y 5 MB al mes, lo cual es suficiente para una tabla pequeña que se consulta varias veces al día. Consulte la página de precios. para las asignaciones por plan.

Mantenerlo seguro

Cuando algo no funciona

Cada cuerpo de error tiene la forma {"error": {"code": "…", "message": "…"}} y cada respuesta conlleva una ID de solicitud X-QS Encabezado. Cita el ID cuando escribas al soporte.

Preguntas que hace la gente

Guías relacionadas

• Conecta Amazon RDS con Claude mediante MCP.
• API REST de base de datos: Convierta cualquier consulta SQL en un punto final.
• API REST de Microsoft SQL Server
• API REST de PostgreSQL
• API REST de MySQL
• API REST de Snowflake