API REST da Aiven: Transforme uma consulta SQL em um endpoint.

API REST · Aiven para um endpoint

Vire um Aiven Consulta SQL em um API REST ponto final

Para salvar uma consulta no Construtor de Consultas, clique em Novo ponto finalE você tem um URL em api.querystreams.com com sua própria chave. O SQL é executado em modo somente leitura no Agente que já está associado ao seu banco de dados Aiven; o solicitante recebe JSON ou CSV e nunca vê o SQL, o esquema ou uma senha. Nada para hospedar, nenhuma porta para abrir. Cerca de 90 segundos a partir de uma consulta salva, e o plano gratuito cobre seu primeiro endpoint.

Aproximadamente 90 segundos a partir de uma consulta salva Nenhum servidor para hospedar As credenciais permanecem com você. Uma chave por chamador, revogue a qualquer momento.

O resultado final será o que você obterá.

Um URL em api.querystreams.com que retorna as linhas da sua consulta Aiven salva como JSON ou CSV para qualquer pessoa que possua uma chave, testada no console do portal antes de você compartilhar. Assim:

{
  "cidade": "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"}'

{
  "colunas": [ { "nome": "id_do_cliente", "tipo": "inteiro" }, { "nome": "nome", "tipo": "corda" }, { "nome": "cidade", "tipo": "corda" } ],
  "fileiras": [
    { "id_do_cliente": 1042, "nome": "Comerciantes do Vento Norte", "cidade": "Seattle" },
    { "id_do_cliente": 1057, "nome": "Alpine Outfitters", "cidade": "Denver" },
    { "id_do_cliente": 1063, "nome": "Alimentos do Porto", "cidade": "Halifax" }
  ],
  "meta": { "contagem_de_linhas": 3, "duração_do_agente_ms": 41, "id_da_solicitação": "req_7Hq2mKd9" }
}

A Aiven armazena seus dados na nuvem, sob a gestão do seu provedor. Se alguém precisar de uma parte desses dados para usar em seu aplicativo, painel de controle ou script, as soluções comuns geralmente envolvem muita informação: um login de banco de dados que se torna obsoleto após o término do projeto, uma exportação noturna que já está desatualizada antes do café da manhã ou um pequeno servidor de API que precisa ser mantido e atualizado por outra pessoa. O Query Streams transforma o endpoint em uma consulta salva e uma chave. O agente já integrado ao seu serviço Aiven executa a consulta, o api.querystreams.com verifica a chave e o limite de requisições, e o solicitante recebe as linhas. O SQL, o esquema e as credenciais nunca saem da sua conta.

O que você vai precisar

Uma conta do Query Streams

Todos os planos incluem a API REST. O plano gratuito oferece um endpoint, duas chaves e 250 linhas por chamada, o suficiente para criar este guia. Cadastre-se em my.querystreams.com.

O Agente em qualquer computador sempre ligado, com a conexão Aiven adicionada.

Basta ter acesso à internet.

Uma consulta salva no Construtor de Consultas

