Les tableaux suivants répertorient les opérations d'API disponibles pour Data Management (DMS).
Commande
| API | Description |
| BuyPayAsYouGoOrder | Achète une ressource DMS en paiement à l'utilisation. |
| RefundPayAsYouGoOrder | Se désabonne d'une ressource DMS en paiement à l'utilisation. |
| ListEffectiveOrders | Récupère les informations sur les commandes actives. |
Gestion des utilisateurs
| API | Description |
| RegisterUser | Ajoute un utilisateur à votre entreprise. |
| DisableUser | Désactive temporairement un utilisateur. |
| EnableUser | Réactive un utilisateur désactivé. |
| DeleteUser | Supprime un utilisateur devenu inutile. |
| UpdateUser | Met à jour les informations d'un utilisateur. |
| ListUsers | Récupère la liste des utilisateurs. |
| ListUserTenants | Récupère la liste des locataires (tenants). |
| GetUserActiveTenant | Récupère les informations sur le locataire actif. |
| GetUser | Récupère les informations d'un utilisateur. |
Gestion des instances
| API | Description |
| RegisterInstance | Enregistre une instance de base de données pour votre entreprise. |
| UpdateInstance | Met à jour les informations d'une instance de base de données et vérifie sa connectivité. |
| GetInstance | Récupère les détails d'une instance de base de données. |
| DeleteInstance | Supprime une instance de base de données de DMS Enterprise. |
| ListInstances | Récupère la liste des instances de base de données et leurs détails. |
Audit des opérations
| API | Description |
| GetOpLog | Récupère les détails des journaux d'opération générés durant une période donnée. |
| ListSQLExecAuditLog | Récupère les journaux d'audit des opérations SQL. |
| ListProxySQLExecAuditLog | Récupère les journaux d'audit des endpoints proxy générés par la fonctionnalité de proxy d'accès sécurisé. |
| ListInstanceLoginAuditLog | Récupère les journaux de connexion d'une instance. |
| ListSensitiveDataAuditLog | Récupère les journaux d'audit des données sensibles. |
Gestion du processus d'approbation
| API | Description |
| ListWorkFlowNodes | Récupère la liste des nœuds d'approbation. |
| ListWorkFlowTemplates | Récupère la liste des modèles d'approbation. |
Gestion des métadonnées des bases de données et des tables
| API | Description |
| SearchDatabase | Recherche une base de données. |
| SearchTable | Recherche une table. |
| ListDatabases | Récupère la liste des bases de données d'une instance. |
| ListTables | Récupère la liste des tables d'une base de données. |
| ListColumns | Récupère la liste des colonnes d'une table. |
| ListIndexes | Récupère la liste des index d'une table. |
| GetDatabase | Récupère les détails d'une base de données. |
| GetPhysicalDatabase | Récupère les détails d'une base de données physique. |
| GetTableTopology | Récupère la topologie d'une table. |
| GetMetaTableDetailInfo | Récupère les détails des colonnes et des index d'une table. |
| GetMetaTableColumn | Récupère les détails des colonnes d'une table. |
| SyncInstanceMeta | Synchronise les métadonnées de toutes les bases de données d'une instance. |
| SyncDatabaseMeta | Synchronise les métadonnées d'une base de données. |
Bases de données et tables logiques
| API | Description |
| CreateLogicDatabase | Crée une base de données logique dans DMS. |
| EditLogicDatabase | Modifie les informations d'une base de données logique. |
| DeleteLogicDatabase | Supprime une base de données logique de DMS. |
| ListLogicDatabases | Récupère les détails des bases de données logiques. |
| GetLogicDatabase | Récupère les détails d'une base de données logique. |
| GetDBTopology | Récupère une base de données logique ainsi que la topologie du shard de base de données physique correspondant. |
| ListLogicTables | Récupère la liste des tables logiques d'une base de données logique. |
| GetTableDBTopology | Récupère la topologie d'une table dans une base de données logique et le shard de base de données physique correspondant. |
| AddLogicTableRouteConfig | Ajoute un algorithme de routage à une table logique. |
| DeleteLogicTableRouteConfig | Supprime un algorithme de routage d'une table logique. |
| ListLogicTableRouteConfig | Récupère la liste des algorithmes de routage d'une table logique. |
Gestion des tickets
| Catégorie | API | Description |
| Opérations générales | ApproveOrder | Approuve un ticket. |
| CloseOrder | Clôture un ticket. | |
| GetApprovalDetail | Récupère les détails d'approbation d'un ticket. | |
| GetOrderBaseInfo | Récupère les informations de base d'un ticket. | |
| ListOrders | Récupère la liste des tickets. | |
| CreateOrder | Crée un ticket. | |
| SubmitOrderApproval | Soumet un ticket pour approbation. | |
| Demande d'autorisation | GetOwnerApplyOrderDetail | Récupère les détails d'un ticket utilisé pour configurer le propriétaire d'une instance, d'une base de données ou d'une table. |
| GetPermApplyOrderDetail | Récupère les détails d'un ticket de demande d'autorisations. | |
| Synchronisation de tables entre bases de données | CreateStructSyncOrder | Crée un ticket de synchronisation de schéma. |
| GetStructSyncOrderDetail | Récupère les détails d'un ticket de synchronisation de schéma. | |
| GetStructSyncJobDetail | Récupère les détails d'une tâche de synchronisation de schéma. | |
| GetStructSyncJobAnalyzeResult | Récupère le résultat d'analyse d'une tâche de synchronisation de schéma. | |
| GetStructSyncExecSqlDetail | Récupère les instructions SQL impliquées dans un ticket de synchronisation de schéma. | |
| SubmitStructSyncOrderApproval | Soumet un ticket de synchronisation de schéma pour approbation. | |
| ExecuteStructSync | Exécute un ticket de synchronisation de schéma. | |
| Modification des données | CreateDataCorrectOrder | Crée un ticket de modification des données. |
| CreateDataCronClearOrder | Crée un ticket de nettoyage des données historiques. | |
| CreateDataImportOrder | Crée un ticket d'importation de données. | |
| CreateFreeLockCorrectOrder | Crée un ticket de modification sans verrouillage. | |
| ExecuteDataCorrect | Exécute un ticket de modification des données. | |
| GetDataCorrectTaskDetail | Récupère les détails d'une tâche de modification des données, de modification sans verrouillage ou d'importation de données. | |
| GetDataCronClearTaskDetailList | Récupère la liste des tâches de nettoyage des données historiques. | |
| GetDataCorrectOrderDetail | Récupère les détails d'un ticket de modification des données. | |
| GetDataCorrectBackupFiles | Récupère l'URL de téléchargement des fichiers de sauvegarde pour un ticket de modification des données. | |
| GetDataCorrectSQLFile | Récupère la pièce jointe SQL d'un ticket de modification des données. | |
| ModifyDataCorrectExecSQL | Modifie le script SQL soumis via un ticket de modification des données. | |
| ListDataCorrectPreCheckSQL | Récupère les informations de précontrôle d'une instruction SQL spécifiée dans un ticket de modification des données. | |
| ListDataCorrectPreCheckDB | Récupère la liste des bases de données impliquées dans le précontrôle d'un ticket de modification des données. | |
| PauseDataCorrectSQLJob | Met en pause une tâche SQL de modification des données. | |
| RetryDataCorrectPreCheck | Relance le précontrôle d'un ticket de modification des données. | |
| RestartDataCorrectSQLJob | Relance une tâche SQL de modification des données ayant échoué. | |
| Conception de schéma | CreatePublishGroupTask | Exécute un ticket de conception de schéma. |
| ListDDLPublishRecords | Récupère les détails de publication d'un ticket de conception de schéma. | |
| Exportation de données | GetDataExportDownloadURL | Récupère l'URL de téléchargement des résultats d'exportation pour un ticket d'exportation de données. |
| ExecuteDataExport | Exécute un ticket d'exportation de données. | |
| GetDataExportOrderDetail | Récupère les détails d'un ticket d'exportation de données. | |
| Révision SQL | CreateSQLReviewOrder | Crée un ticket de révision SQL. |
| GetSQLReviewCheckResultStatus | Récupère le résultat de la révision d'un ticket de révision SQL. | |
| ListSQLReviewOriginSQL | Récupère les détails des instructions SQL impliquées dans un ticket de révision SQL. | |
| GetSQLReviewOptimizeDetail | Récupère les détails des suggestions d'optimisation SQL. | |
| Téléchargement de fichier | CreateUploadFileJob | Crée une tâche de téléchargement de fichier. |
| CreateUploadOSSFileJob | Crée une tâche de téléchargement d'un objet depuis Object Storage Service (OSS). | |
| GetUserUploadFileJob | Récupère les informations relatives à une tâche de téléchargement de fichier. |
Gestion des tâches SQL
| API | Description |
| ListDBTaskSQLJob | Récupère la liste des tâches SQL. |
| ListDBTaskSQLJobDetail | Récupère les détails d'une tâche SQL. |
| GetDBTaskSQLJobLog | Récupère le journal enregistrant les détails de planification d'une tâche SQL. |
| GetOnlineDDLProgress | Récupère la progression d'une tâche Online DDL. |
Gestion des autorisations
| API | Description |
| SetOwners | Configure les propriétaires d'une instance, d'une base de données ou d'une table. |
| RevokeUserPermission | Révoque l'autorisation d'un utilisateur sur une ressource. |
| ListUserPermissions | Récupère les autorisations d'un utilisateur sur les bases de données et les tables. |
| ListDatabaseUserPermssions | Récupère les autorisations des utilisateurs sur une base de données. |
| GrantUserPermission | Accorde des autorisations sur une base de données ou une table à un utilisateur. |
| ListInstanceUserPermissions | Récupère les autorisations d'un utilisateur sur une instance. |
Gestion de la sécurité
| Catégorie | API | Description |
| Gestion des ensembles de règles de sécurité | CreateStandardGroup | Crée un ensemble de règles de sécurité. |
| ListStandardGroups | Récupère la liste des ensembles de règles de sécurité. | |
| Proxy d'accès sécurisé | CreateProxy | Active la fonctionnalité de proxy d'accès sécurisé pour une instance de base de données. |
| CreateProxyAccess | Autorise un utilisateur à accéder à une instance de base de données via les endpoints proxy générés par la fonctionnalité de proxy d'accès sécurisé. | |
| ListProxyAccesses | Récupère la liste des utilisateurs autorisés à accéder à une instance de base de données via les endpoints proxy générés par la fonctionnalité de proxy d'accès sécurisé. | |
| InspectProxyAccessSecret | Récupère le secret AccessKey utilisé par un utilisateur autorisé pour se connecter aux endpoints proxy générés par la fonctionnalité de proxy d'accès sécurisé d'une instance de base de données. | |
| ListProxies | Récupère la liste des endpoints proxy générés par la fonctionnalité de proxy d'accès sécurisé. | |
| GetProxy | Récupère les détails d'un endpoint proxy généré par la fonctionnalité de proxy d'accès sécurisé. | |
| DeleteProxyAccess | Révoque les autorisations d'un utilisateur autorisé qui n'accède plus à une instance de base de données via les endpoints proxy générés par la fonctionnalité de proxy d'accès sécurisé. | |
| DeleteProxy | Désactive la fonctionnalité de proxy d'accès sécurisé pour une instance de base de données. | |
| Gestion des champs sensibles | ListSensitiveColumns | Récupère la liste des champs sensibles. |
| ListSensitiveColumnsDetail | Récupère les détails d'un champ sensible. | |
| AddDesensitizationRule | Ajoute une règle de masquage. | |
| ListDesensitizationRule | Récupère la liste des règles de masquage. | |
| ModifyDesensitizationStrategy | Modifie la règle de masquage associée à un champ spécifié. | |
| ListClassificationTemplates | Récupère la liste des modèles de classification. | |
| ChangeColumnSecLevel | Ajuste le niveau de sensibilité d'un champ. |
Requête de données
| API | Description |
| ExecuteScript | Exécute des instructions SQL. |
Développement de données
| Catégorie | API | Description |
| Développement d'entrepôt de données | CreateLakeHouseSpace | Crée un espace de travail pour le développement d'entrepôt de données. |
| GetLhSpaceByName | Récupère les détails d'un espace de travail identifié par son nom. | |
| DeleteLakeHouseSpace | Supprime un espace de travail pour le développement d'entrepôt de données. | |
| ListLhTaskFlowAndScenario | Récupère les informations sur les flux de tâches correspondant à différents scénarios métier dans un espace de travail pour le développement d'entrepôt de données. | |
| AddLhMembers | Ajoute un ou plusieurs administrateurs, membres ou développeurs de flux de tâches à un espace de travail pour le développement d'entrepôt de données. | |
| DeleteLhMembers | Supprime un ou plusieurs membres ou développeurs de flux de tâches d'un espace de travail pour le développement d'entrepôt de données. | |
| ChangeLhDagOwner | Modifie le propriétaire d'un flux de tâches. | |
| Orchestration de tâches | ListTaskFlow | Récupère la liste des flux de tâches. |
| DeleteTaskFlow | Supprime un flux de tâches. | |
| OfflineTaskFlow | Dépublie un flux de tâches publié. | |
| ListTaskFlowInstance | Récupère les journaux d'exécution d'un flux de tâches. | |
| GetTaskInstanceRelation | Récupère les informations sur les nœuds d'un journal d'exécution d'un flux de tâches. | |
| ListDAGVersions | Récupère la liste des versions publiées d'un flux de tâches. | |
| ReDeployLhDagVersion | Redéploie une ou toutes les versions publiées d'un flux de tâches. | |
| CreateTaskFlow | Crée un flux de tâches. | |
| DeleteTask | Supprime une tâche d'un flux de tâches spécifié. | |
| MakeTaskFlowInstanceSuccess | Définit le statut d'un flux de tâches spécifié sur « Réussi ». | |
| SuspendTaskFlowInstance | Suspend une instance de flux de tâches en cours d'exécution. | |
| PublishAndDeployTaskFlow | Publie et déploie un flux de tâches spécifié. | |
| ListTasksInTaskFlow | Récupère la liste des tâches d'un flux de tâches spécifié. | |
| UpdateTaskConfig | Met à jour la configuration avancée d'une tâche spécifiée. | |
| ListTaskFlowConstants | Récupère la liste des constantes d'un flux de tâches spécifié. | |
| UpdateTaskFlowConstants | Met à jour les constantes d'un flux de tâches spécifié. | |
| ResumeTaskFlowInstance | Reprend un flux de tâches suspendu. | |
| ListTaskFlowsByPage | Récupère les journaux d'exécution des flux de tâches par page. | |
| UpdateTaskContent | Met à jour la configuration d'un nœud de tâche spécifié. | |
| UpdateScenario | Met à jour le nom et la description d'un scénario métier spécifié d'un flux de tâches. | |
| ListScenarios | Récupère la liste des scénarios métier. | |
| DeleteScenario | Supprime un scénario métier. | |
| CreateScenario | Crée un scénario métier. | |
| UpdateTaskTimeVariables | Met à jour les variables temporelles d'une tâche spécifiée. | |
| UpdateTaskFlowTimeVariables | Met à jour les variables temporelles d'un flux de tâches spécifié. | |
| ListTaskFlowTimeVariables | Récupère la liste des variables temporelles d'un flux de tâches spécifié. | |
| UpdateTaskFlowCooperators | Met à jour la liste des utilisateurs impliqués dans un flux de tâches spécifié. | |
| MoveTaskFlowToScenario | Déplace un flux de tâches vers un scénario métier spécifié. | |
| UpdateTaskName | Met à jour le nom d'un nœud de tâche spécifié. | |
| ListTaskFlowCooperators | Récupère la liste des utilisateurs impliqués dans un flux de tâches spécifié. | |
| UpdateTaskOutput | Met à jour les variables de sortie d'un nœud de tâche spécifié. | |
| GetTask | Récupère la configuration d'un nœud de tâche spécifié, y compris ses variables temporelles. | |
| UpdateTaskFlowSchedule | Met à jour les paramètres de planification d'un flux de tâches spécifié. | |
| StopTaskFlowInstance | Arrête une instance de flux de tâches en cours d'exécution. | |
| ReRunTaskFlowInstance | Relance une instance de flux de tâches. | |
| CreateTask | Crée un nœud de tâche pour un flux de tâches spécifié. | |
| UpdateTaskFlowNotification | Met à jour les paramètres de notification des flux de tâches. | |
| DeleteTaskFlowEdgesByCondition | Supprime les arêtes d'un flux de tâches selon plusieurs conditions. | |
| ListTaskFlowEdgesByCondition | Récupère la liste des arêtes du graphe acyclique dirigé (DAG) d'un flux de tâches spécifié selon plusieurs conditions. | |
| UpdateTaskFlowEdges | Met à jour simultanément plusieurs nœuds de début et de fin des arêtes d'un flux de tâches spécifié. | |
| GetTaskFlowGraph | Récupère le DAG d'un flux de tâches. | |
| UpdateTaskFlowRelations | Met à jour toutes les arêtes d'un flux de tâches spécifié. | |
| UpdateTaskFlowNameAndDesc | Met à jour le nom et la description d'un flux de tâches spécifié. | |
| UpdateTaskFlowOwner | Met à jour le propriétaire d'un flux de tâches spécifié. | |
| BackFill | Effectue un remplissage rétroactif des données pour l'orchestration de tâches. |