Cette rubrique présente les informations essentielles et les remarques importantes concernant l'utilisation de l'OpenAPI de Lindorm.
OpenAPI
Alibaba Cloud met à disposition le portail OpenAPI pour faciliter la découverte et l'utilisation des API de ses produits cloud. Cette plateforme centralisée offre des fonctionnalités telles que la recherche intelligente d'API, la documentation, le débogage en ligne, l'accès aux SDK, des exemples de code, le diagnostic d'erreurs et des statistiques d'appels. Vous pouvez utiliser ce portail pour appeler les API de divers produits Alibaba Cloud, consulter les requêtes et les réponses, ainsi que générer automatiquement du code d'exemple SDK afin d'accélérer votre prise en main. Pour plus d'informations, consultez Qu'est-ce que l'OpenAPI ?.
Versions
L'OpenAPI d'Alibaba Cloud utilise des numéros de version pour gérer les API des clusters Lindorm selon leur architecture. Le tableau suivant liste les versions d'API prises en charge par Lindorm avec leur description.
|
Version |
Description |
|
2020-06-15 |
Toutes les instances Lindorm utilisent cette version pour les appels API. |
Débogage en ligne
Le portail OpenAPI propose des outils de débogage pour les API Lindorm. Avant d'appeler une API, assurez-vous de connaître la version, la description de l'endpoint et la méthode d'intégration de Lindorm. Connectez-vous au Portail OpenAPI. Dans la barre de navigation de gauche, sélectionnez la version d'API 2020-06-15. Sous la catégorie des régions, choisissez l'API DescribeRegions pour obtenir la liste complète des régions prises en charge par Lindorm. Dans la liste déroulante Service Address, sélectionnez la région cible, par exemple China (Hangzhou). Dans la section de configuration des paramètres, définissez le paramètre AcceptLanguage (chaîne de caractères, valeur d'exemple : zh-CN). Les paramètres de réponse incluent RequestId (chaîne) et Regions (liste des régions). Une fois la configuration terminée, cliquez sur Initiate Call.
Portail de débogage
L'API Explorer pour Lindorm est disponible à l'adresse suivante : API Explorer.
Endpoints
Sélectionnez l'endpoint correspondant à la région où se trouvent vos ressources afin de réduire la latence. Par exemple, l'endpoint VPC pour la région China (Qingdao) est hitsdb-vpc.cn-qingdao.aliyuncs.com.
Les endpoints publics sont accessibles depuis Internet partout dans le monde.
-
Un Virtual Private Cloud (VPC) constitue un réseau virtuel isolé. Les endpoints VPC offrent les avantages suivants :
Sécurité renforcée : accessibles uniquement depuis un VPC, ces endpoints garantissent une meilleure confidentialité et protection des données.
Réactivité accrue : en transitant par le réseau interne, les endpoints VPC offrent des temps de réponse plus rapides que les endpoints publics, sans être soumis à la latence ni aux limites de bande passante du réseau public.
Coûts réduits : l'utilisation des endpoints VPC diminue les frais de transfert de données grâce au routage via le réseau interne.
provide enhanced security and privacy.
Faster response: By using an internal network, VPC endpoints offer faster response times than public endpoints and are not subject to public network latency or bandwidth limits.ster response times than public endpoints and are not subject to public network latency or bandwidth limits.
Lower costs: Using VPC endpoints can reduce data transfer costs because communication occurs over an internal network.ints can reduce data transfer costs because communication occurs over an internal network.
Pour plus d'informations, consultez Endpoints.
Identités utilisateur prises en charge
Lorsque vous vous connectez au site OpenAPI, le système utilise par défaut votre compte connecté pour le débogage en ligne des API. Un compte Alibaba Cloud disposant de permissions d'accès à toutes les API, son utilisation directe présente un risque de sécurité élevé. Par conséquent, il est déconseillé d'utiliser un compte Alibaba Cloud principal pour le débogage en ligne. Nous recommandons vivement de créer et d'utiliser un utilisateur RAM pour l'accès aux API ou les opérations quotidiennes. Accordez les permissions nécessaires à cet utilisateur RAM en fonction de vos besoins métier avant d'effectuer des appels API. L'utilisateur RAM doit disposer des autorisations requises pour opérer sur Lindorm. Pour plus d'informations, consultez Informations d'autorisation.
|
Identité utilisateur |
Prise en charge |
|
Oui |
|
|
Utilisateur RAM (recommandé) |
Oui |
|
Rôle RAM (recommandé) |
Oui |
Méthodes d'intégration
Lindorm propose plusieurs méthodes d'intégration, notamment le SDK Alibaba Cloud et des encapsulations personnalisées. Choisissez celle qui correspond le mieux à vos besoins métier.
Les SDK simplifient l'intégration et constituent la méthode recommandée pour appeler les opérations OpenAPI.
|
Méthode d'intégration |
Prise en charge |
|
SDK Alibaba Cloud |
Oui |
|
CLI Alibaba Cloud |
Oui |
|
Terraform |
Oui |
|
Resource Orchestration Service (ROS) |
Oui |
|
Encapsulation personnalisée |
Oui |
SDK Alibaba Cloud
Alibaba Cloud fournit des SDK pour divers langages de programmation, dont Java, C#, Go, Python, PHP et C++. Ces SDK masquent les détails d'implémentation de l'OpenAPI et normalisent les règles d'identité, d'authentification et de signature. Il 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.l OpenAPI operations directly. For more information about Alibaba Cloud SDKs, see SDK Alibaba Cloud.
Le SDK Alibaba Cloud permet d'appeler l'OpenAPI de Lindorm. Pour connaître les langages pris en charge et les méthodes d'installation des dépendances, consultez Installation du SDK.tab=primer-doc" id="c5b490c8ffhez">SDK Installation Installation du SDK.
CLI Alibaba Cloud
La CLI Alibaba Cloud est un outil en ligne de commande permettant d'interagir avec les services Alibaba Cloud et de gérer vos ressources cloud via la commande
aliyundans un shell. Pour plus d'informations sur la CLI Alibaba Cloud, consultez Qu'est-ce que la CLI Alibaba Cloud ?.ee Qu'est-ce que la CLI Alibaba Cloud ?.La CLI Alibaba Cloud permet également d'appeler l'OpenAPI de Lindorm. Pour plus d'informations, consultez Appeler des API RPC.e"> OpenAPI. For more information, see Appeler des API RPC.
Resource Orchestration Service (ROS)
Resource Orchestration Service (ROS) est un service Alibaba Cloud qui simplifie la gestion des ressources cloud. Vous pouvez créer des modèles pour définir les ressources Alibaba Cloud requises, telles que des instances ECS et des bases de données RDS, ainsi que leurs dépendances. Le moteur d'orchestration ROS crée et configure alors automatiquement toutes les ressources selon le modèle, ce qui permet d'automatiser le déploiement et les opérations de maintenance. Pour plus d'informations, consultez Qu'est-ce que ROS ?.ly creates and configures all resources based on the template, enabling automated deployment and O&M. For more information, see Qu'est-ce que ROS ?.
Resource Orchestration Service (ROS) permet d'orchestrer Lindorm. Pour obtenir la liste des ressources standard et de données prises en charge, consultez Liste d'orchestration des ressources._product_name_4265572" is-conref="true">. For a list of supported standard and data resources, see Liste d'orchestration des ressources.
Encapsulation personnalisée
Vous avez également la possibilité de créer votre propre encapsulateur de requêtes pour accéder à l'OpenAPI d'Alibaba Cloud. Cette méthode nécessite l'implémentation de l'algorithme de signature V3, la construction d'une requête personnalisée et son envoi via HTTP. Pour plus d'informations sur le mécanisme de signature, consultez Corps de requête V3 et mécanisme de signature.
Remarques d'utilisation
Si un appel API renvoie une erreur, vérifiez le code d'erreur retourné et examinez vos paramètres de requête ainsi que leurs valeurs. Pour plus d'informations, consultez Centre des codes d'erreur.
Vous pouvez aussi noter le RequestID retourné ou le message d'erreur du SDK, puis utiliser la plateforme de diagnostic OpenAPI d'Alibaba Cloud pour diagnostiquer le problème.