Перейти к основному содержанию
POST
Создать новый сервис

Авторизации

Authorization
string
header
обязательно

Используйте идентификатор ключа и секрет ключа, полученные в консоли ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi

Параметры пути

organizationId
string<uuid>
обязательно

ID организации, которой будет принадлежать сервис.

Тело

application/json
backupId
string<uuid>

Необязательный идентификатор резервной копии, используемый в качестве начального состояния для нового сервиса. При его использовании регион и уровень нового экземпляра должны совпадать со значениями исходного экземпляра.

byocId
string

Это идентификатор, возвращаемый после настройки региона для модели Собственное облако (BYOC). Если указан параметр byocId, параметры minReplicaMemoryGb и maxReplicaGb также обязательны, причем их значения должны быть выбраны из следующих размеров: 48, 116, 172, 232.

complianceType
enum<string>

Тип регуляторного соответствия для сервиса.

Доступные опции:
hipaa,
pci
dataWarehouseId
string

Хранилище данных, в котором находится этот сервис

encryptionAssumedRoleIdentifier
string

Необязательная роль, используемая для шифрования диска

encryptionKey
string

Необязательный предоставленный клиентом ключ шифрования диска

endpoints
object[]

Список конечных точек сервиса, которые нужно включить или отключить

hasTransparentDataEncryption
boolean

True, если для сервиса должно быть включено Transparent Data Encryption (TDE). TDE доступно только для уровней организаций ENTERPRISE и может быть включено только при создании сервиса.

idleScaling
boolean

Если установлено значение true, сервису разрешено масштабироваться до нуля в период бездействия. По умолчанию — true.

idleTimeoutMinutes
number

Задает минимальный тайм-аут бездействия (в минутах). Должен быть >= 5 минут.

ipAccessList
object[]

Список IP-адресов, которым разрешен доступ к сервису

isReadonly
boolean

True, если этот сервис только для чтения. Он может быть только для чтения, только если указан dataWarehouseId.

maxReplicaMemoryGb
number

Максимальный общий объем памяти каждой реплики при автомасштабировании в ГБ. Должен быть кратен 4 и меньше либо равен 120* для бесплатных сервисов или 356* для платных сервисов.* — максимальный размер реплики зависит от доступности оборудования у облачного провайдера в выбранном регионе.

Требуемый диапазон: 8 <= x <= 356Должно быть кратно 4
Пример:

120

maxTotalMemoryGb
number
устарело

УСТАРЕЛО — неточно для сервисов с количеством реплик, отличным от значения по умолчанию. Максимальный объем памяти трех воркеров при автомасштабировании в ГБ. Доступно только для сервисов 'production'. Должно быть кратно 12 и меньше либо равно 360 для бесплатных сервисов или 1068 для платных сервисов.

Требуемый диапазон: 24 <= x <= 1068Должно быть кратно 12
Пример:

360

minReplicaMemoryGb
number

Минимальный общий объем памяти каждой реплики при автомасштабировании в ГБ. Должен быть кратен 4 и больше либо равен 8.

Требуемый диапазон: 8 <= x <= 356Должно быть кратно 4
Пример:

16

minTotalMemoryGb
number
устарело

УСТАРЕЛО — неточно для сервисов с количеством реплик, отличным от значения по умолчанию. Минимальный объем памяти трех воркеров при автомасштабировании в ГБ. Доступно только для сервисов 'production'. Должно быть кратно 12 и больше либо равно 24.

Требуемый диапазон: 24 <= x <= 1068Должно быть кратно 12
Пример:

48

name
string

Название сервиса. Буквенно-цифровая строка с пробелами длиной до 50 символов.

numReplicas
number

Количество реплик для сервиса. Количество реплик должно быть от 2 до 20 для первого сервиса в хранилище. Сервисы, создаваемые в существующем хранилище, могут иметь количество реплик от 1. В зависимости от уровня вашей организации могут применяться дополнительные ограничения. По умолчанию используется 1 для уровня BASIC и 3 для уровней SCALE и ENTERPRISE.

Требуемый диапазон: 1 <= x <= 20
Пример:

3

privateEndpointIds
string[]
устарело

Чтобы связать сервис с частными конечными точками, сначала создайте сервис, затем используйте эндпоинт Update Service Basic Details, чтобы изменить частные конечные точки.

privatePreviewTermsChecked
boolean

Примите условия закрытой предварительной версии. Это требуется только при создании первого сервиса в организации в случае закрытой предварительной версии

profile
enum<string>

Пользовательский профиль инстанса. Доступно только для организаций уровня ENTERPRISE.

Доступные опции:
v1-default,
v1-highmem-xs,
v1-highmem-s,
v1-highmem-m,
v1-highmem-l,
v1-highmem-xl,
v1-highcpu-s,
v1-highcpu-m,
v1-highcpu-l,
v1-highcpu-xl
provider
enum<string>

Облачный провайдер

Доступные опции:
aws,
gcp,
azure
region
enum<string>

Регион сервиса.

Доступные опции:
ap-northeast-1,
ap-south-1,
ap-southeast-1,
ap-southeast-2,
eu-central-1,
eu-west-1,
eu-west-2,
me-central-1,
us-east-1,
us-east-2,
us-west-2,
us-east1,
us-central1,
europe-west4,
asia-southeast1,
eastus,
eastus2,
westus3,
germanywestcentral
releaseChannel
enum<string>

Выберите fast, если хотите получать новые релизы ClickHouse сразу после их выхода. Новые возможности будут доступны быстрее, но с более высоким риском ошибок. Выберите slow, если хотите отложить получение релизов, чтобы оставить себе больше времени на тестирование. Эта возможность доступна только для сервисов production. По умолчанию используется обычный канал релизов.

Доступные опции:
slow,
default,
fast
tier
enum<string>
устарело

УСТАРЕЛО для уровней организаций BASIC, SCALE и ENTERPRISE. Уровень сервиса: 'development', 'production', 'dedicated_high_mem', 'dedicated_high_cpu', 'dedicated_standard', 'dedicated_standard_n2d_standard_4', 'dedicated_standard_n2d_standard_8', 'dedicated_standard_n2d_standard_32', 'dedicated_standard_n2d_standard_128', 'dedicated_standard_n2d_standard_32_16SSD', 'dedicated_standard_n2d_standard_64_24SSD'. Сервисы Production поддерживают масштабирование, а Development имеют фиксированный размер. Сервисы Azure не поддерживают уровень Development

Доступные опции:
development,
production,
dedicated_high_mem,
dedicated_high_cpu,
dedicated_standard,
dedicated_standard_n2d_standard_4,
dedicated_standard_n2d_standard_8,
dedicated_standard_n2d_standard_32,
dedicated_standard_n2d_standard_128,
dedicated_standard_n2d_standard_32_16SSD,
dedicated_standard_n2d_standard_64_24SSD

Ответ

Успешный ответ

requestId
string<uuid>

Уникальный ID, присваиваемый каждому запросу. UUIDv4

result
object
status
number

Код состояния HTTP.

Пример:

200

Последнее изменение 19 июня 2026 г.