ClickHouse Cloud API

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

Узнайте, как создать свой первый ключ API и начать использовать ClickHouse Cloud API.

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

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

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

Документацию по Terraform-провайдеру можно посмотреть в реестре Terraform.

Если вы хотите внести вклад в Terraform-провайдер ClickHouse, исходный код можно посмотреть в репозитории GitHub.

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

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

Бета-ресурс обозначается в двух местах:

• При выполнении plan и apply — предупреждением Beta Resource. Terraform никогда не завершается сбоем из-за предупреждений, поэтому выполнение продолжается в обычном режиме.
• В документации — выноской «Этот ресурс находится в бета-версии».

Бета означает, что схема и поведение могут измениться в будущей версии провайдера. Всё без этой метки имеет статус GA и подпадает под обычные гарантии совместимости.

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

Версии с суффиксом -alphaN (например, 3.15.0-alpha3) относятся к периоду до модели единой сборки. Они по-прежнему доступны, но больше не выпускаются.

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

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

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