> ## Documentation Index > Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-1d264819.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Создать новый сервис > Создаёт новый сервис в организации и возвращает текущее состояние сервиса и пароль для доступа к нему. Сервис запускается асинхронно. ## OpenAPI ````yaml /ru/products/cloud/api-reference/cloud-openapi.json post /v1/organizations/{organizationId}/services openapi: 3.0.1 info: contact: email: support@clickhouse.com name: ClickHouse Support url: >- https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-299828 title: OpenAPI spec for ClickHouse Cloud version: '1.0' servers: - url: https://api.clickhouse.cloud security: - basicAuth: [] tags: - name: Organization - name: User management - name: Billing - name: Service - name: Backup - name: OpenAPI - name: Prometheus - name: ClickPipes paths: /v1/organizations/{organizationId}/services: post: tags: - Service summary: Создать новый сервис description: >- Создаёт новый сервис в организации и возвращает текущее состояние сервиса и пароль для доступа к нему. Сервис запускается асинхронно. parameters: - description: ID организации, которой будет принадлежать сервис. in: path name: organizationId required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ServicePostRequest' responses: '200': content: application/json: schema: properties: requestId: description: Уникальный ID, присваиваемый каждому запросу. UUIDv4 format: uuid type: string result: $ref: '#/components/schemas/ServicePostResponse' status: description: Код состояния HTTP. example: 200 type: number type: object description: Успешный ответ '400': content: application/json: schema: properties: error: description: Подробное описание ошибки. type: string status: description: Код состояния HTTP. example: 400 type: number type: object description: >- Сервер не может или не будет обрабатывать запрос из-за того, что он считается ошибочным со стороны клиента. components: schemas: ServicePostRequest: properties: backupId: description: >- Необязательный идентификатор резервной копии, используемый в качестве начального состояния для нового сервиса. При его использовании регион и уровень нового экземпляра должны совпадать со значениями исходного экземпляра. format: uuid type: string byocId: description: >- Это идентификатор, возвращаемый после настройки региона для модели Собственное облако (BYOC). Если указан параметр byocId, параметры minReplicaMemoryGb и maxReplicaGb также обязательны, причем их значения должны быть выбраны из следующих размеров: 48, 116, 172, 232. type: string complianceType: description: Тип регуляторного соответствия для сервиса. enum: - hipaa - pci type: string dataWarehouseId: description: Хранилище данных, в котором находится этот сервис type: string encryptionAssumedRoleIdentifier: description: Необязательная роль, используемая для шифрования диска type: string encryptionKey: description: Необязательный предоставленный клиентом ключ шифрования диска type: string endpoints: description: Список конечных точек сервиса, которые нужно включить или отключить items: $ref: '#/components/schemas/ServiceEndpointChange' type: array hasTransparentDataEncryption: description: >- True, если для сервиса должно быть включено Transparent Data Encryption (TDE). TDE доступно только для уровней организаций ENTERPRISE и может быть включено только при создании сервиса. type: boolean idleScaling: description: >- Если установлено значение true, сервису разрешено масштабироваться до нуля в период бездействия. По умолчанию — true. type: boolean idleTimeoutMinutes: description: >- Задает минимальный тайм-аут бездействия (в минутах). Должен быть >= 5 минут. type: number ipAccessList: description: Список IP-адресов, которым разрешен доступ к сервису items: $ref: '#/components/schemas/IpAccessListEntry' type: array isReadonly: description: >- True, если этот сервис только для чтения. Он может быть только для чтения, только если указан dataWarehouseId. type: boolean maxReplicaMemoryGb: description: >- Максимальный общий объем памяти каждой реплики при автомасштабировании в ГБ. Должен быть кратен 4 и меньше либо равен 120* для бесплатных сервисов или 356* для платных сервисов.* — максимальный размер реплики зависит от доступности оборудования у облачного провайдера в выбранном регионе. example: 120 maximum: 356 minimum: 8 multipleOf: 4 type: number maxTotalMemoryGb: deprecated: true description: >- УСТАРЕЛО — неточно для сервисов с количеством реплик, отличным от значения по умолчанию. Максимальный объем памяти трех воркеров при автомасштабировании в ГБ. Доступно только для сервисов 'production'. Должно быть кратно 12 и меньше либо равно 360 для бесплатных сервисов или 1068 для платных сервисов. example: 360 maximum: 1068 minimum: 24 multipleOf: 12 type: number minReplicaMemoryGb: description: >- Минимальный общий объем памяти каждой реплики при автомасштабировании в ГБ. Должен быть кратен 4 и больше либо равен 8. example: 16 maximum: 356 minimum: 8 multipleOf: 4 type: number minTotalMemoryGb: deprecated: true description: >- УСТАРЕЛО — неточно для сервисов с количеством реплик, отличным от значения по умолчанию. Минимальный объем памяти трех воркеров при автомасштабировании в ГБ. Доступно только для сервисов 'production'. Должно быть кратно 12 и больше либо равно 24. example: 48 maximum: 1068 minimum: 24 multipleOf: 12 type: number name: description: >- Название сервиса. Буквенно-цифровая строка с пробелами длиной до 50 символов. type: string numReplicas: description: >- Количество реплик для сервиса. Количество реплик должно быть от 2 до 20 для первого сервиса в хранилище. Сервисы, создаваемые в существующем хранилище, могут иметь количество реплик от 1. В зависимости от уровня вашей организации могут применяться дополнительные ограничения. По умолчанию используется 1 для уровня BASIC и 3 для уровней SCALE и ENTERPRISE. example: 3 maximum: 20 minimum: 1 type: number privateEndpointIds: deprecated: true description: >- Чтобы связать сервис с частными конечными точками, сначала создайте сервис, затем используйте эндпоинт `Update Service Basic Details`, чтобы изменить частные конечные точки. items: type: string type: array privatePreviewTermsChecked: description: >- Примите условия закрытой предварительной версии. Это требуется только при создании первого сервиса в организации в случае закрытой предварительной версии type: boolean profile: description: >- Пользовательский профиль инстанса. Доступно только для организаций уровня ENTERPRISE. enum: - 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 type: string provider: description: Облачный провайдер enum: - aws - gcp - azure type: string region: description: Регион сервиса. enum: - 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 type: string releaseChannel: description: >- Выберите fast, если хотите получать новые релизы ClickHouse сразу после их выхода. Новые возможности будут доступны быстрее, но с более высоким риском ошибок. Выберите slow, если хотите отложить получение релизов, чтобы оставить себе больше времени на тестирование. Эта возможность доступна только для сервисов production. По умолчанию используется обычный канал релизов. enum: - slow - default - fast type: string tier: deprecated: true description: >- УСТАРЕЛО для уровней организаций 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 enum: - 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 type: string ServicePostResponse: properties: password: description: Пароль для вновь созданного сервиса. type: string service: $ref: '#/components/schemas/Service' ServiceEndpointChange: properties: enabled: description: Включение или отключение конечной точки type: boolean protocol: description: Протокол конечной точки enum: - mysql example: mysql type: string IpAccessListEntry: properties: description: description: >- Необязательное описание IPv4-адреса или IPv4 CIDR, с которого разрешён доступ type: string source: description: IP-адрес или CIDR type: string Service: properties: availablePrivateEndpointIds: description: >- Список идентификаторов доступных частных конечных точек, которые можно подключить к сервису items: type: string type: array byocId: description: >- Это идентификатор, возвращаемый после настройки региона для Собственное облако (BYOC). Если указан параметр byocId, также обязательны параметры minReplicaMemoryGb и maxReplicaGb, причем их значения должны быть выбраны из следующих размеров: 48, 116, 172, 232. type: string clickhouseVersion: description: Версия ClickHouse для сервиса. type: string complianceType: description: Тип регуляторного соответствия для сервиса. enum: - hipaa - pci type: string createdAt: description: Временная метка создания сервиса. ISO-8601. format: date-time type: string dataWarehouseId: description: Хранилище данных, содержащее этот сервис type: string encryptionAssumedRoleIdentifier: description: Необязательная роль для шифрования диска type: string encryptionKey: description: Необязательный предоставленный клиентом ключ шифрования диска type: string encryptionRoleId: description: >- Идентификатор роли IAM, используемой для шифрования. Доступно только если hasTransparentDataEncryption имеет значение true. type: string endpoints: description: Список всех конечных точек сервиса. items: $ref: '#/components/schemas/ServiceEndpoint' type: array hasTransparentDataEncryption: description: >- True, если для сервиса должно быть включено Transparent Data Encryption (TDE). TDE доступно только для уровней организации ENTERPRISE и может быть включено только при создании сервиса. type: boolean iamRole: description: Роль IAM, используемая для доступа к объектам в S3 type: string id: description: Уникальный идентификатор сервиса. format: uuid type: string idleScaling: description: >- Если установлено значение true, сервису разрешено масштабироваться до нуля в состоянии бездействия. По умолчанию — true. type: boolean idleTimeoutMinutes: description: >- Установите минимальный тайм-аут перехода в режим бездействия (в минутах). Должен быть >= 5 минут. type: number ipAccessList: description: Список IP-адресов, которым разрешен доступ к сервису items: $ref: '#/components/schemas/IpAccessListEntry' type: array isPrimary: description: True, если этот сервис является основным сервисом в хранилище данных type: boolean isReadonly: description: >- True, если этот сервис доступен только для чтения. Он может быть доступен только для чтения, только если указан dataWarehouseId. type: boolean maxReplicaMemoryGb: description: >- Максимальный общий объем памяти каждой реплики при автомасштабировании в ГБ. Значение должно быть кратно 4 и не превышать 120* для бесплатных сервисов или 356* для платных сервисов. * — максимальный размер реплики зависит от доступности оборудования у облачного провайдера в выбранном регионе. example: 120 maximum: 356 minimum: 8 multipleOf: 4 type: number maxTotalMemoryGb: deprecated: true description: >- УСТАРЕЛО — неточно для сервисов с количеством реплик, отличным от значения по умолчанию. Максимальный объем памяти трех воркеров при автомасштабировании в ГБ. Доступно только для сервисов 'production'. Значение должно быть кратно 12 и не превышать 360 для бесплатных сервисов или 1068 для платных сервисов. example: 360 maximum: 1068 minimum: 24 multipleOf: 12 type: number minReplicaMemoryGb: description: >- Минимальный общий объем памяти каждой реплики при автомасштабировании в ГБ. Значение должно быть кратно 4 и быть не меньше 8. example: 16 maximum: 356 minimum: 8 multipleOf: 4 type: number minTotalMemoryGb: deprecated: true description: >- УСТАРЕЛО — неточно для сервисов с количеством реплик, отличным от значения по умолчанию. Минимальный объем памяти трех воркеров при автомасштабировании в ГБ. Доступно только для сервисов 'production'. Значение должно быть кратно 12 и быть не меньше 24. example: 48 maximum: 1068 minimum: 24 multipleOf: 12 type: number name: description: >- Имя сервиса. Буквенно-цифровая строка с пробелами длиной до 50 символов. type: string numReplicas: description: >- Количество реплик для сервиса. Для первого сервиса в хранилище число реплик должно быть от 2 до 20. Сервисы, создаваемые в существующем хранилище, могут иметь всего 1 реплику. В зависимости от уровня вашей организации могут действовать дополнительные ограничения. По умолчанию используется 1 для уровня BASIC и 3 для уровней SCALE и ENTERPRISE. example: 3 maximum: 20 minimum: 1 type: number privateEndpointIds: description: Список частных конечных точек items: type: string type: array profile: description: >- Пользовательский профиль экземпляра. Доступно только для уровней организации ENTERPRISE. enum: - 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 type: string provider: description: Облачный провайдер enum: - aws - gcp - azure type: string region: description: Регион сервиса. enum: - 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 type: string releaseChannel: description: >- Выберите fast, если хотите получать новые релизы ClickHouse сразу после их выхода. Вы быстрее получите новые возможности, но с более высоким риском ошибок. Выберите slow, если хотите отложить получение релизов, чтобы у вас было больше времени на тестирование. Эта возможность доступна только для сервисов production. По умолчанию используется regular release channel. enum: - slow - default - fast type: string state: description: Текущее состояние сервиса. enum: - starting - stopping - terminating - awaking - partially_running - provisioning - running - stopped - terminated - degraded - failed - idle type: string tier: deprecated: true description: >- УСТАРЕЛО для уровней организации 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 enum: - 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 type: string transparentDataEncryptionKeyId: description: >- Идентификатор ключа Transparent Data Encryption, используемого для сервиса. Доступно только если hasTransparentDataEncryption имеет значение true. type: string ServiceEndpoint: properties: host: description: Имя хоста сервиса type: string port: description: Номер порта type: number protocol: description: 'Протокол конечной точки: ''https'', ''nativesecure'', ''mysql''.' enum: - https - nativesecure - mysql example: mysql type: string username: description: Необязательное имя пользователя для конечной точки nullable: true type: string securitySchemes: basicAuth: description: >- Используйте идентификатор ключа и секрет ключа, полученные в консоли ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi scheme: basic type: http ````