Skip to main content

Vue d’ensemble

L’API ClickHouse Cloud est une API REST conçue pour permettre aux développeurs de gérer facilement les organisations et les services sur ClickHouse Cloud. Avec notre Cloud API, vous pouvez créer et gérer des services, provisionner des clés API, ajouter ou supprimer des membres de votre organisation, et bien plus encore. Découvrez comment créer votre première clé API et commencer à utiliser l’API ClickHouse Cloud.

Point de terminaison Swagger (OpenAPI) et UI

L’API ClickHouse Cloud s’appuie sur la spécification OpenAPI open source afin de permettre une utilisation prévisible côté client. Si vous devez consulter par programmation la documentation de l’API ClickHouse Cloud, nous proposons un point de terminaison Swagger au format JSON via https://api.clickhouse.cloud/v1. Vous pouvez également accéder à la documentation de l’API via la Swagger UI.
Si votre organisation a été migrée vers l’un des nouveaux plans tarifaires et que vous utilisez OpenAPI, vous devrez supprimer le champ tier de la requête POST de création de service.Le champ tier a été supprimé de l’objet service, car nous n’avons plus de tiers de service. Cela affectera les objets renvoyés par les requêtes de service POST, GET et PATCH. Par conséquent, tout code qui utilise ces API devra peut-être être adapté pour prendre en compte ces modifications.

Limites de débit

Les développeurs peuvent créer jusqu’à 100 clés API par organisation. Chaque clé API est limitée à 10 requêtes sur une période de 10 secondes. Si vous souhaitez augmenter le nombre de clés API ou de requêtes par période de 10 secondes pour votre organisation, veuillez contacter support@clickhouse.com

Provider Terraform

Le provider Terraform officiel de ClickHouse vous permet d’utiliser l’infrastructure en tant que code pour créer des configurations prévisibles et gérées par version, afin de rendre les déploiements beaucoup moins sujets aux erreurs. Vous pouvez consulter la documentation du provider Terraform dans le registre Terraform. Si vous souhaitez contribuer au provider Terraform ClickHouse, vous pouvez consulter le code source dans le dépôt GitHub.
Si votre organisation a été migrée vers l’un des nouveaux plans tarifaires, vous devrez utiliser la version 2.0.0 ou ultérieure de notre provider Terraform ClickHouse. Cette mise à niveau est nécessaire pour prendre en charge les modifications de l’attribut tier du service, car après la migration tarifaire, le champ tier n’est plus accepté et toutes les références à celui-ci doivent être supprimées.Vous pourrez désormais également spécifier le champ num_replicas comme propriété de la ressource de service.

Releases des providers Terraform

ClickHouse maintient deux providers Terraform officiels : le provider ClickHouse Cloud pour l’infrastructure cloud et le provider DBops pour les objets au niveau de la base de données. Ils suivent tous deux le même modèle de version.

Ressources GA et Bêta

Chaque version est une build unique qui contient toutes les ressources. Les ressources correspondant à des fonctionnalités qui n’ont pas encore atteint la disponibilité générale sont livrées avec les ressources GA et marquées bêta — il n’existe pas de build distincte et rien n’est à épingler pour les utiliser. Une ressource bêta est signalée à deux endroits :
  • Lors de la planification et de l’application, par un avertissement Beta Resource. Terraform n’échoue jamais en raison d’avertissements ; l’exécution se poursuit donc normalement.
  • Dans sa documentation, par un encadré indiquant « Cette ressource est en bêta ».
Bêta signifie que le schéma et le comportement peuvent changer dans une future version du provider. Toute ressource sans ce marqueur est en GA et couverte par les garanties de compatibilité habituelles.
Avant la v3.25.2, le provider marquait ces ressources comme alpha plutôt que bêta, et l’avertissement lors de la planification indiquait Alpha Resource. Seul le libellé a changé — aucun schéma, comportement ou migration d’état n’est concerné — mais les outils qui recherchent Alpha Resource dans la sortie du plan cesseront silencieusement de trouver des correspondances. Les versions antérieures publiaient également une build alpha distincte.

Gestion des versions

Les deux providers utilisent le versionnage sémantique (MAJEUR.MINEUR.CORRECTIF). La version majeure est incrémentée en cas de breaking changes, la version mineure pour les nouvelles fonctionnalités ou ressources, et la version corrective pour les corrections de bugs. Les versions sont publiées à la demande plutôt que selon une cadence fixe. Les versions comportant le suffixe -alphaN (par ex. 3.15.0-alpha3) sont antérieures au modèle de build unique. Elles restent disponibles, mais ne sont plus produites.

Passage de la bêta à la GA

Lorsqu’une fonctionnalité atteint la disponibilité générale, la ressource correspondante perd son marqueur bêta dans la version suivante du provider : l’avertissement lors de la planification cesse de s’afficher et l’encadré de la documentation est supprimé. Rien d’autre ne change — aucune modification de configuration, aucune migration d’état et aucun basculement entre les builds.

Nouveau modèle tarifaire Terraform et OpenAPI : explication des paramètres de répliques

Le nombre de répliques avec lequel chaque service est créé est de 3 par défaut pour les tiers Scale et Enterprise, contre 1 par défaut pour le tier Basic. Pour les tiers Scale et Enterprise, il est possible de l’ajuster en transmettant un champ numReplicas dans la requête de création du service. La valeur du champ numReplicas doit être comprise entre 2 et 20 pour le premier service d’un warehouse. Les services créés dans un warehouse existant peuvent avoir seulement 1 réplique.

Assistance

Nous vous recommandons de consulter d’abord notre canal Slack pour obtenir rapidement de l’aide. Si vous souhaitez une assistance supplémentaire ou davantage d’informations sur notre API et ses fonctionnalités, veuillez contacter ClickHouse Support à l’adresse https://console.clickhouse.cloud/support
Dernière modification le 26 août 2026