API overview
Updated at:
Data Management provides the following API operations.
Orders
| API | Description |
| BuyPayAsYouGoOrder | Call BuyPayAsYouGoOrder to purchase pay-as-you-go DMS products. |
| RefundPayAsYouGoOrder | Call RefundPayAsYouGoOrder to unsubscribe from purchased pay-as-you-go DMS products. |
| ListEffectiveOrders | Call ListEffectiveOrders to query the list of effective orders. |
User management
| API | Description |
| RegisterUser | Call RegisterUser to add a new user to your enterprise. |
| DisableUser | Call DisableUser to disable an Alibaba Cloud account that is temporarily not needed in the product. |
| EnableUser | Call EnableUser to enable a previously disabled Alibaba Cloud account in the product. |
| DeleteUser | Call DeleteUser to delete an unnecessary Alibaba Cloud account from the product. |
| UpdateUser | Call UpdateUser to update user information. |
| ListUsers | Call the ListUsers operation to obtain a list of user details. |
| ListUserTenants | Call ListUserTenants to obtain the list of current tenants. |
| GetUserActiveTenant | Call GetUserActiveTenant to obtain information about the current tenant. |
| GetUser | Call GetUser to obtain user information. |
Instance management
| API | Description |
| RegisterInstance | Call RegisterInstance to add a new database instance to your enterprise. |
| UpdateInstance | Call UpdateInstance to update instance information and check connectivity. |
| GetInstance | Call GetInstance to obtain the details of an instance. |
| DeleteInstance | Call DeleteInstance to delete an instance managed by DMS Enterprise. |
| ListInstances | Call ListInstances to search the instance list and obtain instance details. |
Operation audit
| API | Description |
| GetOpLog | Call GetOpLog to obtain a list of operation log details within a specified time range. |
| ListSQLExecAuditLog | Call ListSQLExecAuditLog to obtain the list of audit logs for SQL windows. |
| ListProxySQLExecAuditLog | Call ListProxySQLExecAuditLog to obtain the list of audit information for the secure access proxy. |
| ListInstanceLoginAuditLog | Call ListInstanceLoginAuditLog to obtain the list of instance logon information. |
| ListSensitiveDataAuditLog | Call the ListSensitiveDataAuditLog operation to view the details of sensitive data audit logs. |
Approval flows
| API | Description |
| ListWorkFlowNodes | Call ListWorkFlowNodes to obtain the list of approval nodes. |
| ListWorkFlowTemplates | Call ListWorkFlowTemplates to obtain the list of approval templates. |
Database and table metadata
| API | Description |
| SearchDatabase | Call SearchDatabase to search for database details. |
| SearchTable | Call SearchTable to search for a list of table details. |
| ListDatabases | Call ListDatabases to obtain the details of databases in an instance. |
| ListTables | Call ListTables to obtain a list of table details in a database. |
| ListColumns | Call ListColumns to return the column information of a table. |
| ListIndexes | Call ListIndexes to return the index information of a table. |
| GetDatabase | Call GetDatabase to obtain the details of a specific database. |
| GetPhysicalDatabase | Call GetPhysicalDatabase to obtain the details of a physical database. |
| GetTableTopology | Call GetTableTopology to obtain the topology of a data table. |
| GetMetaTableDetailInfo | Call the GetMetaTableDetailInfo operation to obtain information about a table, such as its fields and indexes. |
| GetMetaTableColumn | Call the GetMetaTableColumn operation to obtain the field information of a table. |
| SyncInstanceMeta | Call SyncInstanceMeta to synchronize the metadata of all database dictionaries in an instance. |
| SyncDatabaseMeta | Call SyncDatabaseMeta to synchronize the metadata of a database dictionary. |
Logical databases and tables
| API | Description |
| CreateLogicDatabase | Call CreateLogicDatabase to create a DMS logical database. |
| EditLogicDatabase | Call EditLogicDatabase to edit the information of a DMS logical database. |
| DeleteLogicDatabase | Call DeleteLogicDatabase to delete a DMS logical database. |
| ListLogicDatabases | Call ListLogicDatabases to obtain a list of logical databases. |
| GetLogicDatabase | Call GetLogicDatabase to obtain the details of a logical database. |
| GetDBTopology | Call GetDBTopology to obtain the topology of a logical database and its corresponding physical sharded databases. |
| ListLogicTables | Call ListLogicTables to obtain a list of logical table details in a specified logical database. |
| GetTableDBTopology | Call the GetTableDBTopology operation to obtain the topology graph of a data table. |
| AddLogicTableRouteConfig | Call AddLogicTableRouteConfig to add a routing algorithm configuration for a logical table. |
| DeleteLogicTableRouteConfig | Call DeleteLogicTableRouteConfig to delete the routing algorithm configuration of a logical table. |
| ListLogicTableRouteConfig | Call ListLogicTableRouteConfig to obtain the list of routing algorithm configurations for a logical table. |
Ticket operations
| Category | API | Description |
| General | ApproveOrder | Call ApproveOrder to process a ticket approval. |
| CloseOrder | Call CloseOrder to close a ticket. | |
| GetApprovalDetail | Call GetApprovalDetail to obtain the approval details of a ticket. | |
| GetOrderBaseInfo | Call GetOrderBaseInfo to obtain the basic information of a ticket. | |
| ListOrders | Call ListOrders to obtain a list of tickets. | |
| CreateOrder | Call CreateOrder to create a ticket. | |
| SubmitOrderApproval | Call SubmitOrderApproval to submit a ticket for approval. | |
| Permission request | GetOwnerApplyOrderDetail | Call GetOwnerApplyOrderDetail to obtain the details of a ticket for requesting database, table, or instance ownership. |
| GetPermApplyOrderDetail | Call GetPermApplyOrderDetail to obtain the details of a permission request ticket. | |
| Database and table synchronization | CreateStructSyncOrder | Call CreateStructSyncOrder to create a schema synchronization ticket. |
| GetStructSyncOrderDetail | Call GetStructSyncOrderDetail to obtain the details of a schema synchronization ticket. | |
| GetStructSyncJobDetail | Call GetStructSyncJobDetail to obtain the details of a schema synchronization task. | |
| GetStructSyncJobAnalyzeResult | Call GetStructSyncJobAnalyzeResult to obtain the analysis result of a schema synchronization task. | |
| GetStructSyncExecSqlDetail | Call GetStructSyncExecSqlDetail to obtain the SQL script for a schema synchronization task. | |
| SubmitStructSyncOrderApproval | Call SubmitStructSyncOrderApproval to submit a schema synchronization ticket to the approval flow. | |
| ExecuteStructSync | Call ExecuteStructSync to execute a schema synchronization ticket. | |
| Data change | CreateDataCorrectOrder | Call CreateDataCorrectOrder to create a standard data change ticket. |
| CreateDataCronClearOrder | Call CreateDataCronClearOrder to create a historical data cleanup ticket. | |
| CreateDataImportOrder | Call CreateDataImportOrder to create a data import ticket. | |
| CreateFreeLockCorrectOrder | Call CreateFreeLockCorrectOrder to create a lockless change ticket. | |
| ExecuteDataCorrect | Call ExecuteDataCorrect to execute a data change ticket. | |
| GetDataCorrectTaskDetail | Call GetDataCorrectTaskDetail to obtain the execution details of a standard data change, lockless change, or data import ticket. | |
| GetDataCronClearTaskDetailList | Call GetDataCronClearTaskDetailList to obtain the execution list of historical data cleanup tasks. | |
| GetDataCorrectOrderDetail | Call GetDataCorrectOrderDetail to obtain the details of a data change ticket. | |
| GetDataCorrectBackupFiles | Call GetDataCorrectBackupFiles to obtain the download URL for the backup file attachment of a data change. | |
| GetDataCorrectSQLFile | Call GetDataCorrectSQLFile to obtain the SQL script attachment for a data change ticket. | |
| ModifyDataCorrectExecSQL | Call ModifyDataCorrectExecSQL to modify the SQL script submitted in a data change ticket. | |
| ListDataCorrectPreCheckSQL | Call ListDataCorrectPreCheckSQL to obtain the SQL details of the precheck step in a data change ticket. | |
| ListDataCorrectPreCheckDB | Call ListDataCorrectPreCheckDB to obtain the database list of the precheck step in a data change ticket. | |
| PauseDataCorrectSQLJob | Call PauseDataCorrectSQLJob to pause a running data change SQL task. | |
| RetryDataCorrectPreCheck | Call RetryDataCorrectPreCheck to re-execute the precheck step of a data change ticket. | |
| RestartDataCorrectSQLJob | Call RestartDataCorrectSQLJob to retry a failed data change SQL task. | |
| Schema design | CreatePublishGroupTask | Call CreatePublishGroupTask to execute a schema design change. |
| ListDDLPublishRecords | Call ListDDLPublishRecords to obtain the publishing details of a schema design ticket. | |
| Data exporting | GetDataExportDownloadURL | Call GetDataExportDownloadURL to obtain the download URL for the data exporting result attachment. |
| ExecuteDataExport | Call ExecuteDataExport to execute a data exporting ticket. | |
| GetDataExportOrderDetail | Call GetDataExportOrderDetail to obtain the details of a data exporting ticket. | |
| SQL review | CreateSQLReviewOrder | Call CreateSQLReviewOrder to create an SQL review ticket. |
| GetSQLReviewCheckResultStatus | Call GetSQLReviewCheckResultStatus to obtain the review result of an SQL review ticket. | |
| ListSQLReviewOriginSQL | Call ListSQLReviewOriginSQL to obtain the SQL details from an SQL review ticket. | |
| GetSQLReviewOptimizeDetail | Call GetSQLReviewOptimizeDetail to obtain the details of optimization suggestions from an SQL review. | |
| Attachment upload | CreateUploadFileJob | Call the CreateUploadFileJob operation to create a task for uploading an attachment. |
| CreateUploadOSSFileJob | Call the CreateUploadOSSFileJob operation to create a task for uploading an OSS attachment. | |
| GetUserUploadFileJob | Call GetUserUploadFileJob to obtain the task information for an uploaded attachment. |
SQL tasks
| API | Description |
| ListDBTaskSQLJob | Call ListDBTaskSQLJob to obtain a list of SQL tasks. |
| ListDBTaskSQLJobDetail | Call ListDBTaskSQLJobDetail to obtain the details of an SQL task. |
| GetDBTaskSQLJobLog | Call GetDBTaskSQLJobLog to obtain the scheduling detail logs of an SQL task. |
| GetOnlineDDLProgress | Call the GetOnlineDDLProgress operation to obtain the execution progress details of an Online DDL task. |
Permission management
| API | Description |
| SetOwners | Call SetOwners to set database and table owners. |
| RevokeUserPermission | Call RevokeUserPermission to revoke user permissions. |
| ListUserPermissions | Call ListUserPermissions to display the database and table permissions of a specified user. |
| ListDatabaseUserPermssions | Call ListDatabaseUserPermssions to display the permission details of users who have permissions on a specified database. |
| GrantUserPermission | Call GrantUserPermission to grant database and table permissions to a user. |
| ListInstanceUserPermissions | Call ListInstanceUserPermissions to obtain the list of user permissions for an instance. |
Security management
| Category | API | Description |
| Security rule sets | CreateStandardGroup | Call CreateStandardGroup to create a security rule set. |
| ListStandardGroups | Call ListStandardGroups to obtain a list of security rule sets. | |
| Secure access proxy | CreateProxy | Call CreateProxy to enable the data security protection proxy for a database instance. |
| CreateProxyAccess | Call CreateProxyAccess to authorize a user to access a database instance through the data security protection proxy. | |
| ListProxyAccesses | Call ListProxyAccesses to obtain the authorization list for the security protection proxy. | |
| InspectProxyAccessSecret | Call InspectProxyAccessSecret to obtain the authorization password for the security protection proxy. | |
| ListProxies | Call ListProxies to obtain a list of security protection proxies. | |
| GetProxy | Call GetProxy to obtain the details of a data security protection proxy. | |
| DeleteProxyAccess | Call DeleteProxyAccess to revoke the data security protection authorization of a target user. | |
| DeleteProxy | Call DeleteProxy to disable the data security protection proxy for a database instance. | |
| Sensitive fields | ListSensitiveColumns | Call ListSensitiveColumns to search for a list of sensitive fields. |
| ListSensitiveColumnsDetail | Call ListSensitiveColumnsDetail to obtain the details of sensitive fields. | |
| AddDesensitizationRule | Call AddDesensitizationRule to add a desensitization rule. | |
| ListDesensitizationRule | Call ListDesensitizationRule to obtain a list of desensitization rules. | |
| ModifyDesensitizationStrategy | Call ModifyDesensitizationStrategy to modify the desensitization rule attached to a field. | |
| ListClassificationTemplates | Call the ListClassificationTemplates operation to obtain a list of classification templates. | |
| ChangeColumnSecLevel | Call ChangeColumnSecLevel to change the sensitivity level of a field. |
Data query
| API | Description |
| ExecuteScript | Call ExecuteScript to execute an SQL script. |
Data development
| Category | API | Description |
| Data warehouse development | CreateLakeHouseSpace | Call the CreateLakeHouseSpace operation to create a new project in data warehouse development. |
| GetLhSpaceByName | Call the GetLhSpaceByName operation to query project information by project name. | |
| DeleteLakeHouseSpace | Call the DeleteLakeHouseSpace operation to delete a project in data warehouse development. | |
| ListLhTaskFlowAndScenario | Call the ListLhTaskFlowAndScenario operation to query the list of task flows that correspond to a business scenario in a project. | |
| AddLhMembers | Call the AddLhMembers operation to add an administrator, member, or task flow developer to a data warehouse development project. | |
| DeleteLhMembers | Call the DeleteLhMembers operation to delete a member or task flow developer from a data warehouse development project. | |
| ChangeLhDagOwner | Call the ChangeLhDagOwner operation to change the owner of a task flow. | |
| Task orchestration | ListTaskFlow | Call the ListTaskFlow operation to obtain a list of task flows. |
| DeleteTaskFlow | Call the DeleteTaskFlow operation to delete a task flow. | |
| OfflineTaskFlow | Call the OfflineTaskFlow operation to unpublish a published task flow in DMS. | |
| ListTaskFlowInstance | Call the ListTaskFlowInstance operation to obtain the running records of a task flow. | |
| GetTaskInstanceRelation | Call the GetTaskInstanceRelation operation to obtain the node information of a task flow running record. | |
| ListDAGVersions | Call the ListDAGVersions operation to obtain a list of historical published versions of a task flow. | |
| ReDeployLhDagVersion | Call the ReDeployLhDagVersion operation to redeploy a historical version of a task flow. | |
| CreateTaskFlow | Call the CreateTaskFlow operation to create a task flow. | |
| DeleteTask | Call the DeleteTask operation to delete a task in a task flow. | |
| MakeTaskFlowInstanceSuccess | Call the MakeTaskFlowInstanceSuccess operation to set the status of a specified task flow to successful. | |
| SuspendTaskFlowInstance | Call the SuspendTaskFlowInstance operation to pause a running task flow instance. | |
| PublishAndDeployTaskFlow | Call the PublishAndDeployTaskFlow operation to publish and deploy a specified task flow. | |
| ListTasksInTaskFlow | Call the ListTasksInTaskFlow operation to obtain the list of task nodes in a specified task flow. | |
| UpdateTaskConfig | Call the UpdateTaskConfig operation to update the advanced configuration of a task. | |
| ListTaskFlowConstants | Call the ListTaskFlowConstants operation to obtain the list of constants for a task flow. | |
| UpdateTaskFlowConstants | Call the UpdateTaskFlowConstants operation to update the list of constants for a task flow. | |
| ResumeTaskFlowInstance | Call the ResumeTaskFlowInstance operation to resume a paused task flow. | |
| ListTaskFlowsByPage | Call the ListTaskFlowsByPage operation to obtain a paginated list of task flow running records. | |
| UpdateTaskContent | Call the UpdateTaskContent operation to update a task in a task flow. | |
| UpdateScenario | Call the UpdateScenario operation to update the name and description of a task flow business scenario. | |
| ListScenarios | Call the ListScenarios operation to obtain a list of business scenarios. | |
| DeleteScenario | Call the DeleteScenario operation to delete a business scenario. | |
| CreateScenario | Call the CreateScenario operation to create a business scenario. You can also use it to group task flows by business scenario. | |
| UpdateTaskTimeVariables | Call the UpdateTaskTimeVariables operation to update the time variables of a task. | |
| UpdateTaskFlowTimeVariables | Call the UpdateTaskFlowTimeVariables operation to update the time variables of a task flow. | |
| ListTaskFlowTimeVariables | Call the ListTaskFlowTimeVariables operation to obtain the list of time variables for a task flow. | |
| UpdateTaskFlowCooperators | Call the UpdateTaskFlowCooperators operation to update the list of personnel related to a task flow. | |
| MoveTaskFlowToScenario | Call the MoveTaskFlowToScenario operation to move a task flow to a specified business scenario. | |
| UpdateTaskName | Call the UpdateTaskName operation to update a task name. | |
| ListTaskFlowCooperators | Call the ListTaskFlowCooperators operation to obtain the list of personnel related to a task flow. | |
| UpdateTaskOutput | Call the UpdateTaskOutput operation to update the output variables of a task node. | |
| GetTask | Call the GetTask operation to obtain the configuration of a specified node by its ID, including the time variables of the task. | |
| UpdateTaskFlowSchedule | Call the UpdateTaskFlowSchedule operation to update the scheduling configuration of a task flow. | |
| StopTaskFlowInstance | Call the StopTaskFlowInstance operation to stop a running task flow instance. | |
| ReRunTaskFlowInstance | Call the ReRunTaskFlowInstance operation to rerun a task flow instance. | |
| CreateTask | Call the CreateTask operation to create a task in a task flow. | |
| UpdateTaskFlowNotification | Call the UpdateTaskFlowNotification operation to update the notification settings of a task flow. | |
| DeleteTaskFlowEdgesByCondition | Call the DeleteTaskFlowEdgesByCondition operation to delete the edges of a task flow based on multiple conditions. | |
| ListTaskFlowEdgesByCondition | Call the ListTaskFlowEdgesByCondition operation to obtain the edges of a directed acyclic graph (DAG) for a specified task flow based on multiple conditions. | |
| UpdateTaskFlowEdges | Call the UpdateTaskFlowEdges operation to batch update the start and end nodes of specified edges in a task flow. | |
| AddTaskFlowEdges | Call the AddTaskFlowEdges operation to create directed edges for existing task flow nodes. | |
| GetTaskFlowGraph | Call the GetTaskFlowGraph operation to obtain the DAG of a task flow. | |
| UpdateTaskFlowRelations | Call the UpdateTaskFlowRelations operation to perform a full update on the edges of a task flow. | |
| UpdateTaskFlowNameAndDesc | Call the UpdateTaskFlowNameAndDesc operation to update the name and description of a task flow. | |
| UpdateTaskFlowOwner | Call the UpdateTaskFlowOwner operation to update the owner of a task flow. | |
| GetTaskFlowNotification | Call the GetTaskFlowNotification operation to obtain the notification settings of a task flow. | |
| BackFill | Call the BackFill operation to backfill data for task orchestration. |
Is this page helpful?