Перейти к основному содержимому
Перейти к основному содержимому

Конечные точки Query API

Создание интерактивных приложений, основанных на данных, требует не только быстрой базы данных, хорошо структурированных данных и оптимизированных запросов. Вашим фронтендам и микросервисам также нужен простой способ получать данные, возвращаемые этими запросами, желательно через хорошо структурированные API.

Функция конечных точек Query API позволяет создавать конечную точку API напрямую из любого сохранённого SQL‑запроса в консоли ClickHouse Cloud. Вы сможете обращаться к конечным точкам API по HTTP, чтобы выполнять сохранённые запросы без необходимости подключаться к вашему сервису ClickHouse Cloud через нативный драйвер.

Контроль доступа по IP

Эндпоинты Query API учитывают белые списки IP-адресов на уровне API-ключа. Аналогично SQL Console, эндпоинты Query API проксируют запросы из инфраструктуры ClickHouse, поэтому настройки белого списка IP на уровне сервиса не применяются.

Чтобы ограничить клиентов, которые могут вызывать ваши эндпоинты Query API:

Откройте настройки API-ключа

  1. Перейдите в ClickHouse Cloud Console → OrganizationAPI Keys
API Keys
  1. Нажмите Edit рядом с API-ключом, который используется для эндпоинтов Query API
Edit

Добавьте разрешённые IP-адреса

  1. В разделе Allow access to this API Key выберите Specific locations
  2. Введите IP-адреса или CIDR-диапазоны (например, 203.0.113.1 или 203.0.113.0/24)
  3. При необходимости добавьте несколько записей
Specific locations

Для создания эндпоинтов Query API требуется роль Admin Console и API-ключ с соответствующими правами.

Совет

См. руководство по эндпоинтам Query API с инструкциями по настройке эндпоинтов Query API всего за несколько простых шагов