> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-detect-table-modification.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse Cloud API

> Узнайте о ClickHouse Cloud API

<div id="overview">
  ## Обзор
</div>

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

[Узнайте, как создать свой первый ключ API и начать использовать ClickHouse Cloud API.](/ru/products/cloud/features/admin-features/api/openapi)

<div id="swagger-openapi-endpoint-and-ui">
  ## Конечная точка Swagger (OpenAPI) и интерфейс
</div>

ClickHouse Cloud API построен на основе спецификации OpenAPI с открытым исходным кодом ([OpenAPI specification](https://www.openapis.org/)),
что обеспечивает предсказуемую интеграцию на стороне клиента. Если вам нужно программно
работать с документацией ClickHouse Cloud API, мы предоставляем JSON-конечную точку Swagger
по адресу [https://api.clickhouse.cloud/v1](https://api.clickhouse.cloud/v1). Документация API также доступна через
[интерфейс Swagger UI](/ru/products/cloud/api-reference/organization/get-list-of-available-organizations).

<Note>
  Если ваша организация была переведена на один из [новых тарифных планов](https://clickhouse.com/pricing?plan=scale\&provider=aws\&region=us-east-1\&hours=8\&storageCompressed=false) и вы используете OpenAPI, вам необходимо удалить поле `tier` из `POST`-запроса на создание сервиса.

  Поле `tier` было удалено из объекта сервиса, поскольку уровней сервиса больше нет.
  Это затронет объекты, возвращаемые запросами к сервису `POST`, `GET` и `PATCH`. Поэтому любой код, использующий эти API, может потребовать доработки с учетом этих изменений.
</Note>

<div id="rate-limits">
  ## Лимиты запросов
</div>

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

<div id="terraform-provider">
  ## Terraform-провайдер
</div>

Официальный Terraform-провайдер ClickHouse позволяет использовать [инфраструктуру как код](https://www.redhat.com/en/topics/automation/what-is-infrastructure-as-code-iac)
для создания предсказуемых, версионируемых конфигураций, что значительно снижает
вероятность ошибок при развертывании.

Документацию по Terraform-провайдеру можно посмотреть в [реестре Terraform](https://registry.terraform.io/providers/ClickHouse/clickhouse/latest/docs).

Если вы хотите внести вклад в Terraform-провайдер ClickHouse, исходный код можно посмотреть
[в репозитории GitHub](https://github.com/ClickHouse/terraform-provider-clickhouse).

<Note>
  Если ваша организация была переведена на один из [новых тарифных планов](https://clickhouse.com/pricing?plan=scale\&provider=aws\&region=us-east-1\&hours=8\&storageCompressed=false), вам потребуется использовать наш [Terraform-провайдер ClickHouse](https://registry.terraform.io/providers/ClickHouse/clickhouse/latest/docs) версии 2.0.0 или выше. Это обновление необходимо, чтобы учесть изменения в атрибуте `tier` сервиса: после миграции на новую модель тарификации поле `tier` больше не поддерживается, и все ссылки на него следует удалить.

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

<div id="terraform-provider-releases">
  ## Релизы Terraform-провайдера
</div>

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

<div id="ga-vs-beta-resources">
  ### Ресурсы GA и бета
</div>

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

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

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

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

<Note>
  До v3.25.2 провайдер помечал эти ресурсы как *альфа*, а не как *бета*, а предупреждение при выполнении plan имело вид `Alpha Resource`. Изменилась только формулировка — схема, поведение и миграция состояния не затрагиваются, — однако инструменты, ищущие `Alpha Resource` в выводе plan, перестанут находить совпадения без каких-либо уведомлений. В более ранних релизах также публиковалась отдельная альфа-сборка.
</Note>

<div id="versioning">
  ### Версионирование
</div>

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

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

<div id="promotion">
  ### Переход из бета-версии в GA
</div>

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

<div id="terraform-and-openapi-new-pricing---replica-settings-explained">
  ## Terraform и OpenAPI: новая модель ценообразования — пояснение по настройкам реплик
</div>

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

<div id="support">
  ## Поддержка
</div>

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