Cette rubrique décrit les principes de base de l'utilisation de l'OpenAPI ApsaraDB for HBase.
Vue d'ensemble de l'OpenAPI
Alibaba Cloud met à votre disposition le portail OpenAPI pour vous aider à utiliser l'OpenAPI efficacement. Ce portail est une solution complète qui intègre des fonctionnalités telles que la recherche intelligente d'API, la documentation, le débogage en ligne, le téléchargement de SDK, des exemples de code, le diagnostic des erreurs d'appel et les statistiques d'appels. Depuis le portail OpenAPI, vous pouvez appeler les opérations OpenAPI de divers produits Alibaba Cloud et consulter les requêtes ainsi que les réponses. Le portail génère également automatiquement des exemples de code SDK pour vous permettre de démarrer rapidement. Pour plus d'informations, consultez Qu'est-ce qu'OpenAPI.
Versions
L'OpenAPI Alibaba Cloud utilise des numéros de version pour gérer les API destinées aux clusters ApsaraDB for HBase dotés d'architectures différentes. Voici les versions d'API prises en charge par ApsaraDB for HBase.
|
Version |
Description |
|
2019-01-01 |
Utilisez cette version pour appeler les opérations d'API pour tous les clusters ApsaraDB for HBase. |
Débogage en ligne
ApsaraDB for HBase propose des fonctionnalités telles que le débogage d'API dans le portail OpenAPI. Avant d'effectuer un appel, vous devez connaître certaines informations, notamment les versions, les descriptions des endpoints et les méthodes d'intégration fournies par ApsaraDB for HBase.
Sur la page du portail OpenAPI, le volet de gauche contient l'arborescence de navigation des API avec des catégories telles que les régions de service, les clusters, les instances, la sécurité et les sauvegardes. Le panneau de débogage se trouve au centre ; vous pouvez y sélectionner une adresse de service, configurer les paramètres de requête tels que AcceptLanguage et Engine, puis cliquez sur Initiate Call. Le volet de droite affiche la documentation, y compris les descriptions des paramètres de requête et de réponse, ainsi que des exemples de SDK et de CLI.
Portail de débogage
Pour accéder au portail de débogage d'API de ApsaraDB for HBase, consultez Portail de débogage d'API.
Endpoints
Afin de minimiser la latence, sélectionnez un endpoint situé dans la même région que vos ressources. Par exemple, l'endpoint VPC dans la région Chine (Qingdao) est hbase.aliyuncs.com.
Les endpoints publics sont accessibles à l'échelle mondiale.
-
Un Virtual Private Cloud (VPC) est un réseau virtuel isolé. Les avantages de l'utilisation d'un endpoint VPC sont les suivants :
Sécurité accrue : les endpoints VPC sont accessibles uniquement au sein d'un VPC, ce qui renforce la sécurité.
Temps de réponse plus rapides : les endpoints VPC fonctionnent au sein du réseau interne d'un VPC, ce qui permet généralement d'obtenir des réponses plus rapides et d'éviter la latence du réseau public.
Coûts réduits : les endpoints VPC utilisent la communication via le réseau interne.
Pour plus d'informations, reportez-vous à la structure de requête.
Identités utilisateur
Lorsque vous vous connectez au portail OpenAPI, celui-ci utilise par défaut votre compte actuel pour le débogage en ligne. Étant donné qu'un compte Alibaba Cloud dispose des autorisations nécessaires pour accéder à toutes les API, son utilisation pour le débogage présente un risque de sécurité élevé. Nous vous recommandons de ne pas utiliser votre compte Alibaba Cloud pour le débogage en ligne. Il est préférable de créer et d'utiliser un utilisateur RAM pour l'accès aux API et les opérations quotidiennes d'O&M. Avant d'appeler des opérations d'API, accordez à l'utilisateur RAM uniquement les autorisations requises. L'utilisateur RAM doit disposer de l'autorisation de gérer ApsaraDB for HBase. Pour plus d'informations, consultez Créer des politiques d'autorisation RAM personnalisées.
|
Identité utilisateur |
Prise en charge |
|
Pris en charge |
|
|
Utilisateur RAM (Recommandé) |
Pris en charge |
|
Rôle RAM (Recommandé) |
Pris en charge |
Méthodes d'intégration
ApsaraDB for HBase propose plusieurs méthodes d'intégration, notamment les SDK Alibaba Cloud et l'encapsulation personnalisée. Choisissez la méthode la mieux adaptée à vos besoins métier.
Les SDK sont faciles à intégrer et constituent la méthode recommandée pour appeler les opérations OpenAPI.
|
Méthode d'intégration |
Prise en charge |
|
SDK Alibaba Cloud |
Pris en charge |
|
CLI Alibaba Cloud |
Pris en charge |
|
Terraform |
Pris en charge |
|
Resource Orchestration Service (ROS) |
Pris en charge |
|
Encapsulation personnalisée |
Pris en charge |
SDK Alibaba Cloud
Alibaba Cloud fournit des SDK dans divers langages de programmation, tels que Java, C#, Go, Python, PHP et C++. Ces SDK gèrent les détails sous-jacents des appels d'API, tels que l'identité, l'authentification et les règles de signature. Il vous suffit d'intégrer un SDK pour appeler directement les opérations OpenAPI. Pour plus d'informations sur les SDK Alibaba Cloud, consultez SDK Alibaba Cloud.
Vous pouvez utiliser les SDK Alibaba Cloud pour appeler les opérations OpenAPI de ApsaraDB for HBase. Pour connaître les langages pris en charge et les instructions d'installation, consultez Installer les SDK.
CLI Alibaba Cloud
La CLI Alibaba Cloud est un outil en ligne de commande qui vous permet de gérer vos services et ressources Alibaba Cloud à l'aide de la commande
aliyun. Pour plus d'informations, consultez Qu'est-ce que la CLI Alibaba Cloud.Vous pouvez utiliser la CLI Alibaba Cloud pour appeler les opérations OpenAPI de ApsaraDB for HBase. Pour plus d'informations, consultez Appeler une API RPC.
Resource Orchestration Service (ROS)
Le Resource Orchestration Service (ROS) est un service Alibaba Cloud qui simplifie la gestion des ressources cloud. Vous pouvez écrire des modèles pour définir les ressources Alibaba Cloud requises, telles que les instances ECS et les instances de base de données RDS, ainsi que leurs dépendances. Le moteur ROS crée et configure ensuite automatiquement toutes les ressources sur la base du modèle, ce qui permet un déploiement et une O&M automatisés. Pour plus d'informations, consultez Qu'est-ce que le Resource Orchestration Service.
Vous pouvez utiliser ROS pour orchestrer et appeler les ressources ApsaraDB for HBase. Pour obtenir la liste des ressources et des sources de données prises en charge, consultez Ressources prises en charge par ROS.
Encapsulation personnalisée
Vous pouvez créer des requêtes encapsulées personnalisées pour accéder à l'OpenAPI Alibaba Cloud en suivant la documentation de signature V3 pour les SDK. Pour les appels HTTP natifs, vous devez implémenter l'algorithme de signature, construire les requêtes, puis les envoyer. Pour plus de détails sur le mécanisme de signature, consultez Corps de requête V3 et mécanisme de signature.
Notes
Si un appel d'API renvoie une erreur, reportez-vous au code d'erreur retourné pour vérifier vos paramètres et valeurs de requête. Pour plus d'informations, consultez Centre des codes d'erreur.
Vous pouvez également enregistrer le RequestID ou le message d'erreur du SDK provenant de la réponse et utiliser la Plateforme de diagnostic OpenAPI Alibaba Cloud pour effectuer un diagnostic en libre-service.