数据管理提供以下相关API接口。
用户管理
| API | 描述 |
|---|---|
| RegisterUser | 调用RegisterUser录入本企业的新用户。 |
| DisableUser | 调用DisableUser可禁用产品内暂时不需要的云账号。 |
| EnableUser | 调用EnableUser可启用产品内先前禁用的云账号。 |
| DeleteUser | 调用DeleteUser可删除产品内不需要的云账号。 |
| UpdateUser | 调用UpdateUser更新用户信息。 |
| ListUsers | 调用ListUsers接口获取用户详情列表。 |
| ListUserTenants | 调用ListUserTenants获取当前的租户列表。 |
| GetUserActiveTenant | 调用GetUserActiveTenant获取当前所处的租户信息。 |
| GetUser | 调用GetUser获取用户信息。 |
实例管理
| API | 描述 |
|---|---|
| RegisterInstance | 调用RegisterInstance录入本企业新数据库实例。 |
| UpdateInstance | 调用UpdateInstance更新实例信息，同时会检查连通性。 |
| GetInstance | 调用GetInstance获取实例详细信息。 |
| DeleteInstance | 调用DeleteInstance删除DMS企业版管理的实例。 |
| ListInstances | 调用ListInstances进行实例列表检索并获取实例详情。 |
操作审计
| API | 描述 |
|---|---|
| GetOpLog | 调用GetOpLog获取指定时间内的操作日志详情列表。 |
| ListSQLExecAuditLog | 调用ListSQLExecAuditLog获取操作审计-SQL窗口列表信息。 |
| ListProxySQLExecAuditLog | 调用ListProxySQLExecAuditLog获取安全访问代理审计信息列表。 |
| ListInstanceLoginAuditLog | 调用ListInstanceLoginAuditLog获取实例登录列表信息。 |
审批流程
| API | 描述 |
|---|---|
| ListWorkFlowNodes | 调用ListWorkFlowNodes获取审批节点列表。 |
| ListWorkFlowTemplates | 调用ListWorkFlowTemplates获取审批模板列表。 |
库表元数据
| API | 描述 |
|---|---|
| SearchDatabase | 调用SearchDatabase搜索库详情信息。 |
| SearchTable | 调用SearchTable搜索表详情列表。 |
| ListDatabases | 调用ListDatabases获取一个实例下的数据库列表详情信息。 |
| ListLogicDatabases | 调用ListLogicDatabases返回逻辑库详情列表。 |
| ListTables | 调用ListTables获取一个库下面的表详情列表。 |
| ListLogicTables | 调用ListLogicTables获取指定逻辑库下面的逻辑表详情列表。 |
| ListColumns | 调用ListColumns返回表的列信息。 |
| ListIndexes | 调用ListIndexes返回表索引信息。 |
| GetDatabase | 调用GetDatabase获取具体库详情信息。 |
| GetPhysicalDatabase | 调用GetPhysicalDatabase获取物理库的详情。 |
| GetLogicDatabase | 调用GetLogicDatabase获取逻辑库详情信息。 |
| GetDBTopology | 调用GetDBTopology获取逻辑库与其对应物理分库的拓扑信息。 |
| GetTableTopology | 调用GetTableTopology获取数据表的拓扑信息。 |
| GetTableDBTopology | 调用GetTableDBTopology接口获取数据表的拓扑图。 |
| GetMetaTableDetailInfo | 调用GetMetaTableDetailInfo接口获取表的字段、索引等信息。 |
| GetMetaTableColumn | 调用GetMetaTableColumn接口获取表的字段信息。 |
| SyncInstanceMeta | 调用SyncInstanceMeta同步实例下所有数据库字典元数据。 |
| SyncDatabaseMeta | 调用SyncDatabaseMeta同步数据库字典元数据。 |
| CreateLogicDatabase | 调用CreateLogicDatabase创建DMS逻辑库。 |
| EditLogicDatabase | 调用EditLogicDatabase编辑逻辑库信息。 |
| DeleteLogicDatabase | 调用DeleteLogicDatabase删除DMS逻辑库。 |
工单操作
| 分类 | API | 描述 |
|---|---|---|
| 通用 | ApproveOrder | 调用ApproveOrder处理工单审批。 |
| CloseOrder | 调用CloseOrder关闭工单。 | |
| GetApprovalDetail | 调用GetApprovalDetail获取工单审批详情。 | |
| GetOrderBaseInfo | 调用GetOrderBaseInfo获取工单基本信息。 | |
| ListOrders | 调用ListOrders获取工单列表信息。 | |
| CreateOrder | 调用CreateOrder创建工单。 | |
| SubmitOrderApproval | 调用SubmitOrderApproval提交工单审批。 | |
| 权限申请 | GetOwnerApplyOrderDetail | 调用GetOwnerApplyOrderDetail获取申请库-Owner、表-Owner、实例-Owner的工单详情。 |
| GetPermApplyOrderDetail | 调用GetPermApplyOrderDetail获取权限申请的工单详情。 | |
| 库表同步 | CreateStructSyncOrder | 调用CreateStructSyncOrder创建结构同步工单。 |
| GetStructSyncOrderDetail | 调用GetStructSyncOrderDetail获取结构同步的工单详情信息。 | |
| GetStructSyncJobDetail | 调用GetStructSyncJobDetail获取结构同步的任务详情。 | |
| GetStructSyncJobAnalyzeResult | 调用GetStructSyncJobAnalyzeResult获取结构同步的任务分析结果。 | |
| GetStructSyncExecSqlDetail | 调用GetStructSyncExecSqlDetail获取结构同步的执行SQL脚本。 | |
| SubmitStructSyncOrderApproval | 调用SubmitStructSyncOrderApproval提交结构同步工单至审批流程。 | |
| ExecuteStructSync | 调用ExecuteStructSync执行结构同步工单。 | |
| 数据变更 | CreateDataCorrectOrder | 调用CreateDataCorrectOrder创建普通数据变更工单。 |
| CreateDataCronClearOrder | 调用CreateDataCronClearOrder创建历史数据清理工单。 | |
| CreateDataImportOrder | 调用CreateDataImportOrder创建数据导入工单。 | |
| CreateFreeLockCorrectOrder | 调用CreateFreeLockCorrectOrder创建无锁变更工单。 | |
| ExecuteDataCorrect | 调用ExecuteDataCorrect执行数据变更工单。 | |
| GetDataCorrectTaskDetail | 调用GetDataCorrectTaskDetail获取普通数据变更、无锁变更、数据导入工单任务执行详情。 | |
| GetDataCronClearTaskDetailList | 调用GetDataCronClearTaskDetailList获取历史数据清理任务执行列表。 | |
| GetDataCorrectOrderDetail | 调用GetDataCorrectOrderDetail获取数据变更工单详情信息。 | |
| GetDataCorrectBackupFiles | 调用GetDataCorrectBackupFiles获取数据变更备份文件附件下载地址。 | |
| GetDataCorrectSQLFile | 调用GetDataCorrectSQLFile获取数据变更工单的SQL脚本附件。 | |
| ListDataCorrectPreCheckSQL | 调用ListDataCorrectPreCheckSQL获取数据变更工单中预检查环节的SQL详情。 | |
| ListDataCorrectPreCheckDB | 调用ListDataCorrectPreCheckDB获取数据变更工单中预检查环节的数据库列表。 | |
| 结构设计 | CreatePublishGroupTask | 调用CreatePublishGroupTask执行结构设计变更。 |
| ListDDLPublishRecords | 调用ListDDLPublishRecords获取结构设计工单的发布详情。 | |
| 数据导出 | GetDataExportDownloadURL | 调用GetDataExportDownloadURL获取数据导出结果附件下载地址。 |
| ExecuteDataExport | 调用ExecuteDataExport执行数据导出工单。 | |
| GetDataExportOrderDetail | 调用GetDataExportOrderDetail获取数据导出工单详情。 | |
| SQL审核 | CreateSQLReviewOrder | 调用CreateSQLReviewOrder创建SQL审核工单。 |
| GetSQLReviewCheckResultStatus | 调用GetSQLReviewCheckResultStatus获取SQL审核工单的审核结果。 | |
| ListSQLReviewOriginSQL | 调用ListSQLReviewOriginSQL获取SQL审核工单的SQL详情结果。 | |
| GetSQLReviewOptimizeDetail | 调用GetSQLReviewOptimizeDetail获取SQL审核优化建议的详情。 | |
| 附件上传 | CreateUploadFileJob | 调用CreateUploadFileJob接口，创建上传附件任务。 |
| CreateUploadOSSFileJob | 调用CreateUploadOSSFileJob接口，创建上传OSS附件任务。 | |
| GetUserUploadFileJob | 调用GetUserUploadFileJob获取上传附件的任务信息。 |
SQL任务
| API | 描述 |
|---|---|
| ListDBTaskSQLJob | 调用ListDBTaskSQLJob获取SQL任务列表。 |
| ListDBTaskSQLJobDetail | 调用ListDBTaskSQLJobDetail获取SQL任务的详情信息。 |
权限管理
| API | 描述 |
|---|---|
| SetOwners | 调用SetOwners设置库表Owner。 |
| RevokeUserPermission | 调用RevokeUserPermission回收用户权限。 |
| ListUserPermissions | 调用ListUserPermissions展示指定用户所具备的库表权限。 |
| ListDatabaseUserPermssions | 调用ListDatabaseUserPermssions展示具备指定数据库权限的用户权限详情。 |
| GrantUserPermission | 调用GrantUserPermission进行用户库表权限授予。 |
安全管理
| 分类 | API | 描述 |
|---|---|---|
| 数据安全防护 | CreateProxy | 调用CreateProxy开启数据库实例的数据安全防护代理。 |
| CreateProxyAccess | 调用CreateProxyAccess授权用户可以通过数据安全防护代理访问数据库实例。 | |
| ListProxyAccesses | 调用ListProxyAccesses获取安全防护代理的授权列表。 | |
| InspectProxyAccessSecret | 调用InspectProxyAccessSecret获取安全防护代理的授权密码。 | |
| ListProxies | 调用ListProxies获取安全防护代理列表。 | |
| GetProxy | 调用GetProxy获取数据安全防护代理的详情信息。 | |
| DeleteProxyAccess | 调用DeleteProxyAccess回收目标用户的数据安全防护授权。 | |
| DeleteProxy | 调用DeleteProxy关闭数据库实例的数据安全防护代理。 | |
| 敏感字段 | ListSensitiveColumns | 调用ListSensitiveColumns搜索敏感字段列表。 |
| ListSensitiveColumnsDetail | 调用ListSensitiveColumnsDetail获取敏感字段详情信息。 | |
| ChangeColumnSecLevel | 调用ChangeColumnSecLevel调整字段敏感等级。 |
数据查询
| API | 描述 |
|---|---|
| ExecuteScript | 调用ExecuteScript执行SQL脚本。 |