Découvrez comment appeler les API ApsaraDB for ClickHouse à l'aide d'OpenAPI Explorer, des SDK Alibaba Cloud et d'autres méthodes d'intégration.
OpenAPI
OpenAPI Explorer est une plateforme tout-en-un permettant de rechercher des API, d'accéder à la documentation, de déboguer en ligne, d'obtenir des exemples de code SDK, de diagnostiquer les erreurs et de consulter les statistiques d'appels. Utilisez cet outil pour appeler et tester les API des services Alibaba Cloud. Qu'est-ce qu'OpenAPI ?
Versions
Chaque édition de cluster ApsaraDB for ClickHouse utilise une version d'API différente. Sélectionnez la version correspondant à votre édition.
|
Numéro de version |
Description |
|
2019-11-11 |
Utilisez cette version pour appeler les API des clusters de l'édition compatible avec la communauté. |
|
2023-05-22 |
Utilisez cette version pour appeler les API des clusters de l'édition Enterprise. |
Débogage en ligne
Déboguez les API ApsaraDB for ClickHouse dans OpenAPI Explorer. Avant d'effectuer des appels, examinez les versions d'API, les endpoints et les méthodes d'intégration pour ApsaraDB for ClickHouse.
Le volet de gauche répertorie les catégories d'API telles que Region management, Cluster management et Compute group management. Sélectionnez une API pour afficher sa description, configurez des paramètres tels que ZoneId et RegionId, puis cliquez sur Initiate Call pour la tester. Le volet de droite affiche les descriptions des paramètres et des exemples de valeurs.
URL de débogage des API
ApsaraDB for ClickHouse est disponible en édition compatible avec la communauté et édition Enterprise. Chaque édition dispose d'une URL de débogage distincte.
|
Édition |
URL de débogage des API |
|
Édition compatible avec la communauté |
URL de débogage des API pour ApsaraDB for ClickHouse (édition compatible avec la communauté) |
|
Édition Enterprise |
URL de débogage des API pour ApsaraDB for ClickHouse (édition Enterprise) |
Endpoints
Pour minimiser la latence, sélectionnez un endpoint situé dans la même région que vos ressources. Par exemple, pour un cluster ApsaraDB for ClickHouse dans la région Chine (Zhangjiakou), l'endpoint public est clickhouse.cn-zhangjiakou.aliyuncs.com et l'endpoint VPC est clickhouse-vpc.cn-zhangjiakou.aliyuncs.com.
Les endpoints publics sont accessibles au niveau mondial.
-
Les endpoints VPC s'exécutent sur un réseau virtuel isolé et offrent les avantages suivants :
Sécurité accrue : accessibles uniquement depuis le VPC.
Latence réduite : réseau interne, non affecté par les fluctuations du réseau public.
Coût inférieur : le trafic interne réduit les coûts de transfert de données.
Toutes les régions et tous les endpoints pris en charge sont répertoriés dans la section Endpoints de service.
Identités utilisateur prises en charge
Par défaut, OpenAPI Explorer utilise votre compte connecté pour le débogage. Étant donné qu'un compte Alibaba Cloud dispose de toutes les autorisations API, utilisez un utilisateur RAM doté des autorisations minimales requises pour l'accès aux API et les opérations quotidiennes. Accordez à l'utilisateur RAM les autorisations nécessaires pour gérer ApsaraDB for ClickHouse. Autorisation RAM.
|
Identité |
Prise en charge |
|
Oui |
|
|
Utilisateur RAM (Recommandé) |
Oui |
|
Rôle RAM (Recommandé) |
Oui |
Méthodes d'intégration
ApsaraDB for ClickHouse prend en charge plusieurs méthodes d'intégration : SDK Alibaba Cloud, Terraform, Resource Orchestration Service (ROS) et encapsulation personnalisée.
Les SDK simplifient l'intégration et constituent la méthode recommandée pour appeler OpenAPI.
|
Méthode d'intégration |
Prise en charge |
|
SDK Alibaba Cloud |
Oui |
|
CLI Alibaba Cloud |
Non pris en charge |
|
Terraform |
Non pris en charge |
|
Resource Orchestration Service (ROS) |
Prise en charge partielle |
|
Encapsulation personnalisée |
Oui |
SDK Alibaba Cloud
Les SDK Alibaba Cloud prennent en charge Java, C#, Go, Python, Node.js, TypeScript, PHP et C++. Les SDK gèrent l'authentification et la signature, ce qui vous permet d'appeler directement les API. SDK Alibaba Cloud.
Vous pouvez utiliser un SDK Alibaba Cloud pour appeler les API ApsaraDB for ClickHouse. Les langages pris en charge et les étapes d'installation figurent dans la section Vue d'ensemble du SDK ApsaraDB for ClickHouse.
CLI Alibaba Cloud
La CLI Alibaba Cloud vous permet de gérer les ressources cloud depuis un shell à l'aide de la commande
aliyun. Qu'est-ce que la CLI Alibaba Cloud ?.Vous ne pouvez pas utiliser la CLI Alibaba Cloud pour appeler les API ApsaraDB for ClickHouse.
Terraform
Terraform est un outil open source permettant de provisionner et de gérer l'infrastructure cloud via des modèles. Qu'est-ce qu'Alibaba Cloud Terraform ?.
Vous ne pouvez pas utiliser Terraform pour orchestrer les API ApsaraDB for ClickHouse.
Resource Orchestration Service (ROS)
ROS automatise le provisionnement des ressources cloud via des modèles. Définissez des ressources telles que les instances ECS et RDS avec leurs dépendances, et ROS les crée et les configure automatiquement. Qu'est-ce que Resource Orchestration Service ?.
Vous pouvez utiliser ROS pour appeler les API ApsaraDB for ClickHouse. Les types de ressources et sources de données pris en charge sont répertoriés dans la section Liste des ressources ROS.
Encapsulation personnalisée
Pour les appels HTTP natifs, implémentez l'algorithme de signature V3 et construisez les requêtes manuellement. Corps de la requête et mécanisme de signature pour V3.
Notes d'utilisation
Si un appel d'API renvoie une erreur, vérifiez vos paramètres de requête dans le Centre des codes d'erreur.
Utilisez le RequestID ou le message d'erreur du SDK issu de la réponse pour diagnostiquer les problèmes sur la Plateforme de diagnostic OpenAPI Alibaba Cloud.