Skip to main content

​
Обзор

ClickHouse Cloud API — это REST API, созданный для того, чтобы разработчики могли легко управлять организациями и сервисами в ClickHouse Cloud. С помощью Cloud API можно создавать сервисы и управлять ими, выпускать ключи API, а также добавлять и удалять участников организации и выполнять другие действия. Узнайте, как создать свой первый ключ API и начать использовать ClickHouse Cloud API.

​
Конечная точка Swagger (OpenAPI) и интерфейс

ClickHouse Cloud API построен на основе спецификации OpenAPI с открытым исходным кодом (OpenAPI specification), что обеспечивает предсказуемую интеграцию на стороне клиента. Если вам нужно программно работать с документацией ClickHouse Cloud API, мы предоставляем JSON-конечную точку Swagger по адресу https://api.clickhouse.cloud/v1. Документация API также доступна через интерфейс Swagger UI.
Если ваша организация была переведена на один из новых тарифных планов и вы используете OpenAPI, вам необходимо удалить поле tier из POST-запроса на создание сервиса.Поле tier было удалено из объекта сервиса, поскольку уровней сервиса больше нет. Это затронет объекты, возвращаемые запросами к сервису POST, GET и PATCH. Поэтому любой код, использующий эти API, может потребовать доработки с учетом этих изменений.

​
Лимиты запросов

Для разработчиков действует ограничение: не более 100 ключей API на организацию. Для каждого ключа API установлен лимит — 10 запросов за 10 секунд. Если вы хотите увеличить количество ключей API или число запросов за 10 секунд для вашей организации, пожалуйста, обратитесь в службу поддержки support@clickhouse.com

​
Terraform-провайдер

Официальный Terraform-провайдер ClickHouse позволяет использовать инфраструктуру как код для создания предсказуемых, версионируемых конфигураций, что значительно снижает вероятность ошибок при развертывании. Документацию по Terraform-провайдеру можно посмотреть в реестре Terraform. Если вы хотите внести вклад в Terraform-провайдер ClickHouse, исходный код можно посмотреть в репозитории GitHub.
Если ваша организация была переведена на один из новых тарифных планов, вам потребуется использовать наш Terraform-провайдер ClickHouse версии 2.0.0 или выше. Это обновление необходимо, чтобы учесть изменения в атрибуте tier сервиса: после миграции на новую модель тарификации поле tier больше не поддерживается, и все ссылки на него следует удалить.Теперь вы также сможете указывать поле num_replicas как свойство ресурса сервиса.

​
Релизы Terraform-провайдера

ClickHouse поддерживает два официальных Terraform-провайдера - провайдер ClickHouse Cloud для облачной инфраструктуры и провайдер DBops для объектов на уровне базы данных. Оба используют одну и ту же модель выпуска релизов.

​
Ресурсы GA и бета

Каждый релиз — это единая сборка, включающая все ресурсы. Ресурсы для возможностей, ещё не достигших статуса общая доступность, поставляются вместе с ресурсами GA и помечаются как бета — отдельной сборки нет, и для их использования ничего закреплять не нужно. Бета-ресурс обозначается в двух местах:
  • При выполнении plan и apply — предупреждением Beta Resource. Terraform никогда не завершается сбоем из-за предупреждений, поэтому выполнение продолжается в обычном режиме.
  • В документации — выноской «Этот ресурс находится в бета-версии».
Бета означает, что схема и поведение могут измениться в будущей версии провайдера. Всё без этой метки имеет статус GA и подпадает под обычные гарантии совместимости.
До v3.25.2 провайдер помечал эти ресурсы как альфа, а не как бета, а предупреждение при выполнении plan имело вид Alpha Resource. Изменилась только формулировка — схема, поведение и миграция состояния не затрагиваются, — однако инструменты, ищущие Alpha Resource в выводе plan, перестанут находить совпадения без каких-либо уведомлений. В более ранних релизах также публиковалась отдельная альфа-сборка.

​
Версионирование

Оба провайдера используют семантическое версионирование (MAJOR.MINOR.PATCH). Мажорная версия увеличивается при обратно несовместимых изменениях, минорная — при добавлении новых возможностей или ресурсов, а патч-версия — при исправлении ошибок. Релизы выпускаются по мере необходимости, а не по фиксированному расписанию. Версии с суффиксом -alphaN (например, 3.15.0-alpha3) относятся к периоду до модели единой сборки. Они по-прежнему доступны, но больше не выпускаются.

​
Переход из бета-версии в GA

Когда возможность достигает стадии общей доступности, в следующем релизе провайдера с соответствующего ресурса снимается маркер бета: предупреждение на этапе планирования перестаёт отображаться, а примечание в документации удаляется. Больше ничего не меняется — не нужно редактировать конфигурацию, выполнять миграцию состояния или переключаться между сборками.

​
Terraform и OpenAPI: новая модель ценообразования — пояснение по настройкам реплик

По умолчанию каждый сервис создается с 3 репликами для уровней Scale и Enterprise и с 1 репликой для уровня Basic. Для уровней Scale и Enterprise это значение можно изменить, передав поле numReplicas в запросе на создание сервиса. Значение поля numReplicas должно быть от 2 до 20 для первого сервиса в хранилище. Сервисы, создаваемые в существующем хранилище, могут иметь всего 1 реплику.

​
Поддержка

Мы рекомендуем сначала зайти в наш канал Slack, чтобы быстро получить помощь. Если вам нужна дополнительная помощь или более подробная информация о нашем API и его возможностях, пожалуйста, свяжитесь с ClickHouse Support по адресу https://console.clickhouse.cloud/support
Последнее изменение 26 августа 2026 г.