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

Конечные точки API запросов

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

Руководство по быстрому началу​

Перед тем, как приступить, убедитесь, что у вас есть API-ключ и роль администратора. Вы можете следовать этому руководству, чтобы создать API-ключ.

Создание сохраненного запроса​

Если у вас уже есть сохраненный запрос, вы можете пропустить этот шаг.

Откройте новую вкладку запроса. Для демонстрационных целей мы будем использовать датасет youtube, который содержит примерно 4.5 миллиарда записей. В качестве примерного запроса мы вернем 10 лучших загрузчиков по среднему количеству просмотров на видео в параметре year, введенном пользователем:

Обратите внимание, что этот запрос содержит параметр (year). Редактор запросов SQL в консоли автоматически обнаруживает выражения параметров запроса ClickHouse и предоставляет ввод для каждого параметра. Давайте быстро запустим этот запрос, чтобы убедиться, что он работает:

Следующий шаг — сохранить запрос:

Больше документации о сохраненных запросах можно найти здесь.

Конфигурация конечной точки API запроса​

Конечные точки API запросов можно настраивать непосредственно из представления запроса, нажав кнопку Share и выбрав API Endpoint. Вам будет предложено указать, какие API-ключи должны иметь доступ к конечной точке:

После выбора API-ключа конечная точка API запроса будет автоматически обеспечена. Будет отображена примерная команда curl, чтобы вы могли отправить тестовый запрос:

Параметры API запроса​

Параметры запроса в запросе могут быть указаны синтаксисом {parameter_name: type}. Эти параметры будут автоматически обнаружены, и примерный запрос будет содержать объект queryVariables, через который вы можете передавать эти параметры.

Тестирование и мониторинг​

После создания конечной точки API запроса вы можете протестировать ее работу, используя curl или любой другой HTTP-клиент:

После того как вы отправите свой первый запрос, новая кнопка должна сразу появиться справа от кнопки Share. Нажатие на нее откроет всплывающее окно с данными мониторинга о запросе:

Детали реализации​

Описание​

Этот маршрут выполняет запрос на указанной конечной точке запроса. Он поддерживает различные версии, форматы и переменные запроса. Ответ может быть передан в потоковом режиме (только версия 2) или возвращен как единый пакет.

Аутентификация​

  • Обязательно: Да
  • Метод: Базовая аутентификация через OpenAPI Key/Secret
  • Разрешения: Соответствующие разрешения для конечной точки запроса.

Параметры URL​

  • queryEndpointId (обязательно): Уникальный идентификатор конечной точки запроса, который нужно выполнить.

Параметры запроса​

V1​

Нет

V2​

  • format (необязательно): Формат ответа. Поддерживает все форматы, поддерживаемые ClickHouse.
  • param_:name Переменные запроса, которые будут использоваться в запросе. name должен соответствовать имени переменной в запросе. Это следует использовать только в случае, если тело запроса является потоком.
  • :clickhouse_setting Любая поддерживаемая настройка ClickHouse может быть передана как параметр запроса.

Заголовки​

  • x-clickhouse-endpoint-version (необязательно): Версия конечной точки запроса. Поддерживаемые версии: 1 и 2. Если не указана, используется последняя сохраненная версия для конечной точки.
  • x-clickhouse-endpoint-upgrade (необязательно): Установите этот заголовок, чтобы обновить версию конечной точки. Это работает в сочетании с заголовком x-clickhouse-endpoint-version.

Тело запроса​

  • queryVariables (необязательно): Объект, содержащий переменные, которые будут использоваться в запросе.
  • format (необязательно): Формат ответа. Если конечная точка API запроса версии 2, возможно использование любого поддерживаемого ClickHouse формата. Поддерживаемые форматы для v1:
    • TabSeparated
    • TabSeparatedWithNames
    • TabSeparatedWithNamesAndTypes
    • JSON
    • JSONEachRow
    • CSV
    • CSVWithNames
    • CSVWithNamesAndTypes

Ответы​

  • 200 OK: Запрос был успешно выполнен.
  • 400 Bad Request: Запрос был неправильно сформулирован.
  • 401 Unauthorized: Запрос был выполнен без аутентификации или с недостаточными разрешениями.
  • 404 Not Found: Указанная конечная точка запроса не найдена.

Обработка ошибок​

  • Убедитесь, что запрос содержит действительные учетные данные для аутентификации.
  • Проверьте queryEndpointId и queryVariables, чтобы убедиться, что они правильные.
  • Обработайте любые ошибки сервера корректно, возвращая соответствующие сообщения об ошибках.

Обновление версии конечной точки​

Чтобы обновить версию конечной точки с v1 на v2, включите заголовок x-clickhouse-endpoint-upgrade в запрос и установите его значение на 1. Это запустит процесс обновления и позволит вам использовать функции и улучшения, доступные в v2.

Примеры​

Основной запрос​

SQL конечной точки API запроса:

Версия 1​

cURL:

JavaScript:

Ответ:

Версия 2​

cURL:

JavaScript:

Ответ:

Запрос с переменными запроса и версией 2 в формате JSONCompactEachRow​

SQL конечной точки API запроса:

cURL:

JavaScript:

Ответ:

Запрос с массивом в переменных запроса, который вставляет данные в таблицу​

SQL таблицы:

SQL конечной точки API запроса:

cURL:

JavaScript:

Ответ:

Запрос с настройкой ClickHouse max_threads, установленной на 8​

SQL конечной точки API запроса:

cURL:

JavaScript:

Запрос и разбор ответа как поток​

SQL конечной точки API запроса:

Typescript:

Вывод

Вставка потока из файла в таблицу​

создайте файл ./samples/my_first_table_2024-07-11.csv с следующим содержимым:

SQL для создания таблицы:

SQL конечной точки API запроса:

cURL: