IBM Cloud Databases for PostgreSQL REST API: Zmień zapytanie SQL w punkt końcowy

REST API · IBM Cloud do punktu końcowego

Obróć Chmura IBM Zapytanie SQL do Interfejs API REST punkt końcowy

Zapisz zapytanie w Kreatorze zapytań, kliknij Nowy punkt końcowy, a Ty masz adres URL api.querystreams.com z własnym kluczem. Zapytanie SQL jest uruchamiane tylko do odczytu na agencie, który jest już połączony z bazą danych IBM Cloud; wywołujący otrzymuje plik JSON lub CSV i nigdy nie widzi zapytania SQL, schematu ani hasła. Nie ma potrzeby hostowania ani otwierania portu. Około 90 sekund od zapisania zapytania, a plan bezpłatny obejmuje pierwszy punkt końcowy.

Około 90 sekund od zapisanego zapytania Brak serwera do hostowania Poświadczenia pozostają z Tobą Jeden klucz na osobę dzwoniącą, można go odwołać w dowolnym momencie

Co z tego wyjdzie?

Adres URL pod adresem api.querystreams.com która zwraca wiersze zapisanego zapytania IBM Cloud w formacie JSON lub CSV każdemu posiadaczowi klucza, przetestowane w konsoli w portalu przed udostępnieniem. Na przykład:

{
  "miasto": „Seattle”
}

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "Klucz X-API: qsapi_TWÓJ_KLUCZ" \ -H "Typ zawartości: application/json" \ -d '{"miasto": "Seattle"}'

{
  „kolumny”: [ { "nazwa": „identyfikator_klienta”, "typ": "liczba całkowita" }, { "nazwa": "nazwa", "typ": "smyczkowy" }, { "nazwa": "miasto", "typ": "smyczkowy" } ],
  "wydziwianie": [
    { „identyfikator_klienta”: 1042, "nazwa": „Handlarze z Północnego Wiatru”, "miasto": „Seattle” },
    { „identyfikator_klienta”: 1057, "nazwa": „Alpine Outfitters”, "miasto": "Denver" },
    { „identyfikator_klienta”: 1063, "nazwa": „Harbour Foods”, "miasto": "Halifax" }
  ],
  "meta": { „liczba_wierszy”: 3, „czas_czasu_agenta_w_ms”: 41, „id_żądania”: „req_7Hq2mKd9” }
}

IBM Cloud Databases for PostgreSQL przechowuje Twoje dane w chmurze, obsługiwane przez swojego dostawcę. Ktoś inny chce mieć ich fragment w swojej aplikacji, panelu sterowania lub skrypcie, a standardowe rozwiązania przekazują zbyt wiele: logowanie do bazy danych, które nie działa już w projekcie, nocny eksport, który jest nieaktualny przed śniadaniem, czy mały serwer API, który ktoś musi teraz uruchomić i naprawić. Query Streams sprawia, że punkt końcowy to zapisane zapytanie wraz z kluczem. Agent, który jest już częścią wdrożenia IBM Cloud PostgreSQL, uruchamia zapytanie, api.querystreams.com sprawdza klucz i limit częstotliwości, a wywołujący otrzymuje wiersze. Kod SQL, schemat i dane uwierzytelniające nigdy nie opuszczają Twojego konta.

Czego będziesz potrzebować

Konto Query Streams

Każdy plan ma API REST. Wersja darmowa zapewnia jeden punkt końcowy, dwa klucze i 250 wierszy na wywołanie, co wystarcza do stworzenia tego przewodnika. Zarejestruj się na my.querystreams.com.

Agent na dowolnym komputerze stale włączonym, z dodanym połączeniem IBM Cloud

Wymaga jedynie dostępu do Internetu.

Zapisane zapytanie w Kreatorze zapytań

