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

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

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

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

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

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

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

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

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

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

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

Настройка API-конечной точки запроса​

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

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

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

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

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

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

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

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

Описание​

Этот маршрут выполняет запрос на указанной конечной точке запроса. Он поддерживает различные версии, форматы и переменные запроса. Ответ может быть потоковым (только версия 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: