Crear un nuevo servicio - ClickHouse Documentation

POST

organizations

{organizationId}

services

Crear un nuevo servicio

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "backupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "byocId": "<string>",
  "dataWarehouseId": "<string>",
  "encryptionAssumedRoleIdentifier": "<string>",
  "encryptionKey": "<string>",
  "endpoints": [
    {
      "enabled": true,
      "protocol": "mysql"
    }
  ],
  "hasTransparentDataEncryption": true,
  "idleScaling": true,
  "idleTimeoutMinutes": 123,
  "ipAccessList": [
    {
      "description": "<string>",
      "source": "<string>"
    }
  ],
  "isReadonly": true,
  "maxReplicaMemoryGb": 120,
  "maxTotalMemoryGb": 360,
  "minReplicaMemoryGb": 16,
  "minTotalMemoryGb": 48,
  "name": "<string>",
  "numReplicas": 3,
  "privateEndpointIds": [
    "<string>"
  ],
  "privatePreviewTermsChecked": true
}
'

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "password": "<string>",
    "service": {
      "availablePrivateEndpointIds": [
        "<string>"
      ],
      "byocId": "<string>",
      "clickhouseVersion": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "dataWarehouseId": "<string>",
      "encryptionAssumedRoleIdentifier": "<string>",
      "encryptionKey": "<string>",
      "encryptionRoleId": "<string>",
      "endpoints": [
        {
          "host": "<string>",
          "port": 123,
          "protocol": "mysql",
          "username": "<string>"
        }
      ],
      "hasTransparentDataEncryption": true,
      "iamRole": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "idleScaling": true,
      "idleTimeoutMinutes": 123,
      "ipAccessList": [
        {
          "description": "<string>",
          "source": "<string>"
        }
      ],
      "isPrimary": true,
      "isReadonly": true,
      "maxReplicaMemoryGb": 120,
      "maxTotalMemoryGb": 360,
      "minReplicaMemoryGb": 16,
      "minTotalMemoryGb": 48,
      "name": "<string>",
      "numReplicas": 3,
      "privateEndpointIds": [
        "<string>"
      ],
      "transparentDataEncryptionKeyId": "<string>"
    }
  },
  "status": 200
}

Autorizaciones

Authorization

string

header

requerido

Usa el ID y el secreto de la clave obtenidos en la consola de ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi

Parámetros de ruta

organizationId

string<uuid>

requerido

ID de la organización propietaria del servicio.

Cuerpo

application/json

backupId

string<uuid>

ID de Backup opcional usado como estado inicial para el nuevo servicio. Cuando se usa, la región y el tier de la nueva instancia deben ser iguales a los valores de la instancia original.

byocId

string

Este es el ID que se devuelve después de configurar una región para Bring Your Own Cloud (BYOC). Cuando se especifica el parámetro byocId, también son obligatorios los parámetros minReplicaMemoryGb y maxReplicaGb, con valores incluidos entre los siguientes tamaños: 48, 116, 172, 232.

complianceType

enum<string>

Tipo de cumplimiento normativo del servicio.

Opciones disponibles:

hipaa,

pci

dataWarehouseId

string

Data warehouse que contiene este servicio

encryptionAssumedRoleIdentifier

string

Role opcional que se usará para el cifrado de disco

encryptionKey

string

Clave de cifrado de disco opcional proporcionada por el cliente

endpoints

object[]

Lista de endpoints del servicio para habilitar o deshabilitar

Show child attributes

hasTransparentDataEncryption

boolean

True si el servicio debe tener habilitado Transparent Data Encryption (TDE). TDE solo está disponible para los tiers de organización ENTERPRISE y solo se puede habilitar al crear el servicio.

idleScaling

boolean

Cuando se establece en true, el servicio puede escalar hasta cero cuando está inactivo. True de forma predeterminada.

idleTimeoutMinutes

number

Establezca el timeout mínimo de inactividad (en minutos). Debe ser >= 5 minutos.

ipAccessList

object[]

Lista de direcciones IP permitidas para acceder al servicio

Show child attributes

isReadonly

boolean

True si este servicio es de solo lectura. Solo puede ser de solo lectura si se proporciona un dataWarehouseId.

maxReplicaMemoryGb

number

Memoria total máxima de cada réplica durante el autoescalado en Gb. Debe ser un múltiplo de 4 y menor o igual que 120* para servicios no de pago o 356* para servicios de pago.* - el tamaño máximo de la réplica está sujeto a la disponibilidad de hardware del proveedor de Cloud en la región seleccionada.

Rango requerido: 8 <= x <= 356Debe ser un múltiplo de 4

Ejemplo:

120

maxTotalMemoryGb

number

obsoleto

DEPRECATED: impreciso para servicios con un número de réplicas distinto del predeterminado. Memoria máxima de tres workers durante el autoescalado en Gb. Disponible solo para servicios 'production'. Debe ser un múltiplo de 12 y menor o igual que 360 para servicios no de pago o 1068 para servicios de pago.

Rango requerido: 24 <= x <= 1068Debe ser un múltiplo de 12

