Criar novo serviço - ClickHouse Documentation

POST

organizations

{organizationId}

services

Criar novo serviço

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
}

Autorizações

Authorization

string

header

obrigatório

Use o ID da chave e o segredo da chave obtidos no ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Parâmetros de caminho

organizationId

string<uuid>

obrigatório

ID da organização proprietária do service.

Corpo

application/json

backupId

string<uuid>

ID opcional de backup usado como estado inicial para o novo serviço. Quando usado, a região e o tier da nova instância devem ser os mesmos da instância original.

byocId

string

Este é o ID retornado após configurar uma região para Bring Your Own Cloud (BYOC). Quando o parâmetro byocId é especificado, os parâmetros minReplicaMemoryGb e maxReplicaGb também são obrigatórios, com valores entre os seguintes tamanhos: 48, 116, 172, 232.

complianceType

enum<string>

Tipo de conformidade regulatória do serviço.

Opções disponíveis:

hipaa,

pci

dataWarehouseId

string

Warehouse de dados que contém este serviço

encryptionAssumedRoleIdentifier

string

Papel opcional a ser usado para criptografia de disco

encryptionKey

string

Chave opcional de criptografia de disco fornecida pelo cliente

endpoints

object[]

Lista de endpoints do serviço para habilitar ou desabilitar

Show child attributes

hasTransparentDataEncryption

boolean

True se o serviço deve ter o Transparent Data Encryption (TDE) habilitado. O TDE está disponível apenas para tiers de organizations ENTERPRISE e só pode ser habilitado na criação do serviço.

idleScaling

boolean

Quando definido como true, o serviço pode ser reduzido a zero quando estiver ocioso. True por padrão.

idleTimeoutMinutes

number

Define o tempo limite mínimo de ociosidade (em minutos). Deve ser >= 5 minutos.

ipAccessList

object[]

Lista de endereços IP com permissão para acessar o serviço

Show child attributes

isReadonly

boolean

True se este serviço for somente leitura. Ele só pode ser somente leitura se um dataWarehouseId for fornecido.

maxReplicaMemoryGb

number

Memória total máxima de cada réplica durante o escalonamento automático em Gb. Deve ser um múltiplo de 4 e menor ou igual a 120* para serviços não pagos ou 356* para serviços pagos.* - o tamanho máximo da réplica está sujeito à disponibilidade de hardware do provedor de Cloud na região selecionada.

Intervalo obrigatório: 8 <= x <= 356Deve ser um múltiplo de 4

Exemplo:

120

maxTotalMemoryGb

number

obsoleto

DEPRECATED - impreciso para serviços com números não padrão de réplicas. Memória máxima de três workers durante o escalonamento automático em Gb. Disponível apenas para serviços 'production'. Deve ser um múltiplo de 12 e menor ou igual a 360 para serviços não pagos ou 1068 para serviços pagos.

Intervalo obrigatório: 24 <= x <= 1068Deve ser um múltiplo de 12

Exemplo:

360

minReplicaMemoryGb

number

Memória total mínima de cada réplica durante o escalonamento automático em Gb. Deve ser um múltiplo de 4 e maior ou igual a 8.

Intervalo obrigatório: 8 <= x <= 356Deve ser um múltiplo de 4

Exemplo:

16

minTotalMemoryGb

number

obsoleto

DEPRECATED - impreciso para serviços com números não padrão de réplicas. Memória mínima de três workers durante o escalonamento automático em Gb. Disponível apenas para serviços 'production'. Deve ser um múltiplo de 12 e maior ou igual a 24.

Intervalo obrigatório: 24 <= x <= 1068Deve ser um múltiplo de 12

Exemplo:

48

name

string

Nome do serviço. Sequência alfanumérica com espaços em branco de até 50 caracteres.

numReplicas

number

Número de réplicas do serviço. O número de réplicas deve estar entre 2 e 20 para o primeiro serviço em um warehouse. Serviços criados em um warehouse existente podem ter apenas 1 réplica. Restrições adicionais podem ser aplicadas com base no tier da sua organização. O padrão é 1 para o tier BASIC e 3 para os tiers SCALE e ENTERPRISE.

Intervalo obrigatório: 1 <= x <= 20

Exemplo:

3

privateEndpointIds

string[]

obsoleto

Para associar o serviço a endpoints privados, primeiro crie o serviço e depois use o endpoint Update Service Basic Details para modificar os endpoints privados.

privatePreviewTermsChecked

boolean

Aceite os termos e condições da private preview. Isso só é necessário ao criar o primeiro serviço na organização no caso de uma private preview

profile

enum<string>

Perfil de instância personalizado. Disponível apenas para tiers de organização ENTERPRISE.

Opções disponíveis:

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>

provedor de Cloud

Opções disponíveis:

aws,

gcp,

azure

region

enum<string>

Região do serviço.

Opções disponíveis:

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>

Selecione fast se quiser receber novas versões do ClickHouse assim que estiverem disponíveis. Você receberá novos recursos mais rapidamente, mas com maior risco de bugs. Selecione slow se quiser adiar as releases para ter mais tempo para testar. Este recurso está disponível apenas para serviços de production. O padrão é o regular release channel.

Opções disponíveis:

slow,

default,

fast

tier

enum<string>

obsoleto

DEPRECATED para os tiers de organização BASIC, SCALE e ENTERPRISE. Tier do serviço: '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'. Os serviços Production têm escalonamento, enquanto os de Development têm tamanho fixo. Os serviços do Azure não oferecem suporte ao tier Development

Opções disponíveis:

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

Resposta

Resposta bem-sucedida

requestId

string<uuid>

ID único atribuído a cada solicitação. UUIDv4

result

object

Show child attributes

status

number

Código de status HTTP.

Exemplo:

200

Última modificação em 10 de junho de 2026

Obter detalhes do serviçoRetorna um service que pertence à organização

Criar novo serviço

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
}