ClickHouse Cloud API

Узнайте о ClickHouse Cloud API

​

Обзор

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 секунд для вашей организации, пожалуйста, обратитесь в службу поддержки [e-mail]

​

Terraform-провайдер

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

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

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

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

Теперь вы также сможете указывать поле num_replicas как свойство ресурса сервиса.

​

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

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

​

Стабильные и альфа-версии

Стабильные версии (например, 3.11.1, 1.9.0) включают только ресурсы для возможностей со статусом GA. Альфа-версии (например, 3.12.0-alpha2, 1.10.0-alpha1) включают всё, что есть в стабильных версиях, а также ресурсы для возможностей, которые всё ещё находятся в статусе бета или закрытой предварительной версии, и для их использования версию нужно явно зафиксировать.

​

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

Оба провайдера используют семантическое версионирование (MAJOR.MINOR.PATCH). Мажорная версия увеличивается при обратно несовместимых изменениях, минорная — при добавлении новых возможностей или ресурсов, а патч-версия — при исправлении ошибок. Для альфа-выпусков к следующей минорной версии добавляется суффикс предрелизной версии (например, 3.12.0-alpha1), при этом номер alpha увеличивается по мере внесения дополнительных исправлений или изменений до перевода в стабильный статус (например, alpha1 → alpha2 → alpha3). Релизы выпускаются по мере необходимости, а не по фиксированному расписанию. Новый альфа-выпуск создаётся, когда для возможности, ещё не достигшей стадии GA, добавляется ресурс, либо когда исправление требует ранней проверки. Новый стабильный выпуск создаётся, когда накопленные изменения — включая все возможности, которые к этому моменту достигли стадии GA, — готовы к использованию в продакшене, обычно после периода сбора отзывов от клиентов. До объединения в один стабильный выпуск может накопиться несколько минорных альфа-версий.

​

Переход из альфа в стабильный

Когда возможность Terraform готова к GA, ресурс Terraform переводится из альфа в стабильный в следующем стабильном релизе. До этого ресурс доступен только в альфа-сборках.

​

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

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

​

Поддержка

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