Ejemplo:

360

minReplicaMemoryGb

number

Memoria total mínima de cada réplica durante el autoescalado en Gb. Debe ser un múltiplo de 4 y mayor o igual que 8.

Rango requerido: 8 <= x <= 356Debe ser un múltiplo de 4

Ejemplo:

16

minTotalMemoryGb

number

obsoleto

DEPRECATED: impreciso para servicios con un número de réplicas distinto del predeterminado. Memoria mínima de tres workers durante el autoescalado en Gb. Disponible solo para servicios 'production'. Debe ser un múltiplo de 12 y mayor o igual que 24.

Rango requerido: 24 <= x <= 1068Debe ser un múltiplo de 12

Ejemplo:

48

name

string

Nombre del servicio. Cadena alfanumérica con espacios de hasta 50 caracteres.

numReplicas

number

Número de réplicas del servicio. El número de réplicas debe estar entre 2 y 20 para el primer servicio de un warehouse. Los servicios que se crean en un warehouse existente pueden tener tan solo 1 réplica. Pueden aplicarse restricciones adicionales según el tier de su organización. El valor predeterminado es 1 para el tier BASIC y 3 para los tiers SCALE y ENTERPRISE.

Rango requerido: 1 <= x <= 20

Ejemplo:

3

privateEndpointIds

string[]

obsoleto

Para asociar el servicio con private endpoints, primero cree el servicio y luego use el endpoint Update Service Basic Details para modificar los private endpoints.

privatePreviewTermsChecked

boolean

Acepte los terms and conditions de la private preview. Solo es necesario al crear el primer servicio de la organización en caso de private preview

profile

enum<string>

Perfil de instancia personalizado. Solo disponible para los tiers de organización ENTERPRISE.

Opciones disponibles:

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>

Proveedor de Cloud

Opciones disponibles:

aws,

gcp,

azure

region

enum<string>

Región del servicio.

Opciones disponibles:

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>

Seleccione fast si quiere recibir las nuevas ClickHouse releases en cuanto estén disponibles. Recibirá nuevas funciones más rápido, pero con un mayor riesgo de errores. Seleccione slow si desea posponer las releases para disponer de más tiempo para probarlas. Esta función solo está disponible para servicios 'production'. El valor predeterminado es el regular release channel.

Opciones disponibles:

slow,

default,

fast

tier

enum<string>

obsoleto

DEPRECATED para los tiers de organización BASIC, SCALE y ENTERPRISE. Tier del servicio: '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'. Los servicios Production escalan; los Development tienen un tamaño fijo. Los servicios de Azure no admiten el tier Development

Opciones disponibles:

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

Respuesta

Respuesta satisfactoria

requestId

string<uuid>

ID único asignado a cada solicitud. UUIDv4

result

object

Show child attributes

status

number

Código de estado HTTP.

Ejemplo:

200

Última modificación el 10 de junio de 2026

Obtener los detalles del servicioDevuelve un servicio que pertenece a la organización.

Crear un nuevo servicio

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "backupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "byocId": "<string>",
  "dataWarehouseId": "<string>",
  "encryptionAssumedRoleIdentifier": "<string>",
  "encryptionKey": "<string>",
  "endpoints": [
    {
      "enabled": true,
      "protocol": "mysql"
    }
  ],
  "hasTransparentDataEncryption": true,
  "idleScaling": true,
  "idleTimeoutMinutes": 123,
  "ipAccessList": [
    {
      "description": "<string>",
      "source": "<string>"
    }
  ],
  "isReadonly": true,
  "maxReplicaMemoryGb": 120,
  "maxTotalMemoryGb": 360,
  "minReplicaMemoryGb": 16,
  "minTotalMemoryGb": 48,
  "name": "<string>",
  "numReplicas": 3,
  "privateEndpointIds": [
    "<string>"
  ],
  "privatePreviewTermsChecked": true
}
'

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "password": "<string>",
    "service": {
      "availablePrivateEndpointIds": [
        "<string>"
      ],
      "byocId": "<string>",
      "clickhouseVersion": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "dataWarehouseId": "<string>",
      "encryptionAssumedRoleIdentifier": "<string>",
      "encryptionKey": "<string>",
      "encryptionRoleId": "<string>",
      "endpoints": [
        {
          "host": "<string>",
          "port": 123,
          "protocol": "mysql",
          "username": "<string>"
        }
      ],
      "hasTransparentDataEncryption": true,
      "iamRole": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "idleScaling": true,
      "idleTimeoutMinutes": 123,
      "ipAccessList": [
        {
          "description": "<string>",
          "source": "<string>"
        }
      ],
      "isPrimary": true,
      "isReadonly": true,
      "maxReplicaMemoryGb": 120,
      "maxTotalMemoryGb": 360,
      "minReplicaMemoryGb": 16,
      "minTotalMemoryGb": 48,
      "name": "<string>",
      "numReplicas": 3,
      "privateEndpointIds": [
        "<string>"
      ],
      "transparentDataEncryptionKeyId": "<string>"
    }
  },
  "status": 200
}