The following tables list API operations available for use in Data Management (DMS).
User management
| Operation | Description |
|---|---|
| RegisterUser | Adds a user to DMS Enterprise of your enterprise. |
| DisableUser | Disables a user that is temporarily not used in DMS Enterprise. |
| EnableUser | Enables a user that has been disabled in DMS Enterprise. |
| DeleteUser | Deletes a user that is no longer used from DMS Enterprise. |
| UpdateUser | Updates the information of a specified user. |
| ListUsers | Queries detailed information of users. |
Instance management
| Operation | Description |
|---|---|
| RegisterInstance | Adds a database instance to DMS Enterprise of your enterprise. |
| UpdateInstance | Updates the information and checks the connectivity of a specified database instance. |
| GetInstance | Queries detailed information of a specified database instance. |
| DeleteInstance | Deletes a database instance managed in DMS Enterprise. |
| ListInstances | Queries detailed information of database instances. |
Operation logs
| Operation | Description |
|---|---|
| GetOpLog | Queries detailed information of operation logs generated within a specified period. |
Database and table metadata
| Operation | Description |
|---|---|
| GetDatabase | Queries detailed information of a specified database. |
| ListColumns | Queries detailed information of columns in a specified table. |
| ListIndexes | Queries detailed information of indexes created for a specified table. |
| GetLogicDatabase | Queries detailed information of a specified logical database. |
| ListDatabases | Queries detailed information of databases in a specified instance. |
| ListLogicDatabases | Queries detailed information of logical databases. |
| ListLogicTables | Queries detailed information of logical tables in a specified logical database. |
| SearchDatabase | Queries detailed information of databases. |
| SearchTable | Queries detailed information of tables. |
| ListTables | Queries detailed information of tables in a specified database. |
General ticket operations
| Operation | Description |
|---|---|
| ApproveOrder | Approves a specified ticket. |
| CloseOrder | Closes a specified ticket. |
| GetApprovalDetail | Queries the approval details of a specified ticket. |
| GetOrderBaseInfo | Queries basic information of a specified ticket. |
| ListOrders | Queries detailed information of tickets. |
| SubmitOrderApproval | Submits a specified ticket for approval. |
| CreateOrder | Creates a ticket. |
Data change tickets
| Operation | Description |
|---|---|
| ExecuteDataCorrect | Runs a specified data change ticket to change data. |
| GetDataCorrectBackupFiles | Queries the download URL of data change backup files. |
| GetDataCorrectOrderDetail | Queries detailed information of a specified data change ticket. |
Schema design change tickets
| Operation | Description |
|---|---|
| CreatePublishGroupTask | Runs a specified schema design change ticket to change the scheme design. |
Data export tickets
| Operation | Description |
|---|---|
| GetDataExportDownloadURL | Queries the download URL of the attachment of a specified data export result. |
| GetDataExportOrderDetail | Queries detailed information of a specified data export ticket. |
| ExecuteDataExport | Runs a specified data export ticket to export data. |