API概览

本产品(数据管理/2018-11-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

用户管理

API标题API概述
DeleteUser删除产品内的云账号可删除产品内不需要的云账号。
UpdateUser更新用户信息更新用户信息。
DisableUser禁用产品内的云账号可禁用产品内暂时不需要的云账号。
EnableUser启用产品内禁用的云账号可启用产品内先前已经禁用的云账号。
ListUsers获取用户详情列表获取用户的详情列表。
GetUser获取用户信息获取特定的用户信息。
GetUserActiveTenant获取当前所处的租户信息获取当前所处的租户信息。
ListUserTenants获取当前的租户列表获取当前的租户列表。
RegisterUser录入新用户录入本企业的新用户。

实例管理

API标题API概述
DeleteInstance删除指定实例调用deleteinstance接口,在DMS中删除指定实例。
UpdateInstance更新实例信息更新实例信息,同时检查该实例连通性。
ListInstances获取实例信息列表调用ListInstances接口,获取实例信息列表。
GetInstance获取实例详细信息获取实例详细信息。
RegisterInstance录入新的数据库实例在DMS中录入新的数据库实例。

操作审计

API标题API概述
GetOpLog获取指定时间内的操作日志详情列表获取指定时间内的操作日志详情列表。
ListInstanceLoginAuditLog获取实例登录日志获取实例登录列表信息。
ListProxySQLExecAuditLog获取SQL资源审计日志获取安全访问代理审计信息列表。
ListSQLExecAuditLog获取SQL审计日志列表获取sql审计日志列表。

审批流程

API标题API概述
ListWorkFlowTemplates获取审批模板列表获取审批模板列表。
ListWorkFlowNodes获取审批节点列表获取审批节点列表。

库表元数据

API标题API概述
逻辑库表逻辑库表
CreateLogicDatabase创建逻辑库创建DMS逻辑库。
AddLogicTableRouteConfig逻辑表中配置路由算法为逻辑表添加路由算法配置。
DeleteLogicDatabase删除逻辑库中的物理库删除DMS逻辑库。仅删除逻辑库,并不会对物理分库做任何物理删除操作。
DeleteLogicTableRouteConfig删除逻辑表路由算法删除逻辑表路由算法配置信息。
ListLogicDatabases返回逻辑库详情列表调用ListLogicDatabases接口,返回逻辑库详情列表。
GetLogicDatabase获取逻辑库信息调用GetLogicDatabase接口,获取逻辑库详情信息。
ListLogicTables获取逻辑库中的逻辑表详情列表获取指定逻辑库下面的逻辑表详情列表。
GetDBTopology获取逻辑库拓扑信息获取逻辑库与其对应物理分库的拓扑信息。
GetTableDBTopology获取逻辑表的拓扑图获取数据表的拓扑图。
ListLogicTableRouteConfig获取逻辑表的路由算法列表获取逻辑表的路由算法配置列表。
EditLogicDatabase返回逻辑库详情信息编辑逻辑库信息。
SearchDatabase搜索数据库详情列表搜索库详情信息。
SearchTable搜索表详情列表搜索表详情列表。
ListDatabases获取实例的数据库详情列表调用ListDatabases获取一个实例下的数据库列表详情信息。
ListTables获取数据库的表详情列表调用ListTables获取一个库下面的表详情列表。
ListColumns获取表的列信息返回表的列信息。
ListIndexes获取表的索引信息调用ListIndexes返回表索引信息。
GetDatabase获取具体库详情信息调用GetDatabase获取具体库详情信息。
GetPhysicalDatabase获取物理库的详情调用GetPhysicalDatabase获取物理库的详情。
GetTableTopology获取数据表的拓扑信息调用GetTableTopology获取数据表的拓扑信息。
GetMetaTableDetailInfo获取表的字段、索引等信息调用GetMetaTableDetailInfo接口获取表的字段、索引等信息。
GetMetaTableColumn获取表的字段信息调用GetMetaTableColumn接口获取表的字段信息。
SyncInstanceMeta同步实例下所有数据库的元数据调用SyncInstanceMeta同步实例下所有数据库字典元数据。
SyncDatabaseMeta同步数据库元数据调用SyncDatabaseMeta同步数据库字典元数据。

工单操作

API标题API概述
通用通用
CreateOrder创建工单调用CreateOrder创建工单。
GetApprovalDetail获取工单审批详情调用GetApprovalDetail获取工单审批详情。
ListOrders获取工单列表信息调用ListOrders获取工单列表信息。
GetOrderBaseInfo获取工单基本信息调用GetOrderBaseInfo获取工单基本信息。
SubmitOrderApproval提交工单审批调用SubmitOrderApproval提交工单审批。
ApproveOrder处理工单审批调用ApproveOrder处理工单审批。
CloseOrder关闭工单调用CloseOrder关闭工单。
GetOrderAttachmentFile获取工单附件下载地址调用GetOrderAttachmentFile接口,获取工单附件下载地址。
权限申请权限申请
GetOwnerApplyOrderDetail获取申请数据权限工单详情获取申请库-Owner、表-Owner、实例-Owner的工单详情。
GetPermApplyOrderDetail获取申请操作权限的工单详情调用GetPermApplyOrderDetail获取权限申请的工单详情。
库表同步库表同步
CreateStructSyncOrder创建结构同步工单创建变更工单。
GetStructSyncOrderDetail获取结构同步的工单详情信息调用GetStructSyncOrderDetail获取结构同步的工单详情信息。
GetStructSyncJobDetail获取结构同步任务详情调用GetStructSyncJobDetail获取结构同步的任务详情。
GetStructSyncJobAnalyzeResult获取结构同步的任务分析结果调用GetStructSyncJobAnalyzeResult获取结构同步的任务分析结果。
GetStructSyncExecSqlDetail获取结构同步的执行SQL脚本调用GetStructSyncExecSqlDetail获取结构同步的执行SQL脚本。
SubmitStructSyncOrderApproval提交结构同步工单至审批流程调用SubmitStructSyncOrderApproval提交结构同步工单至审批流程。
ExecuteStructSync执行结构同步工单创建或修改计算实例的同义词词典。
数据变更数据变更
CreateDataCorrectOrder创建普通数据变更工单创建普通数据变更工单。
CreateDataCronClearOrder创建历史数据清理工单创建历史数据清理工单。
CreateDataImportOrder创建数据导入工单创建数据导入工单。
CreateFreeLockCorrectOrder创建无锁变更工单创建无锁变更工单。
ModifyDataCorrectExecSQL修改数据变更工单SQL脚本修改数据变更工单提交的SQL脚本。
PauseDataCorrectSQLJob暂停执行数据变更工单SQL任务暂停执行数据变更工单SQL任务。
GetDataCorrectTaskDetail获取工单任务详情获取普通数据变更、无锁变更、数据导入工单任务详情。
GetDataCronClearTaskDetailList获取历史数据清理工单任务详情获取历史数据清理工单任务详情。
GetDataCorrectRollbackFile获取数据变更工单提交的回滚附件下载地址调用GetDataCorrectRollbackFile接口,获取数据变更工单提交的回滚附件下载地址。
GetDataCorrectBackupFiles获取备份文件下载地址获取数据变更工单备份文件下载地址。
GetDataCorrectOrderDetail获取数据变更工单详细信息获取数据变更工单详细信息。
GetDataCronClearConfig查询历史数据清理工单的定时配置查询历史数据清理工单的定时配置。
GetDataCorrectSQLFile获取数据变更工单SQL脚本下载地址获取数据变更工单的SQL脚本附件下载地址。
ListDataCorrectPreCheckSQL获预检查环节的SQL详情获取数据变更工单中预检查环节的SQL信息列表。
ListDataCorrectPreCheckDB获取预检查环节的数据库列表获取数据变更工单中预检查环节的数据库列表。
ExecuteDataCorrect执行数据变更工单执行数据变更工单。
RetryDataCorrectPreCheck重新执行数据变更工单预检查重新执行数据变更工单预检查步骤。
RestartDataCorrectSQLJob重新执行失败的数据变更SQL任务对已经执行失败的数据变更SQL任务进行重试。
结构设计结构设计
CreatePublishGroupTask执行结构设计工单执行结构设计工单。
ListDDLPublishRecords获取结构设计工单详情获取结构设计工单的发布详情。
数据导出数据导出
GetDataExportDownloadURL获取数据导出结果附件下载地址调用GetDataExportDownloadURL获取数据导出结果附件下载地址。
GetDataExportOrderDetail获取数据导出工单详情调用GetDataExportOrderDetail获取数据导出工单详情。
ExecuteDataExport执行数据导出工单调用ExecuteDataExport执行数据导出工单。
SQL审核SQL审核
CreateSQLReviewOrder创建SQL审核工单调用CreateSQLReviewOrder创建SQL审核工单。
GetSQLReviewCheckResultStatus获取SQL审核工单的审核结果获取SQL审核工单的审核结果。
ListSQLReviewOriginSQL获取SQL审核工单的SQL详情获取SQL审核工单的SQL详情结果。
GetSQLReviewOptimizeDetail获取SQL审核优化建议的详情获取SQL审核优化建议的详情,适用于数据变更工单和SQLReview工单。
附件上传附件上传
CreateUploadFileJob上传链接形式附件创建上传链接形式附件任务,获得附件任务Key。
CreateUploadOSSFileJob上传OSS附件创建上传OSS附件任务,获得附件任务Key。
GetUserUploadFileJob获取上传附件的任务信息获取上传附件的任务信息。

SQL任务

API标题API概述
ListDBTaskSQLJob获取SQL任务列表获取SQL任务列表。
ListDBTaskSQLJobDetail获取SQL任务的详情信息获取SQL任务的详情信息。
GetDBTaskSQLJobLog获取SQL任务日志获取SQL任务调度详情日志。
GetOnlineDDLProgress获取OnlineDDL任务执行进度详情调用GetOnlineDDLProgress接口,获取OnlineDDL任务执行进度详情。

权限管理

API标题API概述
SetOwners设置资源Owner角色设置实例、库、表的Owner。
ListInstanceUserPermissions获取实例的用户权限列表调用ListInstanceUserPermissions获取实例的用户权限列表。
ListDatabaseUserPermssions展示具备指定数据库权限的用户权限详情调用ListDatabaseUserPermssions展示具备指定数据库权限的用户权限详情。
ListUserPermissions查询指定用户拥有的库表权限调用ListUserPermissions展示指定用户所具备的库表权限。
GrantUserPermission授予用户库表权限授予用户实例、库、表权限。
RevokeUserPermission回收用户库表权限回收用户实例、库、表权限。

安全管理

API标题API概述
安全规则安全规则
CreateStandardGroup创建安全规则集调用CreateStandardGroup创建安全规则集。
ListStandardGroups获取安全规则集列表获取安全规则集列表。
敏感数据管理敏感数据管理
AddDesensitizationRule添加脱敏规则添加脱敏规则。
ListDesensitizationRule获取脱敏规则列表获取脱敏规则列表。
ModifyDesensitizationStrategy修改字段绑定的脱敏规则修改字段绑定的脱敏规则。
ListClassificationTemplates获取分类分级模板列表调用ListClassificationTemplates接口,获取分类分级模板列表信息。
ListSensitiveDataAuditLog查看敏感信息审计日志详情调用ListSensitiveDataAuditLog接口,查看敏感信息审计日志详情。
ListSensitiveColumns搜索敏感字段列表调用ListSensitiveColumns搜索敏感字段列表。
ListSensitiveColumnsDetail获取敏感字段详情信息调用ListSensitiveColumnsDetail获取敏感字段详情信息。
ChangeColumnSecLevel调整字段敏感等级调整字段敏感等级。
安全访问代理安全访问代理
CreateProxy开启数据安全访问调用CreateProxy接口,开启实例的数据安全访问功能。
DeleteProxy关闭安全访问代理关闭实例的安全访问代理。
ListProxies获取安全访问代理列表获取安全访问代理列表。
GetProxy获取数据安全访问代理的详细信息获取数据安全访问代理的详细信息。
CreateProxyAccess授予安全访问代理权限授予用户安全访问代理权限。
DeleteProxyAccess回收安全访问代理权限回收目标用户的安全访问代理权限。
ListProxyAccesses获取安全访问代理的授权列表获取安全访问代理的授权列表。
InspectProxyAccessSecret获取安全访问代理的授权密码获取安全访问代理的授权密码。

数据查询

API标题API概述
ExecuteScript执行SQL脚本调用ExecuteScript执行SQL脚本。

数据开发

API标题API概述
任务编排任务编排
UpdateTaskFlowConstants更新任务流常量列表调用UpdateTaskFlowConstants接口,更新任务流常量列表。
DeleteTaskFlow删除任务流调用DeleteTaskFlow接口,删除任务流。
OfflineTaskFlow下线已发布的任务流调用OfflineTaskFlow接口,在DMS中下线已发布的任务流。
ListTaskFlow获取任务流信息列表调用ListTaskFlow接口,获取任务流信息列表。
GetTaskInstanceRelation获取任务流运行记录的节点信息调用GetTaskInstanceRelation接口,获取任务流运行记录的节点信息。
ListTaskFlowInstance获取任务流运行记录调用ListTaskFlowInstance接口,获取任务流运行记录。
ListDAGVersions获取任务流历史发布版本信息列表调用ListDAGVersions接口,获取任务流历史发布版本信息列表。
ReDeployLhDagVersion重新部署任务流历史版本调用ReDeployLhDagVersion接口,重新部署任务流历史版本。
UpdateScenario更新任务流业务场景名称和描述调用UpdateScenario接口,更新任务流业务场景名称和描述。
ResumeTaskFlowInstance恢复已暂停运行的任务流调用ResumeTaskFlowInstance接口,恢复已暂停运行的任务流。
UpdateTaskContent更新任务流中的任务调用UpdateTaskContent接口,更新任务流中的任务。
ListTaskFlowsByPage获取任务流运行记录列表调用ListTaskFlowsByPage接口,获取任务流运行记录列表。
ListScenarios获取业务场景列表调用ListScenarios接口,获取业务场景列表。
UpdateTaskConfig更新任务高级配置调用UpdateTaskConfig接口,更新任务高级配置。
ListTaskFlowConstants获取任务流常量列表调用ListTaskFlowConstants接口获取任务流常量列表。
BackFill给任务编排补数据调用BackFill接口,给任务编排补数据。
UpdateTaskTimeVariables更新任务时间变量更新任务时间变量。
ListTaskFlowTimeVariables获取任务流时间变量列表调用ListTaskFlowTimeVariables接口,获取任务流时间变量列表。
UpdateTaskFlowTimeVariables更新任务流时间变量调用UpdateTaskFlowTimeVariables接口,更新任务流时间变量。
UpdateTaskFlowCooperators更新任务流相关人员列表调用UpdateTaskFlowCooperators接口,更新任务流相关人员列表。
CreateScenario创建业务场景调用CreateScenario接口,创建业务场景,也可以将任务流按业务场景进行分组。
DeleteScenario删除业务场景调用DeleteScenario接口,删除业务场景。
UpdateSLARules更新任务流SLA超时提醒调用UpdateSLARules,更新任务流SLA超时提醒。
GetRuleNumLimitOfSLA获取自定义SLA规则数量限制调用GetRuleNumLimitOfSLA接口,获取任务编排自定义SLA规则的限制数量,自定义的SLA规则数量不可超过该限制数。
GetIntervalLimitOfSLA获取超时规则最小调度周期调用GetIntervalLimitOfSLA接口,获取任务流允许配置SLA超时规则时,其最小调度周期限制。
ListDefaultSLARules获取默认SLA超时规则调用ListDefaultSLARules,获取默认SLA超时提醒规则。
ListTaskFlowCooperators获取任务流相关人列表获取任务流相关人列表。
ListSLARules获取自定义SLA规则列表调用ListSLARules接口,获取自定义SLA规则列表。
GetTask获取任务流节点配置调用GetTask接口,按照任务流节点ID获取指定节点的配置,包括任务的时间变量。
MoveTaskFlowToScenario移动任务流至指定业务场景调用MoveTaskFlowToScenario接口,移动任务流至指定业务场景。
GetTaskFlowNotification获取任务流通知设置调用GetTaskFlowNotification接口,获取任务流通知设置。
UpdateTaskName更新任务名称调用UpdateTaskName接口,更新任务名称。
UpdateTaskOutput更新任务节点的输出变量调用UpdateTaskOutput接口,更新任务节点的输出变量。
DeleteTaskFlowEdgesByCondition按照多条件删除任务流边调用DeleteTaskFlowEdgesByCondition接口,按照多条件删除任务流边。
ListTaskFlowEdgesByCondition获取指定任务流DAG图的边调用ListTaskFlowEdgesByMultiCondition接口,多条件获取指定任务流DAG图的边。
AddTaskFlowEdges任务流节点建立有向边为已存在的任务流节点建立有向边。
UpdateTaskFlowNameAndDesc更新任务流名称和描述调用UpdateTaskFlowNameAndDesc接口,更新任务流名称和描述。
GetTaskFlowGraph获取任务流的DAG图调用GetTaskFlowGraph接口获取任务流的DAG图。
UpdateTaskFlowEdges更新指定任务流边的起始节点批量更新指定任务流的指定边的起点节点和终点节点。
UpdateTaskFlowOwner更新任务流Owner调用UpdateTaskFlowOwner接口,更新任务流Owner。
UpdateTaskFlowSchedule更新任务流调度配置调用UpdateTaskFlowSchedule接口,更新任务流调度配置。
UpdateTaskFlowRelations全量更新任务流边调用UpdateTaskFlowRelations接口,全量更新任务流边。
UpdateTaskFlowNotification更新任务流通知设置调用UpdateTaskFlowNotification接口,更新任务流通知设置。
ListTasksInTaskFlow获取指定任务流的任务节点列表调用ListTasksInTaskFlow接口,获取指定任务流的任务节点列表。
CreateTaskFlow创建任务流调用CreateTaskFlow接口,创建任务流。
SuspendTaskFlowInstance暂停任务流实例调用SuspendTaskFlowInstance接口,暂停运行中的任务流实例。
ReRunTaskFlowInstance重跑任务流实例调用ReRunTaskFlowInstance接口,重跑任务流实例。
MakeTaskFlowInstanceSuccess将指定任务流的状态设置为成功调用MakeTaskFlowInstanceSuccess接口,将指定任务流的状态设置为成功。
DeleteTask删除任务流任务调用DeleteTask接口,删除任务流任务。
PublishAndDeployTaskFlow发布并部署指定任务流调用PublishAndDeployTaskFlow接口,发布并部署指定任务流。
StopTaskFlowInstance停止运行中的任务流实例调用StopTaskFlowInstance接口,停止运行中的任务流实例。
CreateTask创建任务流任务调用CreateTask接口,创建任务流任务。
数仓开发数仓开发
CreateLakeHouseSpace创建新项目空间调用CreateLakeHouseSpace接口,在DMS数仓开发中创建新的项目空间。
GetLhSpaceByName查询项目空间信息调用GetLhSpaceByName接口,根据DMS数仓开发项目空间名查询项目空间信息。
DeleteLakeHouseSpace删除项目空间调用DeleteLakeHouseSpace接口,删除数仓开发中的项目空间。
ListLhTaskFlowAndScenario查询项目空间中业务场景对应的任务流列表查询DMS数仓开发项目空间中业务场景对应的任务流列表。
AddLhMembers添加项目空间管理员、空间成员或任务流开发者调用AddLhMembers接口,添加DMS数仓开发项目空间管理员、空间成员或任务流开发者。
DeleteLhMembers删除项目空间成员或任务流开发者调用DeleteLhMembers接口,删除DMS数仓开发项目空间成员或任务流开发者。
ChangeLhDagOwner转交任务流责任人转交DMS数仓开发项目空间中的任务流责任人。

售卖订单

API标题API概述
ListEffectiveOrders查询有效订单列表查询有效订单列表。
RefundPayAsYouGoOrder退订已购买的DMS按量付费商品调用RefundPayAsYouGoOrder接口,退订已购买的DMS按量付费商品。
BuyPayAsYouGoOrder购买DMS按量付费的商品调用BuyPayAsYouGoOrder接口,购买DMS按量付费的商品。
阿里云首页 数据管理 相关技术圈