The following tables list API operations available for use in Data Management (DMS).
User management
| Operation | 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 the information about a user. |
| ListUsers | Queries users. |
| ListUserTenants | Queries tenants. |
| GetUserActiveTenant | Queries the details of the current tenant. |
| GetUser | Queries details of a user. |
Instance management
| Operation | Description |
|---|---|
| RegisterInstance | Adds a database instance for your enterprise. |
| UpdateInstance | Updates the information about a database instance and checks the connectivity of the instance. |
| GetInstance | Queries the details of a database instance. |
| DeleteInstance | Deletes a database instance from DMS Enterprise. |
| ListInstances | Queries database instances and details of individual database instances. |
Operation audit
| Operation | Description |
|---|---|
| GetOpLog | Queries details of operations logs generated within a specified period. |
| ListSQLExecAuditLog | Queries the audit logs of SQL operations. |
| ListInstanceLoginAuditLog | Queries the logon records of an instance. |
Approval process management
| Operation | Description |
|---|---|
| ListWorkFlowNodes | Queries approval nodes. |
| ListWorkFlowTemplates | Queries approval templates. |
Database and table metadata management
| Operation | Description |
|---|---|
| SearchDatabase | Queries databases. |
| SearchTable | Queries tables. |
| ListDatabases | Queries the databases in a database instance. |
| ListLogicDatabases | Queries logical databases. |
| ListTables | Queries tables in a database. |
| ListLogicTables | Queries the logical tables in a logical database. |
| ListColumns | Queries the columns in a table. |
| ListIndexes | Queries the indexes of a table. |
| GetDatabase | Queries the details of a database. |
| GetPhysicalDatabase | Queries the details of a physical database. |
| GetLogicDatabase | Queries the details of a logical database. |
| GetDBTopology | Queries a logical database and the topology of the physical database shard that corresponds to the logical database. |
| GetTableTopology | Queries the topology of a table. |
| GetTableDBTopology | Queries the topology of a table. |
| GetMetaTableDetailInfo | Queries the details, such as columns and indexes, of a table. |
| GetMetaTableColumn | Queries the details of columns in a table. |
| SyncInstanceMeta | Synchronizes the metadata of all databases in an instance. |
| SyncDatabaseMeta | Synchronizes metadata of a database. |
| CreateLogicDatabase | Creates a logical database in DMS. |
| EditLogicDatabase | Modifies the information about a logical database. |
| DeleteLogicDatabase | Deletes a logical database from DMS. |
Ticket management
| Category | Operation | Description |
|---|---|---|
| General | ApproveOrder | Approves a ticket. |
| CloseOrder | Closes a ticket. | |
| GetApprovalDetail | Queries the approval details of a ticket. | |
| GetOrderBaseInfo | Queries the basic information about a ticket. | |
| ListOrders | Queries tickets. | |
| CreateOrder | Creates a ticket. | |
| SubmitOrderApproval | Submits a ticket for approval. | |
| Permission application | GetOwnerApplyOrderDetail | Queries the details of Instance-OWNER, Table-OWNER, and Database-OWNER tickets. |
| GetPermApplyOrderDetail | Queries the details of a permission application ticket. | |
| Database and table synchronization | CreateStructSyncOrder | Creates a schema synchronization ticket. |
| GetStructSyncOrderDetail | Queries the details of a schema synchronization ticket. | |
| GetStructSyncJobDetail | Queries the details of a schema synchronization task. | |
| GetStructSyncJobAnalyzeResult | Queries the analysis result of a schema synchronization task. | |
| GetStructSyncExecSqlDetail | Queries the SQL statements that are involved in a schema synchronization ticket. | |
| SubmitStructSyncOrderApproval | Submits a schema synchronization ticket for approval. | |
| ExecuteStructSync | Executes a schema synchronization ticket. | |
| Data change | CreateDataCorrectOrder | Creates a normal data modify ticket. |
| CreateDataCronClearOrder | Creates a history data clean ticket. | |
| CreateDataImportOrder | Creates a data import ticket. | |
| CreateFreeLockCorrectOrder | Creates a lockless change ticket. | |
| ExecuteDataCorrect | Executes a data change ticket. | |
| GetDataCorrectTaskDetail | Queries the execution details of normal data modify, lockless change, and data import tickets. | |
| GetDataCronClearTaskDetailList | Queries history data clean tasks. | |
| GetDataCorrectOrderDetail | Queries the details of a data change ticket. | |
| GetDataCorrectBackupFiles | Queries the download URL of backup files for a data change. | |
| GetDataCorrectSQLFile | Queries the SQL attachment of a data change ticket. | |
| ListDataCorrectPreCheckSQL | Queries the precheck information about an SQL statement that is specified in a data change ticket. | |
| ListDataCorrectPreCheckDB | Queries the databases that are involved in the precheck of a data change ticket. | |
| Schema design | CreatePublishGroupTask | Executes a ticket to change a schema design. |
| ListDDLPublishRecords | Queries the publishing details of a schema design ticket. | |
| Data export | GetDataExportDownloadURL | Queries the download URL of export results for a data export ticket. |
| ExecuteDataExport | Executes a data export ticket. | |
| GetDataExportOrderDetail | Queries the details of a data export ticket. | |
| SQL review | CreateSQLReviewOrder | Creates an SQL review ticket. |
| GetSQLReviewCheckResultStatus | Queries the review result of an SQL review ticket. | |
| ListSQLReviewOriginSQL | Queries the details of the SQL statements that are involved in an SQL review ticket. | |
| GetSQLReviewOptimizeDetail | Queries the details of SQL optimization suggestions. | |
| File upload | CreateUploadFileJob | Creates a file upload task. |
| CreateUploadOSSFileJob | Creates a task for uploading an Object Storage Service (OSS) file. | |
| GetUserUploadFileJob | Queries the information about a file upload task. |
SQL task management
| Operation | Description |
|---|---|
| ListDBTaskSQLJob | Queries SQL tasks. |
| ListDBTaskSQLJobDetail | Queries the details of an SQL task. |
Permission management
| Operation | 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
| Category | Operation | Description |
|---|---|---|
| Data security protection | CreateProxy | Enables the data security protection feature for a database instance. |
| CreateProxyAccess | Authorizes a user to access a database instance by using the proxy endpoints generated by the data security protection feature. | |
| ListProxyAccesses | Queries users that are authorized to access a database instance by using the proxy endpoints generated by the data security protection feature. | |
| InspectProxyAccessSecret | Queries the AccessSecret that an authorized user uses to connect to the proxy endpoints generated by the data security protection feature for a database instance. | |
| ListProxies | Queries the proxy endpoints that are generated by the data security protection feature. | |
| GetProxy | Queries the details of a proxy endpoint that is generated by the data security protection feature. | |
| DeleteProxyAccess | Revokes permissions from an authorized user who no longer accesses a database instance by using the proxy endpoints generated by the data security protection feature. | |
| DeleteProxy | Disables the data security protection feature for a database instance. | |
| Sensitive field management | ListSensitiveColumns | Queries sensitive fields. |
| ListSensitiveColumnsDetail | Queries the details of a sensitive field. | |
| ChangeColumnSecLevel | Adjusts the sensitivity level of a field. |
Data query
| Operation | Description |
|---|---|
| ExecuteScript | Executes SQL statements. |