The following tables list API operations available for use in Data Management (DMS).

User Management option

API Description
RegisterUser Adds a user for your enterprise.
DisableUser Disables a user that is temporarily not used.
EnableUser Enables a user that has been disabled.
DeleteUser Deletes a user that is no longer needed.
UpdateUser Updates information of a user.
ListUsers Queries details of users.
ListUserTenants You can call this operation to query the list of tenants.
GetUserActiveTenant Queries details of the active tenant.
GetUser Queries details of a user.

Instances

API Description
RegisterInstance Adds a database instance for your enterprise.
UpdateInstance Updates information of a database instance and checks the connectivity of the instance.
GetInstance Queries details of a database instance.
DeleteInstance Deletes a database instance from DMS Enterprise.
ListInstances Queries database instances and details of individual database instances.

Operations log management

API Description
GetOpLog Queries details of operations logs generated within a specified period.

Approval process management

API Description
ListWorkFlowNodes Queries details of approval nodes.
ListWorkFlowTemplates Queries details of approval templates.

Database and table metadata management

API Description
GetDatabase Queries details of a database.
GetPhysicalDatabase You can call the GetPhysicalDatabase to obtain the details of a physical library.
ListColumns Queries details of columns in a table.
ListIndexes Queries details of indexes of a table.
GetLogicDatabase Queries details of a logical database.
ListDatabases Queries details of databases in an instance.
ListLogicDatabases Queries details of logical databases.
ListLogicTables Queries details of logical tables in a logical database.
SearchDatabase Queries details of databases.
SearchTable Queries details of tables.
ListTables Queries details of tables in a database.
GetMetaTableDetailInfo Queries the details of a table. These details include columns and indexes.
GetTableDBTopology Queries the topology of a table.
GetTableTopology You can call the GetTableTopology to obtain the topology information of a data table.
GetDBTopology You can call this operation to obtain the topology information of a logical database and its corresponding physical database shards.
GetMetaTableColumn Queries the details about columns in a table.
SyncDatabaseMeta Synchronizes metadata of a database.
SyncInstanceMeta Synchronizes the metadata of all databases in an instance.

Ticket operations

Description API Description
General ApproveOrder Approves a ticket.
CloseOrder Closes a ticket.
GetApprovalDetail Queries the approval details of a ticket.
GetOrderBaseInfo Queries basic information of a ticket.
ListOrders Queries details of tickets.
CreateOrder Creates a ticket.
SubmitOrderApproval Submits a ticket for approval.
Request permissions GetOwnerApplyOrderDetail You can call this operation to obtain the ticket details of the application database-owner, table-owner, and instance-owner GetOwnerApplyOrderDetail.
GetPermApplyOrderDetail You can call this operation to obtain the details of a ticket for GetPermApplyOrderDetail permission application.
Table synchronization between databases CreateStructSyncOrder You can call this operation to create a schema synchronization ticket CreateStructSyncOrder.
GetStructSyncOrderDetail You can call this operation to obtain the ticket details for schema synchronization GetStructSyncOrderDetail.
GetStructSyncJobDetail Queries the details of a schema synchronization task.
GetStructSyncJobAnalyzeResult You can call this operation to obtain the analysis result of a task for schema synchronization GetStructSyncJobAnalyzeResult.
GetStructSyncExecSqlDetail Call the GetStructSyncExecSqlDetail to obtain the SQL script for schema synchronization.
SubmitStructSyncOrderApproval You can call the SubmitStructSyncOrderApproval to submit a schema synchronization ticket to the approval process.
ExecuteStructSync You can call this operation to ExecuteStructSync a schema synchronization ticket.
Data change issues CreateDataCorrectOrder Creates a ticket for changing data.
CreateDataCronClearOrder Creates a ticket for deleting historical data.
CreateDataImportOrder Creates a ticket for importing data to Data Management (DMS).
CreateFreeLockCorrectOrder Creates a ticket for changing data without locking tables.
ExecuteDataCorrect Executes a ticket to change data.
GetDataCorrectTaskDetail You can call this operation to GetDataCorrectTaskDetail obtain the execution details of general data change, lock-free change, and data import ticket tasks.
GetDataCronClearTaskDetailList You can call this operation to GetDataCronClearTaskDetailList a list of historical data cleanup tasks.
GetDataCorrectOrderDetail Queries details of a data change ticket.
GetDataCorrectBackupFiles Queries the download URL of backup files for a data change.
GetDataCorrectSQLFile You can call the GetDataCorrectSQLFile to obtain the SQL script attachment for a data change ticket.
Schema design CreatePublishGroupTask Executes a ticket to make a schema design change.
ListDDLPublishRecords You can call the ListDDLPublishRecords to obtain the publishing details of a structure design ticket.
Data export GetDataExportDownloadURL Queries the download URL of export results for a data export ticket.
ExecuteDataExport Executes a ticket to export data.
GetDataExportOrderDetail Queries details of a data export ticket.
SQL review CreateSQLReviewOrder You can call this operation to create an SQL audit ticket by CreateSQLReviewOrder.
GetSQLReviewCheckResultStatus You can call this operation to obtain the audit result of an SQL audit ticket by GetSQLReviewCheckResultStatus.
ListSQLReviewOriginSQL You can call the ListSQLReviewOriginSQL to obtain the SQL details result of an SQL audit ticket.
Attachment upload CreateUploadFileJob You can call the CreateUploadFileJob operation to create an attachment upload task.
CreateUploadOSSFileJob You can call the CreateUploadOSSFileJob operation to create a task for uploading OSS attachments.
GetUserUploadFileJob You can call this operation to obtain information about a task that uploads an attachment GetUserUploadFileJob.

SQL tasks

API Description
ListDBTaskSQLJob You can call the ListDBTaskSQLJob to obtain the list of SQL tasks.
ListDBTaskSQLJobDetail You can call the ListDBTaskSQLJobDetail to obtain the details of an SQL task.

Permission Management

API Description
SetOwners Configures the owners of a database or a table.
RevokeUserPermission Revokes the permissions on a specified resource from a user.
ListUserPermissions Queries the permissions of a user on databases and tables.
ListDatabaseUserPermssions Queries the permissions of users on a database.
GrantUserPermission Grants permissions on a database or table to a user.

Security management

Description API Description
Data security protection CreateProxy You can call this operation to enable the data security protection proxy of a database instance.
CreateProxyAccess You can call the CreateProxyAccess to authorize users to access the DB instance through the Data Security Protection agent.
ListProxyAccesses You can call this operation to obtain the authorization list of the security protection agent by ListProxyAccesses.
InspectProxyAccessSecret You can call this operation to obtain the authorization password of the security protection agent InspectProxyAccessSecret.
ListProxies You can call this operation to obtain a list of security protection agents.
GetProxy You can call this operation to obtain the details of a data security protection agent.
DeleteProxyAccess You can call this operation to DeleteProxyAccess reclaim the data security protection authorization of the target user.
DeleteProxy You can call this operation to disable the data security protection proxy of a DB instance.
Sensitive fields ListSensitiveColumns Queries the list of sensitive columns.
ListSensitiveColumnsDetail Queries details of a sensitive column.

Data query

API Description
ExecuteScript Executes SQL statements.