ApsaraDB for MongoDB propose une console visuelle et prend en charge l'intégration programmatique via les opérations d'API, les SDK, Alibaba Cloud CLI, Terraform et ROS.ApsaraDB for MongoDB
Opérations d'API
Alibaba Cloud OpenAPI Explorer vous permet de rechercher, déboguer et appeler des opérations d'API en ligne, et génère des exemples de code SDK.Qu'est-ce qu'une API ?
Versions d'API
Les numéros de version d'API indiquent les versions majeures. La version actuelle pour ApsaraDB for MongoDB est 2015-12-01. Malgré son format semblable à une date, ce numéro ne reflète pas la date de la dernière mise à jour.
|
Numéro de version de l'API |
Description |
|
Recommandée. |
Débogage en ligne
ApsaraDB for MongoDB prend en charge le débogage d'API dans OpenAPI Explorer. Avant d'appeler une opération d'API, vérifiez sa version, son endpoint et sa méthode d'appel dans ApsaraDB for MongoDB.
Par exemple, la page de l'opération CreateDBInstance répertorie les catégories d'API sur la gauche, un formulaire de paramètres (RegionId, ZoneId, Engine, EngineVersion, DBInstanceClass, DBInstanceStorage, etc.) au centre et la documentation de référence à droite. Cliquez sur Initiate Call pour exécuter la requête.
Page de débogage
Déboguez les opérations d'API à l'adresse suivante : https://api.alibabacloud.com/api/Dds/2015-12-01/.
Endpoints
Sélectionnez un endpoint en fonction de la région de votre ressource. Par exemple, une instance ApsaraDB for MongoDB dans la région Chine (Zhangjiakou) utilise l'endpoint public mongodb.cn-zhangjiakou.aliyuncs.com et l'endpoint VPC mongodb-vpc.cn-zhangjiakou.aliyuncs.com.
Les endpoints publics sont accessibles depuis le monde entier.
-
Les endpoints VPC sont accessibles uniquement au sein du VPC de la région correspondante et offrent ces avantages :
Sécurité et confidentialité accrues.
Latence réduite en évitant la surcharge d'Internet public.
Coût réduit grâce à la communication par réseau interne.
Identités prises en charge
OpenAPI Explorer utilise votre compte Alibaba Cloud pour le débogage par défaut. Étant donné qu'un compte Alibaba Cloud dispose de toutes les autorisations d'API, nous vous recommandons d'utiliser un utilisateur RAM pour les appels d'API et les opérations de maintenance courants. Accordez à l'utilisateur RAM les autorisations requises sur les instances ApsaraDB for MongoDB. Utilisez RAM pour mettre en œuvre le contrôle d'accès. Le tableau suivant répertorie les identités d'utilisateur prises en charge.
|
Identité de l'utilisateur |
Prise en charge |
|
Oui |
|
|
Utilisateur RAM (recommandé) |
Oui |
|
Rôle RAM (recommandé) |
Oui |
Méthodes d'intégration
ApsaraDB for MongoDB prend en charge les méthodes d'intégration suivantes.
|
Méthode d'intégration |
Prise en charge |
|
SDK Alibaba Cloud (recommandé) |
Oui |
|
Oui |
|
|
Oui |
|
|
Oui |
|
|
Oui |
SDK
Alibaba Cloud fournit des SDK pour Java, C#, Go, Python, TypeScript, Node.js, PHP et C++. Les SDK gèrent la logique de signature, les délais d'expiration et les nouvelles tentatives, et renvoient des objets de réponse structurés. SDK Alibaba Cloud.
OpenAPI Explorer génère des exemples de code SDK pour appeler les opérations d'API ApsaraDB for MongoDB. Langues et dépendances prises en charge :SDK ApsaraDB for MongoDB.
Alibaba Cloud CLI
Alibaba Cloud CLI vous permet d'exécuter des commandes
aliyunpour gérer les ressources cloud. Qu'est-ce qu'Alibaba Cloud CLI ?Appelez les opérations d'API ApsaraDB for MongoDB via Alibaba Cloud CLI. Appel d'API dans les styles RPC et RESTful.
Guide étape par étape pour appeler les opérations d'API ApsaraDB for MongoDB avec Alibaba Cloud CLI : Exemple d'intégration CLI.
Terraform
Terraform est un outil open source permettant de prévisualiser, configurer et gérer l'infrastructure cloud. Comme ROS, Terraform convertit les modèles en appels d'API. Qu'est-ce qu'Alibaba Cloud Terraform ?
Guide étape par étape pour orchestrer les ressources ApsaraDB for MongoDB avec Terraform : Exemples d'intégration Terraform.
ROS
ROS est un service Alibaba Cloud qui simplifie la gestion des ressources cloud. Vous créez des modèles pour définir les ressources (telles que les instances ECS et ApsaraDB RDS) et leurs dépendances, et ROS les crée et les configure automatiquement. Qu'est-ce que Resource Orchestration Service ?
-
Vous pouvez utiliser ROS pour gérer ApsaraDB for MongoDB. Types de ressources pris en charge :
-
Ressources courantes :
ALIYUN::MONGODB::Instance : crée une instance ApsaraDB for MongoDB.
ALIYUN::MONGODB::ServerlessInstance : crée une instance serverless ApsaraDB for MongoDB.
ALIYUN::MONGODB::ShardingInstance : crée ou clone une instance de cluster fragmenté ApsaraDB for MongoDB.
-
Ressources de données :
DATASOURCE::MONGODB::Instances : interroge les instances ApsaraDB for MongoDB.
DATASOURCE::MONGODB::InstanceClasses : interroge les types d'instances ApsaraDB for MongoDB disponibles dans une zone.
-
Guide étape par étape pour orchestrer les ressources ApsaraDB for MongoDB avec ROS : Exemple d'intégration d'orchestration de ressources.
Encapsulation personnalisée
Si aucune des méthodes précédentes ne répond à vos besoins, vous pouvez encapsuler manuellement les requêtes d'API. Cette méthode n'est pas recommandée. Syntaxe de requête et méthode de signature V3.
Gestion des erreurs
Si un appel d'API renvoie une erreur, vérifiez vos paramètres de requête par rapport au code d'erreur renvoyé dans le Centre des codes d'erreur.
Pour le dépannage en libre-service, utilisez la plateforme Alibaba Cloud OpenAPI Diagnostics avec le RequestID de la réponse ou les détails de l'erreur du SDK.