O endpoint encapsula exatamente uma consulta salva. Escreva o SELECT, execute-o uma vez e salve-o. Adicione um filtro dinâmico (um @variable (na cláusula WHERE) se os chamadores devem poder filtrar.

Configure em quatro etapas

1. Salvar consulta

   Em Construtor de consultas Selecione sua conexão Aiven, escreva a instrução SELECT que deseja publicar e execute-a uma vez para visualizar as linhas. Limite-se às colunas necessárias para quem fez a chamada; o endpoint retorna exatamente o que a consulta retorna.

   Consulta salva · clientes

   SELECIONAR ID do cliente, nome, cidade
   DE clientes públicos
   ORDEM POR nome
   LIMITE 100;

   Se os usuários precisarem poder filtrar, adicione um Filtro Dinâmico, por exemplo. ONDE cidade = @cidade. Cada @variable torna-se um parâmetro da API na etapa 3. Clique. Salvar e dê um nome à consulta; esse nome se tornará o nome de exibição do endpoint.

2. Crie o endpoint

   Aberto API na barra superior e clique Novo ponto finalO assistente tem quatro etapas. Selecione a consulta, Configurar, Parâmetros de bloqueio e Compartilhar. Sobre Selecione a consultaClique na consulta que você acabou de salvar; as consultas cujo agente está offline aparecem em cinza. Clique Próximo.

   API aberta

   Atalho. A partir do Construtor de Consultas, você pode expor a consulta aberta diretamente; o assistente então inicia em Configurar com a consulta já selecionada.

3. Configurar e bloquear parâmetros

   Sobre Configurar As configurações padrão estão corretas para um primeiro ponto de extremidade: Nome de exibição preenchido a partir da consulta, Vida útil Permanente (escolha) Expirando (para uma participação temporária), Modo de resposta Estático (uma resposta JSON; escolha Transmissão (para resultados que excedam o limite estático de linhas do seu plano), Formato interno JSON. O modo e o formato da resposta são fixos após a criação, portanto, defina-os aqui. Clique. Próximo.

   Sobre Parâmetros de bloqueio Todos os filtros dinâmicos na consulta são listados. Deixe como estão aqueles que os chamadores podem definir. Invocável e dê a cada um um Nome da string de consulta; marcação Obrigatório Se uma chamada sem ele falhar, fixe um valor que o chamador não deve alterar. Trancadoou um cenário de encontro como Início do mês. Escondido Mantém o valor padrão da consulta e rejeita qualquer tentativa de alterá-lo. Clique. Próximo.

4. Compartilhe e ganhe sua chave.

   Sobre Compartilhar você pode convidar Pessoas por e-mail ou adicione um Chave de serviço Para um servidor ou uma ferramenta de automação, ou ignore ambos por enquanto. Clique. Criar e obter minha chaveA tela de sucesso exibe o URL do endpoint e sua chave: uma string de 49 caracteres começando com qsapi_Copie-o. Você poderá exibi-lo novamente mais tarde a partir do ponto de extremidade. Compartilhamento aba, para que não se perca se você fechar a tela.

   Clique em Enviar no console para fazer a primeira chamada a partir do próprio portal. O painel de resposta mostra Status, Tempo e Tamanho, o Corpo A aba exibe o JSON e a chamada aparece no Atividade alguns segundos depois.

Ligue de qualquer lugar

Substitua o ID do endpoint pelo seu, que você encontra na barra de URL do console. qsapi_SUA_CHAVE com sua chave. Os parâmetros chamáveis vão na string de consulta do GET; aqui a consulta salva expõe cidade:

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

{
  "colunas": [ { "nome": "id_do_cliente", "tipo": "inteiro" }, { "nome": "nome", "tipo": "corda" }, { "nome": "cidade", "tipo": "corda" } ],
  "fileiras": [
    { "id_do_cliente": 1042, "nome": "Comerciantes do Vento Norte", "cidade": "Seattle" },
    { "id_do_cliente": 1057, "nome": "Alpine Outfitters", "cidade": "Denver" },
    { "id_do_cliente": 1063, "nome": "Alimentos do Porto", "cidade": "Halifax" }
  ],
  "meta": { "contagem_de_linhas": 3, "duração_do_agente_ms": 41, "id_da_solicitação": "req_7Hq2mKd9" }
}

As linhas retornam como objetos indexados pelo nome da coluna, com a lista de colunas e um meta Bloco que informa quantas linhas existem, se o resultado foi truncado e o ID da solicitação que você pode citar para suporte. A mesma chamada que um POST coloca os parâmetros em um corpo JSON, que é a escolha certa para longas listas 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 em vez de JSON, com linha de cabeçalho incluída. Aceitar: texto/csv faz o mesmo. Os endpoints de streaming retornam NDJSON (um objeto JSON por linha) com um final {"_summary": true, "row_count": N} linha; verifique essa última linha.

?sample=true

No máximo cinco linhas, sem cobrança. Ideal para conectar os cabos de um cliente.

?compressão=lz4

Um corpo de estrutura LZ4 para chamadas de alto volume com decodificador; o Código A aba contém o trecho de código decodificador para cada idioma. A compressão gzip simples ocorre automaticamente quando seu cliente envia o arquivo. Codificação aceita: gzip.

Autorização: Portador qsapi_…

Aceito como um pseudônimo para Chave X-APIUse-o a partir do código do navegador.

Onde ele se conecta

O que os planos permitem

Cada chamada também possui um tempo limite fixo de consulta de 60 segundos e um limite de resposta de 8 MiB, e os bytes retornados são contabilizados na sua franquia de dados mensal, a mesma franquia usada pelos suplementos do Excel e do Google Sheets. O plano gratuito inclui um endpoint e 5 MB por mês, o que é suficiente para uma pequena tabela acessada várias vezes ao dia. Consulte a página de preços. para as verbas previstas no plano.

Mantendo-o seguro

Quando algo não funciona

Cada corpo de erro tem a forma {"erro": {"código": "…", "mensagem": "…"}} e cada resposta carrega um X-QS-Request-Id Ao entrar em contato com o suporte, mencione o ID no cabeçalho.

Perguntas que as pessoas fazem

Guias relacionados

• Conecte Aiven a Claude com MCP
• API REST de banco de dados: transforme qualquer consulta SQL em um endpoint.
• API REST do Microsoft SQL Server
• API REST do PostgreSQL
• API REST do MySQL
• API REST do Snowflake