Punkt końcowy obejmuje dokładnie jedno zapisane zapytanie. Napisz SELECT, uruchom je raz i zapisz. Dodaj filtr dynamiczny (a @variable w klauzuli WHERE), jeśli wywołujący mają mieć możliwość filtrowania.

Skonfiguruj w czterech krokach

1. Zapisz zapytanie

   W Kreator zapytań Wybierz połączenie z chmurą IBM, wpisz instrukcję SELECT, którą chcesz opublikować, i uruchom ją raz, aby zobaczyć wiersze. Ogranicz się do kolumn potrzebnych wywołującemu; punkt końcowy zwróci dokładnie to, co zwraca zapytanie.

   Zapisane zapytanie · klienci

   SELECT customer_id, nazwa, miasto
   Z klienci publiczni
   ZAMÓWIENIE PRZEZ nazwa
   LIMIT 100;

   Jeżeli dzwoniący mają mieć możliwość filtrowania, dodaj na przykład filtr dynamiczny GDZIE miasto = @miasto. Każdy @variable staje się parametrem API w kroku 3. Kliknij Zapisz i nadaj zapytaniu nazwę, która stanie się nazwą wyświetlaną punktu końcowego.

2. Utwórz punkt końcowy

   Otwórz API na górnym pasku i kliknij Nowy punkt końcowyKreator składa się z czterech kroków, Wybierz zapytanie, Skonfiguruj, Zablokuj parametry oraz Udostępnij. NA Wybierz zapytanieKliknij zapytanie, które właśnie zapisałeś. Zapytania, których Agent jest offline, są wyszarzone. Kliknij Następny.

   Otwarte API

   Skrót. Z Kreatora zapytań możesz bezpośrednio udostępnić otwarte zapytanie; wówczas kreator uruchomi się Skonfiguruj z już wybranym zapytaniem.

