API ClickHouse Cloud

En savoir plus sur l’API ClickHouse Cloud

​

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 organization 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 [e-mail]

​

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 release.

​

Stable versus alpha

Les versions stables (par ex. 3.11.1, 1.9.0) incluent uniquement des ressources pour les fonctionnalités en GA. Les versions alpha (par ex. 3.12.0-alpha2, 1.10.0-alpha1) incluent tout ce qui est présent dans les versions stables, ainsi que des ressources pour les fonctionnalités encore en bêta ou en private preview, et doivent être explicitement épinglées pour être utilisées.

​

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 alpha ajoutent un suffixe de préversion à la prochaine version mineure (par ex. 3.12.0-alpha1), le numéro alpha étant incrémenté à mesure que des correctifs ou modifications supplémentaires sont ajoutés avant la promotion (par ex. alpha1 → alpha2 → alpha3). Les releases sont publiées à la demande plutôt que selon une cadence fixe. Une nouvelle version alpha est créée lorsqu’une ressource est ajoutée pour une fonctionnalité qui n’est pas encore GA, ou lorsqu’un correctif nécessite une validation anticipée. Une nouvelle version stable est créée une fois que les changements accumulés — y compris les fonctionnalités qui ont depuis atteint le stade GA — sont prêts pour la production, généralement après une période de retours clients. Plusieurs versions mineures alpha peuvent s’accumuler avant d’être regroupées dans une seule release stable.

​

Passage d’alpha à stable

Lorsqu’une fonctionnalité Terraform est prête pour la GA, la ressource Terraform passe d’alpha à stable dans la prochaine release stable. D’ici là, la ressource n’est disponible que dans les builds alpha.

​

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