Эндпоинты Query API

Легко создавайте REST 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:

1. ​

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

   1. Перейдите в ClickHouse Cloud Console → Organization → API Keys

   2. Нажмите Edit рядом с ключом API, который используется для эндпоинтов Query API
2. ​

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

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

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

Руководство

Инструкции по быстрой настройке эндпоинтов Query API см. в руководстве по эндпоинтам Query API