3. Konfiguruj i blokuj parametry

   NA Skonfiguruj wartości domyślne są odpowiednie dla pierwszego punktu końcowego: Nazwa wyświetlana wypełnione na podstawie zapytania, Długość życia Stały (wybierz Wygasa (w celu uzyskania tymczasowego udziału), Tryb odpowiedzi Statyczny (jedna odpowiedź JSON; wybierz Transmisja strumieniowa w przypadku wyników wykraczających poza statyczny limit wierszy Twojego planu), Format wewnętrzny JSON. Tryb i format odpowiedzi są stałe po utworzeniu, więc zdecyduj o nich tutaj. Kliknij Następny.

   NA Zablokuj parametry Każdy filtr dynamiczny w zapytaniu jest wymieniony. Pozostaw te, które wywołujący mogą ustawić jako Możliwość wywołania i daj każdemu Nazwa ciągu zapytania; zaznacz Wymagany jeśli wywołanie bez niego powinno się nie powieść. Przypnij wartość, której wywołujący nie może zmienić. Zamkniętylub scenariusz randkowy, taki jak Początek miesiąca. Ukryty zachowuje domyślną wartość zapytania i odrzuca wszelkie próby jej ustawienia. Kliknij Następny.

4. Udostępnij i otrzymaj swój klucz

   NA Udostępnij możesz zaprosić Ludzie przez e-mail lub dodaj Klucz serwisowy dla serwera lub narzędzia automatyzacji, albo na razie pomiń oba. Kliknij Utwórz i pobierz mój kluczEkran powodzenia pokazuje adres URL punktu końcowego i klucz: ciąg 49 znaków rozpoczynający się od qsapi_Skopiuj to. Możesz to później ponownie wyświetlić z punktu końcowego. Udostępnianie kartę, więc nie zniknie ona po zamknięciu ekranu.

   Kliknij Wysłać w konsoli, aby wykonać pierwsze połączenie z samego portalu. Panel odpowiedzi pokazuje Status, Czas oraz Rozmiar, ten Ciało karta pokazuje JSON, a połączenie pojawia się na Działalność kartę kilka sekund później.

Zadzwoń z dowolnego miejsca

Zastąp identyfikator punktu końcowego swoim identyfikatorem z paska adresu URL konsoli i qsapi_TWÓJ_KLUCZ z Twoim kluczem. Parametry wywoływalne znajdują się w ciągu zapytania podczas GET; tutaj zapisane zapytanie ujawnia miasto:

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

{
  „kolumny”: [ { "nazwa": „identyfikator_klienta”, "typ": "liczba całkowita" }, { "nazwa": "nazwa", "typ": "smyczkowy" }, { "nazwa": "miasto", "typ": "smyczkowy" } ],
  "wydziwianie": [
    { „identyfikator_klienta”: 1042, "nazwa": „Handlarze z Północnego Wiatru”, "miasto": „Seattle” },
    { „identyfikator_klienta”: 1057, "nazwa": „Alpine Outfitters”, "miasto": "Denver" },
    { „identyfikator_klienta”: 1063, "nazwa": „Harbour Foods”, "miasto": "Halifax" }
  ],
  "meta": { „liczba_wierszy”: 3, „czas_czasu_agenta_w_ms”: 41, „id_żądania”: „req_7Hq2mKd9” }
}

Wiersze powracają jako obiekty kluczowane nazwą kolumny, z listą kolumn i meta Blok, który informuje o liczbie wierszy, o tym, czy wynik został przycięty, oraz o identyfikatorze żądania, który można podać w cudzysłowie. To samo wywołanie, co POST, umieszcza parametry w treści JSON, co jest właściwym rozwiązaniem w przypadku długich list wartości:

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "Klucz X-API: qsapi_TWÓJ_KLUCZ" \ -H "Typ zawartości: application/json" \ -d '{"parametry": {"miasto": "Seattle"}}'

?format=csv

CSV zamiast JSON, dołączony wiersz nagłówka. Akceptuj: tekst/csv robi to samo. Punkty końcowe przesyłania strumieniowego zwracają NDJSON (jeden obiekt JSON na wiersz) z końcowym {"_summary": prawda, "liczba_wierszy": N} linia; sprawdź ostatnią linię.

?sample=true

Maksymalnie pięć rzędów, bez opłat. Dobre do podłączenia klienta.

?kompresja=lz4

Obudowa LZ4 przeznaczona do połączeń o dużej głośności z dekoderem; Kod Karta zawiera fragment kodu dekodera dla każdego języka. Zwykły gzip działa automatycznie, gdy klient wysyła Akceptuj kodowanie: gzip.

Autoryzacja: Nośnik qsapi_…

Zaakceptowano jako alias dla Klucz X-API. Użyj go z kodu przeglądarki.

Gdzie się podłącza

Co pozwalają plany

Każde wywołanie ma również stały limit czasu zapytania wynoszący 60 sekund i limit odpowiedzi 8 MiB, a zwracane bajty wliczają się do miesięcznego limitu danych w ramach planu, takiego samego jak w przypadku dodatków do Excela i Arkuszy Google. Wersja darmowa ma jeden punkt końcowy i 5 MB transferu danych miesięcznie, co pozwala na wygodne wywoływanie małej tabeli wiele razy dziennie. Zobacz stronę z cennikiem dla dodatków według planu.

Dbanie o bezpieczeństwo

Kiedy coś nie działa

Każdy błąd ma kształt {"błąd": {"kod": "…", "komunikat": "…"}} a każda odpowiedź niesie ze sobą Identyfikator żądania X-QS nagłówek. Podaj identyfikator, pisząc do pomocy technicznej.

Pytania, które zadają ludzie

Powiązane przewodniki

• Połącz IBM Cloud Databases for PostgreSQL z Claude za pomocą MCP
• API REST bazy danych: zamień dowolne zapytanie SQL w punkt końcowy
• Interfejs API REST Microsoft SQL Server
• Interfejs API REST PostgreSQL
• Interfejs API REST MySQL
• API REST Snowflake