Data Management (DMS) propose une console visuelle et un accès programmatique via le débogage en ligne d'OpenAPI, le SDK Alibaba Cloud et la CLI Alibaba Cloud. Pour développer efficacement avec DMS, choisissez la méthode d'intégration la mieux adaptée à vos besoins.
Vue d'ensemble d'OpenAPI
Pour vous aider à apprendre et à utiliser efficacement les OpenAPI de nos produits cloud, Alibaba Cloud met à votre disposition le site web OpenAPI. Cette plateforme tout-en-un offre une recherche intelligente, une documentation, un débogage en ligne, l'accès aux SDK, des exemples de code, des outils de diagnostic des erreurs et des statistiques d'appels. Utilisez le portail OpenAPI pour appeler les OpenAPI de divers produits Alibaba Cloud et visualiser 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 avec les produits Alibaba Cloud. Pour plus d'informations, consultez Qu'est-ce qu'OpenAPI ?.
Versions de l'API
Alibaba Cloud OpenAPI utilise des numéros de version pour gérer les versions majeures des API des produits cloud.
Par exemple, DMS prend en charge la version d'API 2018-11-01. La chaîne 2018-11-01 est un identifiant de version d'API, et non une date. Elle permet d'accéder aux dernières fonctionnalités de l'API et n'indique pas que l'API est restée statique depuis le 2018-11-01.
|
Fonctionnalité |
Version de l'API |
Description |
|
Data Management (DMS) |
Recommandé. |
Débogage en ligne
DMS propose des fonctionnalités de débogage d'API et d'autres outils dans le portail OpenAPI. Avant d'appeler une API, comprenez les versions, les endpoints, le style d'API et les méthodes de requête fournis par DMS.
Sur la page de débogage du portail OpenAPI, le volet de navigation de gauche répertorie les opérations d'API telles que ListInstances (récupère une liste d'informations sur les instances), AddInstance, ModifyInstance, GetInstance et DeleteInstance. Après avoir sélectionné une opération d'API, configurez l'endpoint (par exemple China (Hangzhou)) et les paramètres de requête dans le panneau central. Ces paramètres incluent Tid (ID du locataire), SearchKey (mot-clé de recherche), DbType (type de base de données), EnvType (type d'environnement), InstanceSource (source de l'instance), NetType (type de réseau), InstanceState (état de l'instance) et PageNumber (numéro de page). Une fois les valeurs saisies, cliquez sur Initiate Call pour envoyer la requête. Le panneau de documentation situé à droite affiche le type de données et un exemple de valeur pour chaque paramètre.
Points d'entrée de débogage
|
Fonctionnalité |
Version de l'API |
Point d'entrée |
|
Data Management (DMS) |
Endpoints
DMS
Sélectionnez l'endpoint correspondant à la région où se trouvent vos ressources afin de minimiser la latence.
Par exemple, l'endpoint VPC pour la région China (Zhangjiakou) est dms-enterprise-vpc.cn-zhangjiakou.aliyuncs.com. Pour plus d'informations, consultez Endpoints.
Identités prises en charge
Après vous être connecté au site web OpenAPI avec votre compte Alibaba Cloud, les appels d'API sont effectués par défaut à l'aide de ce compte lors du débogage en ligne. L'utilisation d'un compte Alibaba Cloud pour un accès régulier aux API présente un risque élevé en raison de ses autorisations complètes. Nous vous recommandons vivement de créer et d'utiliser un utilisateur RAM pour les opérations quotidiennes. Accordez les autorisations nécessaires à l'utilisateur RAM en fonction de vos besoins métier avant d'effectuer des appels d'API. L'utilisateur RAM doit disposer des autorisations nécessaires pour utiliser DMS. Pour plus d'informations, consultez Utiliser RAM pour le contrôle d'accès.
|
Identité de l'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
Vue d'ensemble de l'intégration
DMS propose plusieurs méthodes d'intégration, y compris des SDK. 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 OpenAPI.
DMS
|
Méthode |
Prise en charge |
|
SDK Alibaba Cloud (recommandé) |
Pris en charge |
|
Pris en charge |
|
|
Partiellement pris en charge |
|
|
Non pris en charge |
|
|
Encapsulation d'API personnalisée (non recommandé) |
Pris en charge |
SDK Alibaba Cloud
Alibaba Cloud fournit des SDK pour plusieurs langages de programmation, notamment Java, C#, Go, Python, Node.js/TypeScript, PHP et C++. Il vous suffit d'intégrer le SDK pour appeler directement les OpenAPI via les méthodes exposées. Les SDK simplifient le développement en gérant la logique de signature, les délais d'expiration et les mécanismes de nouvelle tentative, tout en renvoyant des objets Response structurés. Pour plus d'informations sur les SDK Alibaba Cloud, consultez SDK Alibaba Cloud.
Pour obtenir des informations sur les langages et les dépendances pris en charge par le SDK DMS, consultez SDK DMS.
CLI Alibaba Cloud
La CLI Alibaba Cloud vous permet d'interagir avec les services Alibaba Cloud et de gérer vos ressources cloud depuis un terminal à l'aide des commandes
aliyun. Pour plus d'informations sur la CLI Alibaba Cloud, consultez Qu'est-ce que la CLI Alibaba Cloud ?Utilisez la CLI Alibaba Cloud pour appeler les opérations d'API DMS. Pour plus d'informations, consultez Appeler des opérations d'API RPC à l'aide de la CLI Alibaba Cloud.
Orchestration des ressources (ROS)
Resource Orchestration Service (ROS) est un service Alibaba Cloud qui simplifie la gestion des ressources cloud. Les développeurs et les administrateurs peuvent é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 d'orchestration ROS crée et configure automatiquement toutes les ressources sur la base du modèle, permettant ainsi un déploiement et une exploitation automatisés. Pour plus d'informations, consultez Qu'est-ce que Resource Orchestration Service ?.
-
Utilisez ROS pour orchestrer les ressources DMS. Les ressources DMS suivantes sont prises en charge :
ALIYUN::DMS::Instance : enregistre une nouvelle instance.
ALIYUN::DMS::User : enregistre un nouvel utilisateur.
Pour utiliser rapidement ROS afin d'orchestrer les ressources DMS, consultez Exemple d'intégration ROS.
Encapsulation d'API personnalisée
Pour effectuer des appels HTTP natifs, implémentez l'algorithme de signature, construisez des requêtes personnalisées et initiez les appels HTTP. Pour plus d'informations sur le mécanisme de signature, consultez Vue d'ensemble de l'API DMS et Corps de la requête et mécanisme de signature (V3).
Remarques sur l'utilisation
DMS
Si un appel d'API échoue, utilisez le code d'erreur renvoyé pour vérifier vos paramètres de requête et leurs valeurs. Pour plus d'informations, consultez Codes d'erreur.
Sinon, enregistrez le RequestID ou le message d'erreur du SDK issu de la réponse et utilisez Diagnostic OpenAPI Alibaba Cloud pour résoudre le problème.