Skip to main content

​
Visão geral

A ClickHouse Cloud API é uma API REST desenvolvida para que desenvolvedores gerenciem com facilidade organizações e serviços no ClickHouse Cloud. Usando nossa Cloud API, você pode criar e gerenciar serviços, gerar API keys e adicionar ou remover membros da sua organização, entre outras ações. Saiba como criar sua primeira API key e começar a usar a ClickHouse Cloud API.

​
Endpoint e UI do Swagger (OpenAPI)

A ClickHouse Cloud API é baseada na especificação OpenAPI de código aberto para permitir um consumo previsível por clientes. Se você precisar consumir programaticamente a documentação da ClickHouse Cloud API, oferecemos um endpoint Swagger baseado em JSON em https://api.clickhouse.cloud/v1. Você também pode acessar a documentação da API pela Swagger UI.
Se a sua organização tiver sido migrada para um dos novos planos de preços e você usar OpenAPI, será necessário remover o campo tier da requisição POST de criação do serviço.O campo tier foi removido do objeto de serviço, pois não há mais tiers de serviço. Isso afetará os objetos retornados pelas requisições de serviço POST, GET e PATCH. Portanto, qualquer código que consuma essas APIs talvez precise ser ajustado para lidar com essas mudanças.

​
Limites de taxa

Os desenvolvedores podem ter até 100 API keys por organização. Cada API key tem um limite de 10 solicitações por intervalo de 10 segundos. Se você quiser aumentar o número de API keys ou de solicitações por intervalo de 10 segundos para a sua organização, entre em contato com o suporte em support@clickhouse.com

​
Terraform provider

O ClickHouse Terraform Provider oficial permite usar Infraestrutura como Código para criar configurações previsíveis e versionadas, tornando as implantações muito menos sujeitas a erros. Você pode consultar a documentação do Terraform provider no Terraform registry. Se quiser contribuir com o ClickHouse Terraform Provider, você pode consultar o código-fonte no repositório do GitHub.
Se a sua organização tiver sido migrada para um dos novos planos de preços, será necessário usar a versão 2.0.0 ou superior do nosso ClickHouse Terraform provider. Essa atualização é necessária para lidar com as mudanças no atributo tier do serviço, pois, após a migração de preços, o campo tier não é mais aceito e as referências a ele devem ser removidas.Agora você também poderá especificar o campo num_replicas como uma propriedade do recurso de serviço.

​
Lançamentos dos providers Terraform

A ClickHouse mantém dois providers oficiais do Terraform - o provider ClickHouse Cloud para infraestrutura em nuvem e o provider DBops para objetos em nível de banco de dados. Ambos seguem o mesmo modelo de lançamento.

​
Recursos GA versus Beta

Cada lançamento consiste em uma única compilação que contém todos os recursos. Os recursos de funcionalidades que ainda não atingiram a disponibilidade geral são distribuídos junto com os recursos GA, marcados como beta — não há uma compilação separada nem nada a fixar para usá-los. Um recurso beta é indicado em dois lugares:
  • Durante o plano e a aplicação, como um aviso Beta Resource. O Terraform nunca falha devido a avisos, portanto a execução prossegue normalmente.
  • Na documentação, com um destaque que diz “Este recurso está em beta”.
Beta significa que o schema e o comportamento podem mudar em uma versão futura do provider. Tudo que não tiver esse marcador é GA e está coberto pelas garantias habituais de compatibilidade.
Antes da v3.25.2, o provider marcava esses recursos como alpha em vez de beta, e o aviso durante o plano era Alpha Resource. Apenas a redação mudou — não há schema, comportamento nem migração de estado envolvidos —, mas ferramentas que usam grep na saída do plano em busca de Alpha Resource deixarão de encontrar correspondências silenciosamente. Lançamentos anteriores também publicavam uma compilação alpha separada.

​
Versionamento

Ambos os providers usam versionamento semântico (MAJOR.MINOR.PATCH). A versão major é incrementada em caso de mudanças incompatíveis, a versão minor para novos recursos ou funcionalidades, e a versão patch para correções de bugs. Os lançamentos são gerados sob demanda, em vez de seguirem um cronograma fixo. Versões com o sufixo -alphaN (por exemplo, 3.15.0-alpha3) são anteriores ao modelo de compilação única. Elas continuam disponíveis, mas não são mais produzidas.

​
Promoção de beta para GA

Quando um recurso atinge a disponibilidade geral, ele deixa de ter o marcador beta no próximo lançamento do provider: o aviso no momento do plano deixa de ser exibido, e o destaque na documentação é removido. Nada mais muda — não há edições de configuração, migração de estado nem alternância entre compilações.

​
Terraform e OpenAPI New Pricing: Configurações de réplica explicadas

O número de réplicas com que cada serviço será criado é, por padrão, 3 para os tiers Scale e Enterprise, enquanto para o tier Basic o padrão é 1. Para os tiers Scale e Enterprise, é possível ajustá-lo informando o campo numReplicas na solicitação de criação do serviço. O valor do campo numReplicas deve estar entre 2 e 20 para o primeiro serviço em um warehouse. Services criados em um warehouse existente podem ter apenas 1 réplica.

​
Suporte

Recomendamos acessar nosso canal no Slack primeiro para obter suporte mais rapidamente. Se você quiser ajuda adicional ou mais informações sobre nossa API e suas funcionalidades, entre em contato com o suporte do ClickHouse em https://console.clickhouse.cloud/support
Última modificação em 26 de agosto de 2026