Normes API et SDK multilingues prédéfinis
L'OpenAPI de ce produit (Dds/2015-12-01) utilise le style de signature RPC. Des SDK sont disponibles pour les langages de programmation courants. Les développeurs peuvent télécharger le SDK pour appeler directement l'OpenAPI de ce produit, sans se soucier des détails techniques. Si le SDK existant ne répond pas à vos besoins, utilisez le mécanisme de signature pour une intégration par auto-signature. L'auto-signature étant particulièrement complexe, comptez environ 5 jours ouvrables. Nous vous recommandons donc de rejoindre notre groupe d'assistance DingTalk (147535001692) pour bénéficier d'un accompagnement expert lors de l'intégration.
Avant d'utiliser l'API, préparez votre compte d'identité et votre clé d'accès (AccessKey) afin d'accéder efficacement à l'API via des outils clients (tels que SDK et CLI). Pour plus d'informations, consultez Obtenir un AccessKey.
Scénarios de signature personnalisée
Si votre scénario métier présente des exigences particulières et nécessite une intégration par auto-signature, consultez d'abord notre équipe de support technique (groupe d'assistance DingTalk : 147535001692) pour obtenir un accompagnement professionnel et garantir une intégration efficace.
Préparation du compte et de la sécurité
Les comptes Alibaba Cloud disposent de permissions administratives complètes sur l'ensemble des ressources. En cas de compromission d'un AccessKey, toutes les ressources associées sont exposées à un risque d'accès non autorisé. Pour garantir la sécurité, créez un utilisateur RAM disposant uniquement de permissions d'accès API et configurez son AccessKey. Appliquez ensuite des politiques RAM selon le principe du moindre privilège (PoLP). N'utilisez le compte Alibaba Cloud que dans les scénarios spécifiques où ses permissions sont explicitement requises.
Créer ou cloner des instances
|
API |
Titre |
Description |
| CreateDBInstance | Créer ou cloner une instance de jeu de réplicas. | Crée ou clone une instance de jeu de réplicas ApsaraDB for MongoDB. |
| CreateShardingDBInstance | CreateShardingDBInstance. | Crée ou clone une instance de cluster sharded MongoDB. |
Modifier les configurations d'instances
|
API |
Titre |
Description |
| CreateNode | CreateNode. | Ajoute un nœud shard ou un nœud mongos à une instance de cluster sharded ApsaraDB for MongoDB. |
| CreateNodeBatch | CreateNodeBatch. | Ajoute par lot des nœuds mongos ou de fragment pour une instance de cluster fragmenté. |
| DeleteNode | DeleteNode. | Supprime un nœud shard ou mongos d'une instance de cluster sharded ApsaraDB for MongoDB. |
| ModifyDBInstanceSpec | ModifyDBInstanceSpec. | Modifie le type d'instance ou l'espace de stockage pour les instances autonomes, les ensembles de réplicas ou les instances serverless d'ApsaraDB for MongoDB. Les instances serverless sont exclusives au site web chinois d'Alibaba Cloud. |
| ModifyNodeSpec | ModifyNodeSpec. | Modifie le type d'instance et l'espace de stockage d'un nœud dans une instance de cluster fragmenté MongoDB. |
| ModifyNodeSpecBatch | ModifyNodeSpecBatch. | Modifie la configuration d'un ou plusieurs nœuds Mongos ou shard dans une instance de cluster fragmenté ApsaraDB for MongoDB. |
| ModifyDBInstanceDiskType | ModifyDBInstanceDiskType. | Modifie le type de disque d'une instance ApsaraDB for MongoDB. |
Gestion des instances
|
API |
Titre |
Description |
| DeleteDBInstance | DeleteDBInstance. | Libère une instance MongoDB à la demande. |
| ModifyDBInstanceMaintainTime | ModifyDBInstanceMaintainTime. | Modifie la fenêtre de maintenance d'une instance ApsaraDB for MongoDB. |
| ModifyDBInstanceDescription | ModifyDBInstanceDescription. | Modifie le nom d'une instance ApsaraDB for MongoDB. |
| ModifyDBInstanceNetExpireTime | ModifyDBInstanceNetExpireTime. | Prolonge la période de rétention du point de terminaison du réseau classique d'une instance ApsaraDB for MongoDB. |
| UpgradeDBInstanceEngineVersion | UpgradeDBInstanceEngineVersion. | Met à niveau la version de la base de données d'une instance ApsaraDB for MongoDB. |
| UpgradeDBInstanceKernelVersion | UpgradeDBInstanceKernelVersion. | Met à niveau la version mineure d'une instance ApsaraDB for MongoDB. |
| SwitchDBInstanceHA | SwitchDBInstanceHA. | Bascule les nœuds principal et secondaire d'une instance ApsaraDB for MongoDB. |
| RestartDBInstance | RestartDBInstance. | Redémarre une instance ApsaraDB for MongoDB. |
| DestroyInstance | DestroyInstance. | Détruit une instance ApsaraDB for MongoDB. |
| RestartNode | RestartNode. | Redémarre un nœud unique d'une instance MongoDB. |
Gestion des renouvellements
|
API |
Titre |
Description |
| ModifyInstanceAutoRenewalAttribute | ModifyInstanceAutoRenewalAttribute. | Active ou désactive le renouvellement automatique pour une instance ApsaraDB for MongoDB. |
| TransformInstanceChargeType | TransformInstanceChargeType. | Modifie le mode de facturation d'une instance, du mode postpayé au mode abonnement ou du mode abonnement au mode postpayé. |
| DescribePrice | DescribePrice. | Consulte les prix. |
| DescribeRenewalPrice | DescribeRenewalPrice. | Obtient le prix de renouvellement d'une instance MongoDB spécifique pour un mois. |
| TransformToPrePaid | TransformToPrePaid. | Modifie le mode de facturation d'une instance ApsaraDB for MongoDB du paiement à l'usage à l'abonnement. |
| RenewDBInstance | RenewDBInstance. | Renouvelle manuellement une instance ApsaraDB for MongoDB en mode abonnement. |
Interroger les instances
|
API |
Titre |
Description |
| DescribeDBInstanceSpecInfo | DescribeDBInstanceSpecInfo. | Obtient les détails du type d'instance. |
| DescribeReplicaSetRole | DescribeReplicaSetRole. | Obtient les informations de rôle et les détails de connexion d'une instance MongoDB. |
| DescribeKernelReleaseNotes | DescribeKernelReleaseNotes. | Consulte les notes de version des versions mineures d'une instance ApsaraDB for MongoDB. |
| DescribeAvailableEngineVersion | DescribeAvailableEngineVersion. | Consulte les versions du moteur vers lesquelles une instance ApsaraDB for MongoDB peut être mise à niveau. |
| DescribeDBInstances | DescribeDBInstances. | Consulte la liste des instances MongoDB. |
| DescribeDBInstanceSwitchLog | DescribeDBInstanceSwitchLog. | Consulte les journaux de basculement primaire/secondaire d'une instance ApsaraDB for MongoDB. |
| DescribeDBInstanceAttribute | Consultation des informations sur une instance ApsaraDB for MongoDB. | Consulte les informations relatives à une instance ApsaraDB for MongoDB. |
| DescribeRoleZoneInfo | DescribeRoleZoneInfo. | Consulte le rôle et la zone de chaque nœud d'une instance ApsaraDB for MongoDB. |
| DescribeInstanceAutoRenewalAttribute | DescribeInstanceAutoRenewalAttribute. | Consulte l'état du renouvellement automatique des instances MongoDB. |
| DescribeActiveOperationTaskCount | DescribeActiveOperationTaskCount. | Consulte le nombre de tâches d'exploitation et de maintenance sur une instance ApsaraDB for MongoDB. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks. | Consulte les détails des tâches O&M des instances MongoDB. |
| DescribeActiveOperationTaskType | DescribeActiveOperationTaskType. | Consulte les types de tâches d'exploitation et de maintenance ainsi que le nombre de tâches de chaque type pour une instance ApsaraDB for MongoDB. |
| DescribeDBInstancesOverview | DescribeDBInstancesOverview. | Consulte la vue d'ensemble d'une ou plusieurs instances ApsaraDB for MongoDB. |
| DescribeHistoryTasks | DescribeHistoryTasks. | Consulte la liste des tâches dans le centre des tâches. |
| DescribeHistoryTasksStat | DescribeHistoryTasksStat. | Consulte la vue d'ensemble d'une tâche dans le centre des tâches. |
| ModifyTaskInfo | Modification des informations de la tâche. | Modifie les informations d'une tâche dans le centre des tâches pour une instance ApsaraDB for MongoDB. |
| ModifyActiveOperationTasks | ModifyActiveOperationTasks. | Modifie l'heure de basculement des tâches d'exploitation et de maintenance planifiées pour une instance ApsaraDB for MongoDB. |
Gestion des ressources
|
API |
Titre |
Description |
| DescribeAvailableResource | DescribeAvailableResource. | Consulte les ressources disponibles dans la zone spécifiée. |
| EvaluateResource | EvaluateResource. | Évalue la disponibilité des ressources avant d'acheter une nouvelle instance ou de modifier la configuration d'une instance existante. |
| DescribeAvailabilityZones | DescribeAvailabilityZones. | Consulte la liste des zones prises en charge par une instance ApsaraDB for MongoDB. |
| ModifyResourceGroup | ModifyResourceGroup. | Déplace une instance ApsaraDB for MongoDB vers un groupe de ressources spécifié. |
Gestion des régions
|
API |
Titre |
Description |
| DescribeRegions | DescribeRegions. | Consulte toutes les régions et zones prises en charge pour une instance ApsaraDB for MongoDB. |
| MigrateToOtherZone | MigrateToOtherZone. | Migre une instance ApsaraDB for MongoDB vers une autre zone. |
| MigrateAvailableZone | MigrateAvailableZone. | Migre une instance ApsaraDB for MongoDB vers une zone spécifique. |
Gestion des connexions
|
API |
Titre |
Description |
| ModifyInstanceVpcAuthMode | ModifyInstanceVpcAuthMode. | Désactive l'accès sans mot de passe sur le réseau privé virtuel (VPC) pour une instance ApsaraDB for MongoDB. |
| ModifyDBInstanceNetworkType | Basculement du type de réseau d'une instance. | Bascule le type de réseau d'une instance MongoDB. |
| ModifyDBInstanceConnectionString | ModifyDBInstanceConnectionString. | Modifie l'adresse de connexion et le port d'une instance MongoDB. |
| DescribeShardingNetworkAddress | DescribeShardingNetworkAddress. | Obtient les informations de connexion d'une instance de cluster fragmenté MongoDB. |
| AllocatePublicNetworkAddress | AllocatePublicNetworkAddress. | Alloue un point de terminaison public à une instance. |
| ReleasePublicNetworkAddress | ReleasePublicNetworkAddress. | Libère le point de terminaison public d'une instance ApsaraDB for MongoDB. |
| AllocateNodePrivateNetworkAddress | AllocateNodePrivateNetworkAddress. | Demande un point de terminaison interne pour un nœud shard ou Configserver dans une instance de cluster fragmenté ApsaraDB for MongoDB. |
| ReleaseNodePrivateNetworkAddress | ReleaseNodePrivateNetworkAddress. | Libère le point de terminaison interne d'un nœud de fragment ou Configserver pour une instance de cluster fragmenté. |
Gestion des balises
|
API |
Titre |
Description |
| ListTagResources | ListTagResources. | Consulte la relation entre les instances ApsaraDB for MongoDB et les balises. |
| DescribeTags | DescribeTags. | Consulte toutes les balises dans une région spécifiée. |
| TagResources | TagResources | Associe des balises aux instances ApsaraDB for MongoDB. |
| UntagResources | UntagResources. | Supprime une balise si elle n'est pas ajoutée à une autre instance. |
Gestion des comptes
|
API |
Titre |
Description |
| CreateAccount | CreateAccount | Crée un compte disposant d'autorisations en lecture seule pour les nœuds de fragment d'une instance de cluster fragmenté ApsaraDB for MongoDB utilisant des disques cloud. |
| ResetAccountPassword | ResetAccountPassword. | Réinitialise le mot de passe du compte root d'une instance ApsaraDB for MongoDB. |
| ModifyAccountDescription | ModifyAccountDescription. | Modifie la description du compte root dans une instance ApsaraDB for MongoDB. |
| DescribeAccounts | DescribeAccounts. | Consulte les comptes de base de données d'une instance ApsaraDB for MongoDB. |
Listes blanches et groupes de sécurité
|
API |
Titre |
Description |
| ModifySecurityIps | ModifySecurityIps. | Modifie la liste blanche d'adresses IP d'une instance ApsaraDB for MongoDB. |
| ModifySecurityGroupConfiguration | ModifySecurityGroupConfiguration. | Modifie le groupe de sécurité ECS associé à une instance ApsaraDB for MongoDB. |
| DescribeSecurityIps | DescribeSecurityIps. | Obtient les listes blanches d'adresses IP d'une instance ApsaraDB for MongoDB. |
| DescribeSecurityGroupConfiguration | DescribeSecurityGroupConfiguration. | Consulte les groupes de sécurité Elastic Compute Service (ECS) associés à une instance ApsaraDB for MongoDB. |
| ModifyGlobalSecurityIPGroup | Modifier un modèle global de liste blanche d'adresses IP. | Modifie le modèle global de liste blanche d'adresses IP associé à une instance ApsaraDB for MongoDB. |
| DescribeGlobalSecurityIPGroup | DescribeGlobalSecurityIPGroup. | Consulte le modèle global de liste blanche d'adresses IP d'une instance ApsaraDB for MongoDB. |
| ModifyGlobalSecurityIPGroupName | ModifyGlobalSecurityIPGroupName. | Modifie le nom d'un modèle de liste blanche d'adresses IP global associé à une instance ApsaraDB for MongoDB. |
| DescribeGlobalSecurityIPGroupRelation | DescribeGlobalSecurityIPGroupRelation. | Consulte le mappage entre une instance et un modèle global de liste blanche d'adresses IP. |
| CreateGlobalSecurityIPGroup | CreateGlobalSecurityIPGroup. | Crée un modèle global de liste blanche d'adresses IP. |
| ModifyGlobalSecurityIPGroupRelation | ModifyGlobalSecurityIPGroupRelation. | Modifie le mappage entre un modèle de liste blanche globale et une instance ApsaraDB for MongoDB. |
| DeleteGlobalSecurityIPGroup | Supprimer un modèle de liste blanche d'adresses IP globales. | Supprime un modèle de liste blanche d'adresses IP globales. |
Clés
|
API |
Titre |
Description |
| ModifyDBInstanceTDE | ModifyDBInstanceTDE. | Modifie l'état du chiffrement transparent des données (TDE) d'une instance MongoDB. |
| CheckCloudResourceAuthorized | CheckCloudResourceAuthorized. | Vérifie si les clés Key Management Service (KMS) sont autorisées pour une instance ApsaraDB for MongoDB. |
| DescribeUserEncryptionKeyList | DescribeUserEncryptionKeyList. | Consulte les clés personnalisées d'une instance. |
| DescribeDBInstanceEncryptionKey | DescribeDBInstanceEncryptionKey. | Consulte la clé de chiffrement d'une instance MongoDB. |
| DescribeDBInstanceTDEInfo | Vérification de l'activation du TDE pour une instance MongoDB. | Vérifie si le chiffrement transparent des données (TDE) est activé pour une instance ApsaraDB for MongoDB. |
| DescribeKmsKeys | DescribeKmsKeys. | Consulte les clés du service de gestion des clés (KMS) disponibles pour le chiffrement des disques. |
Chiffrement SSL
|
API |
Titre |
Description |
| ModifyDBInstanceSSL | ModifyDBInstanceSSL. | Modifie la configuration SSL d'une instance MongoDB. |
| DescribeDBInstanceSSL | DescribeDBInstanceSSL. | Consulte les détails de la configuration SSL d'une instance MongoDB. |
Journaux d'audit
|
API |
Titre |
Description |
| ModifyAuditLogFilter | Modification des types de collecte des journaux d'audit pour une instance. | Modifie les types de collecte des journaux d'audit pour une instance ApsaraDB for MongoDB. |
| ModifyAuditPolicy | ModifyAuditPolicy. | Active ou désactive le journal d'audit pour une instance MongoDB, ou modifie la période de rétention du journal. |
| DescribeAuditRecords | DescribeAuditRecords. | Consulte les entrées du journal d'audit d'une instance MongoDB. |
| DescribeAuditPolicy | DescribeAuditPolicy. | Vérifie si la journalisation d'audit est activée pour une instance MongoDB. |
| DescribeAuditLogFilter | DescribeAuditLogFilter. | Consulte les types de journaux d'audit collectés pour une instance MongoDB. |
| DescribeMongoDBLogConfig | DescribeMongoDBLogConfig. | Consulte la configuration du service de journalisation MongoDB. |
Gestion des journaux
|
API |
Titre |
Description |
| DescribeSlowLogRecords | DescribeSlowLogRecords. | Consulte les entrées de journal des requêtes lentes pour une instance MongoDB. |
| DescribeErrorLogRecords | Consultation des journaux d'erreurs d'une instance. | Consulte les journaux d'erreurs d'une instance ApsaraDB for MongoDB. |
| DescribeRunningLogRecords | Consultation des journaux d'exécution de l'instance. | Consulte les journaux d'exécution d'une instance ApsaraDB for MongoDB. |
Surveillance des performances
|
API |
Titre |
Description |
| ModifyDBInstanceMonitor | ModifyDBInstanceMonitor. | Définit la granularité de collecte des données de surveillance pour une instance MongoDB. |
| DescribeDBInstancePerformance | DescribeDBInstancePerformance. | Consulte les données de performances d'une instance MongoDB. |
| DescribeDBInstanceMonitor | DescribeDBInstanceMonitor. | Consulte la fréquence de collecte des données de surveillance pour une instance ApsaraDB for MongoDB. |
Gestion des paramètres
|
API |
Titre |
Description |
| ModifyParameters | ModifyParameters. | Modifie les paramètres d'une instance ApsaraDB for MongoDB. |
| DescribeParameterModificationHistory | DescribeParameterModificationHistory. | Consulte les enregistrements de modification des paramètres d'une instance ApsaraDB for MongoDB. |
| DescribeParameterTemplates | DescribeParameterTemplates. | Consulte les modèles de paramètres par défaut pour les instances MongoDB. |
| DescribeParameters | DescribeParameters. | Consulte les paramètres de configuration d'une instance ApsaraDB for MongoDB. |
Sauvegarde et restauration
|
API |
Titre |
Description |
| ModifyAdvancedBackupStatus | Activer la sauvegarde avancée. | Active la sauvegarde avancée. |
| ModifyAdvancedBackupPolicy | Modification de la stratégie de sauvegarde avancée. | Modifie la stratégie de sauvegarde avancée. |
| DescribeAdvancedBackupStatus | Vérifier si la sauvegarde avancée est activée. | Vérifie si la sauvegarde avancée est activée. |
| DescribeAdvancedBackupPolicy | Consultation de la stratégie de sauvegarde avancée. | Consulte la stratégie de sauvegarde avancée. |
| CreateBackup | CreateBackup. | Crée une sauvegarde pour une instance MongoDB. |
| ModifyBackupPolicy | ModifyBackupPolicy. | Modifie la stratégie de sauvegarde d'une instance MongoDB. |
| DescribeBackupPolicy | DescribeBackupPolicy. | Consulte la stratégie de sauvegarde d'une instance MongoDB. |
| DescribeBackups | DescribeBackups. | Consulte les sauvegardes d'une instance MongoDB. |
| DescribeBackupDBs | DescribeBackupDBs. | Consulte les bases de données à un moment spécifié ou les bases de données dans un jeu de sauvegarde spécifié avant de restaurer une base de données pour une instance ApsaraDB for MongoDB. |
| DescribeRestoreDBInstanceList | DescribeRestoreDBInstanceList. | Consulte les instances ApsaraDB for MongoDB dont les sauvegardes sont restaurées dans un délai de sept jours. |
| CheckRecoveryCondition | CheckRecoveryCondition. | Vérifie si les données d'une instance ApsaraDB for MongoDB peuvent être restaurées. |
| TransferClusterBackup | TransferClusterBackup. | Bascule le mode de sauvegarde d'une instance de cluster fragmenté ApsaraDB for MongoDB vers le mode de sauvegarde de cluster. Une fois l'instance basculée vers le mode de sauvegarde de cluster, elle prend en charge la sauvegarde à haute fréquence. |
| DescribeClusterBackups | DescribeClusterBackups. | Consulte les jeux de sauvegarde de cluster pour une instance de cluster fragmenté ApsaraDB for MongoDB utilisant des disques cloud. |
| DescribeClusterRecoverTime | Consultation de la plage de temps de restauration d'un cluster fragmenté. | Consulte la plage de temps de restauration d'une instance de cluster fragmenté utilisant des disques cloud dans ApsaraDB for MongoDB. |
| DescribeBackupStorage | DescribeBackupStorage. | Consulte l'utilisation des sauvegardes pour une instance de jeu de répliques ou de cluster fragmenté MongoDB qui utilise des disques cloud. |
| DescribeBackupTasks | DescribeBackupTasks. | Consulte les tâches de sauvegarde en cours pour les instances MongoDB ReplicaSet ou les clusters fragmentés qui utilisent des disques cloud. |
| DescribeInstanceRecoverTime | Consultation des plages de temps restaurables d'une instance de jeu de réplicas. | Consulte les plages de temps restaurables d'une instance de jeu de réplicas ApsaraDB for MongoDB avec disques cloud. |
Autres
|
API |
Titre |
Description |
| DescribeActiveOperationTask | DescribeActiveOperationTask. | Consulte les informations détaillées sur les tâches d'une instance ApsaraDB for MongoDB. |
| AllocateDBInstanceSrvNetworkAddress | AllocateDBInstanceSrvNetworkAddress | Alloue une chaîne de connexion SRV pour une instance ApsaraDB for MongoDB. |
| DescribeActiveOperationTaskRegion | Types et quantités des tâches de maintenance. | Consulte les types et le nombre de tâches d'exploitation et de maintenance d'une instance MongoDB. |
| DescribeActiveOperationMaintenanceConfig | DescribeActiveOperationMaintenanceConfig. | Consulte la configuration des tâches d'exploitation et de maintenance (O&M) pour une instance MongoDB. |
| CheckServiceLinkedRole | Vérification du rôle lié à un service. | Vérifie si un rôle lié à un service (SLR) est créé pour une instance. |
| ModifyDBInstanceConfig | ModifyDBInstanceConfig. | Modifie la configuration de l'instance. |
| ModifyDBInstanceAttribute | ModifyDBInstanceAttribute. | Modifie la configuration de protection contre la libération de l'instance. |
| ModifySrvNetworkAddress | ModifySrvNetworkAddress. | Modifie l'adresse de connexion SRV d'une instance MongoDB. |
| CancelActiveOperationTasks | CancelActiveOperationTasks. | Annule des événements d'exploitation et de maintenance (O&M) par lot. |
| CreateNodeRoleTag | CreateNodeRoleTag. | Crée une balise de rôle pour un nœud d'instance. |
| DescribeRdsVSwitchs | DescribeRdsVSwitchs. | Obtient la liste des vSwitches. |
| DescribeRdsVpcs | DescribeRdsVpcs. | Obtient la liste des VPC. |
| DescribeRoleTagStatus | DescribeRoleTagStatus. | Décrit l'état d'une balise pour un nœud. |
| DescribeVpcsForMongoDB | DescribeVpcsForMongoDB. | Consulte la liste paginée des VPC. |
| ModifyActiveOperationMaintenanceConfig | ModifyActiveOperationMaintenanceConfig. | Modifie la configuration des tâches d'exploitation et de maintenance (O&M) pour une instance MongoDB. |
| DescribeBinlogFiles | DescribeBinlogFiles | Consulte les fichiers de sauvegarde des journaux pour une instance ApsaraDB for MongoDB. |
| ModifyBackupExpireTime | ModifyBackupExpireTime. | Modifie la durée de vie (TTL) d'un jeu de sauvegardes MongoDB. |
| DeleteBackup | DeleteBackup. | Supprime un jeu de sauvegarde MongoDB. |