阿里云OpenAPI开发者门户

数据管理 - OpenAPI 概览2018-11-01
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
用户管理
OpenAPI 名称描述操作
RegisterUser录入本企业的新用户查看文档去调试
ListUsershot获取用户的详情列表查看文档去调试
GetUserhot获取特定的用户信息查看文档去调试
GetUserActiveTenant获取当前所处的租户信息查看文档去调试
ListUserTenants获取当前的租户列表查看文档去调试
UpdateUser更新用户信息查看文档去调试
DisableUser可禁用产品内暂时不需要的云账号查看文档去调试
EnableUser可启用产品内先前已经禁用的云账号查看文档去调试
DeleteUserhot调用该API可删除已录入DMS的用户(阿里云账号)查看文档去调试
实例管理
OpenAPI 名称描述操作
AddInstance调用该API可以实现将您的数据库实例录入至DMS中,同时,可以为实例开启安全托管能力查看文档去调试
RegisterInstance在DMS中录入新的数据库实例查看文档去调试
ListInstanceshot获取实例信息列表查看文档去调试
GetInstancehot获取实例详细信息查看文档去调试
ModifyInstance当您需要修改实例的托管模式、数据库账密、功能包等基本信息,及环境类型、实例在DMS的名称、查询和导出数据的超时时间等高级信息时,可调用该API查看文档去调试
UpdateInstance更新实例信息,同时检查该实例连通性查看文档去调试
DeleteInstance调用deleteinstance接口,在DMS中删除指定实例查看文档去调试
操作审计
OpenAPI 名称描述操作
GetOpLog获取指定时间内的操作日志详情列表查看文档去调试
ListInstanceLoginAuditLog获取实例登录列表信息查看文档去调试
ListProxySQLExecAuditLog获取安全访问代理审计信息列表查看文档去调试
ListSQLExecAuditLog获取在DMS进行SQL操作的审计日志列表查看文档去调试
审批流程
OpenAPI 名称描述操作
ListWorkFlowTemplates获取审批模板列表查看文档去调试
ListWorkFlowNodes获取审批节点列表查看文档去调试
SetWorkflowExtraInfo调用此API可以设置DMS工单审批区域是否需要显示同意、撤销、加签等按钮查看文档去调试
库表元数据
OpenAPI 名称描述操作
逻辑库表
CreateLogicDatabase创建DMS逻辑库查看文档去调试
AddLogicTableRouteConfig为逻辑表添加路由算法配置查看文档去调试
ListLogicDatabases返回逻辑库详情列表查看文档去调试
GetLogicDatabase获取逻辑库详情信息查看文档去调试
ListLogicTables获取指定逻辑库下面的逻辑表详情列表查看文档去调试
GetDBTopology获取逻辑库与其对应物理分库的拓扑信息查看文档去调试
GetTableDBTopology获取数据表的拓扑图查看文档去调试
ListLogicTableRouteConfig获取逻辑表的路由算法配置列表查看文档去调试
EditLogicDatabase编辑逻辑库信息查看文档去调试
DeleteLogicDatabase删除DMS逻辑库。仅删除逻辑库,并不会对物理分库做任何物理删除操作查看文档去调试
DeleteLogicTableRouteConfig删除逻辑表路由算法配置信息查看文档去调试
数据湖库表
ListDataLakeDatabase调用此API可以获取数据湖的数据库列表查看文档去调试
GetDataLakeDatabase调用此API可以获取数据湖中的数据库信息查看文档去调试
ListDataLakeCatalog调用此API可以获取数据湖的数据目录列表查看文档去调试
GetDataLakeCatalog调用此API可以获取数据湖的数据目录查看文档去调试
ListDataLakeTablebaseInfo调用此API可以获取数据湖中表的基本信息查看文档去调试
GetDataLakeTable调用此API可以获取数据湖的表信息查看文档去调试
BatchCreateDataLakePartitions调用此API可批量新建湖仓表分区查看文档去调试
UpdateDataLakeTable调用此API可更新湖仓表信息查看文档去调试
UpdateDataLakePartition调用此API可更新湖仓表分区信息查看文档去调试
UpdateDataLakeDatabase调用此API可更新湖仓数据库信息查看文档去调试
ListDataLakeTableName调用此API可获取数据湖表名列表查看文档去调试
ListDataLakeTable调用此API可获取数据湖表列表查看文档去调试
ListDataLakePartitionName调用此API可获取数据湖表分区名列表查看文档去调试
ListDataLakePartitionByFilter调用此API可根据筛选条件获取数据湖表分区列表查看文档去调试
ListDataLakePartition调用此API可获取数据湖表分区列表查看文档去调试
GetDataLakePartition调用此API可获取湖仓表分区详情查看文档去调试
DeleteDataLakeTable调用此API可删除湖仓表查看文档去调试
DeleteDataLakePartition调用此API可删除湖仓表分区查看文档去调试
DeleteDataLakeDatabase调用此API可删除湖仓数据库查看文档去调试
CreateDataLakeTable调用此API可新建湖仓表查看文档去调试
CreateDataLakePartition调用此API可新建湖仓表分区查看文档去调试
CreateDataLakeDatabase调用此API可新建湖仓数据库查看文档去调试
BatchUpdateDataLakePartitions调用此API可批量更新湖仓表分区信息查看文档去调试
BatchDeleteDataLakePartitions调用此API可批量删除湖仓表分区查看文档去调试
CreateDataLakeFunction调用此API可以新建湖仓自定义函数查看文档去调试
GetDataLakeFunction调用此API可获取湖仓自定义函数的详细信息查看文档去调试
UpdateDataLakeFunction调用此API可更新湖仓自定义函数查看文档去调试
DeleteDataLakeFunction调用此API可删除湖仓自定义函数查看文档去调试
ListDataLakeFunction调用此API可获取数据湖函数列表查看文档去调试
ListDataLakeFunctionName调用此API可获取数据湖函数名称列表查看文档去调试
SearchDatabasehot搜索库详情信息查看文档去调试
SearchTable搜索表详情列表查看文档去调试
ListDatabaseshot获取一个实例下的数据库列表详情信息查看文档去调试
ListTables获取一个库下面的表详情列表查看文档去调试
ListColumns返回表的列信息查看文档去调试
ListIndexes返回表索引信息查看文档去调试
GetDatabase获取具体库详情信息查看文档去调试
GetPhysicalDatabase获取物理库的详情查看文档去调试
GetTableTopology获取数据表的拓扑信息查看文档去调试
GetMetaTableDetailInfo获取表的字段、索引等信息查看文档去调试
GetMetaTableColumn获取表的字段信息查看文档去调试
SyncInstanceMeta同步实例下所有数据库字典元数据查看文档去调试
SyncDatabaseMeta同步数据库字典元数据查看文档去调试
工单操作
OpenAPI 名称描述操作
通用
CreateOrder创建工单查看文档去调试
GetApprovalDetail获取工单审批详情查看文档去调试
ListOrdershot获取工单列表信息查看文档去调试
GetOrderBaseInfohot获取工单基本信息查看文档去调试
GetOrderAttachmentFile获取工单附件下载地址查看文档去调试
PreviewWorkflow该API用于在正式提交审批前,预览工单审批流查看文档去调试
SubmitOrderApproval提交工单审批查看文档去调试
ApproveOrder审批工单查看文档去调试
CloseOrder关闭工单查看文档去调试
权限申请
GetOwnerApplyOrderDetail获取申请库-Owner、表-Owner、实例-Owner的工单详情查看文档去调试
GetPermApplyOrderDetail获取权限申请的工单详情查看文档去调试
库表同步
CreateStructSyncOrder创建变更工单查看文档去调试
GetStructSyncOrderDetail获取结构同步的工单详情信息查看文档去调试
GetStructSyncJobDetail获取结构同步的任务详情查看文档去调试
GetStructSyncJobAnalyzeResult获取结构同步的任务分析结果查看文档去调试
GetStructSyncExecSqlDetail获取结构同步的执行SQL脚本查看文档去调试
SubmitStructSyncOrderApproval提交结构同步工单至审批流程查看文档去调试
ExecuteStructSync调用此API执行结构同步工单查看文档去调试
数据变更
CreateDataCorrectOrder创建普通数据变更工单查看文档去调试
CreateDataCronClearOrder创建历史数据清理工单查看文档去调试
CreateDataImportOrder创建数据导入工单查看文档去调试
CreateFreeLockCorrectOrder创建无锁变更工单查看文档去调试
CreateProcCorrectOrder使用此API创建可编程对象变更工单查看文档去调试
GetDataCorrectTaskDetail获取普通数据变更、无锁变更、数据导入工单任务详情查看文档去调试
GetDataCronClearTaskDetailList获取历史数据清理工单任务详情查看文档去调试
GetDataCorrectRollbackFile获取数据变更工单提交的回滚附件下载地址查看文档去调试
GetDataCorrectBackupFiles获取数据变更工单备份文件下载地址查看文档去调试
GetDataCorrectOrderDetail获取数据变更工单详细信息查看文档去调试
GetDataCronClearConfig查询历史数据清理工单的定时配置查看文档去调试
GetDataCorrectSQLFile获取数据变更工单的SQL脚本附件下载地址查看文档去调试
ListDataCorrectPreCheckSQL获取数据变更工单中预检查环节的SQL信息列表查看文档去调试
ListDataCorrectPreCheckDB获取数据变更工单中预检查环节的数据库列表查看文档去调试
ListDataImportSQLPreCheckDetail获取数据导入预检SQL详情查看文档去调试
ListDataImportSQLType获取数据导入SQL类型查看文档去调试
GetDataImportSQL获取数据导入的SQL查看文档去调试
ModifyDataCorrectExecSQL修改数据变更工单提交的SQL脚本查看文档去调试
PauseDataCorrectSQLJob暂停执行数据变更工单SQL任务查看文档去调试
ExecuteDataCorrect执行数据变更工单查看文档去调试
RetryDataCorrectPreCheck重新执行数据变更工单预检查步骤查看文档去调试
RestartDataCorrectSQLJob对已经执行失败的数据变更SQL任务进行重试查看文档去调试
SkipDataCorrectRowCheck跳过数据变更预检查行数校验查看文档去调试
结构设计
CreatePublishGroupTask执行结构设计工单查看文档去调试
ListDDLPublishRecords获取结构设计工单的发布详情查看文档去调试
GetTableDesignProjectFlow调用此API可获取结构设计工单当前所在环节、是否允许返回结构设计节点、执行发布的策略等信息查看文档去调试
GetTableDesignProjectInfo调用此API可获取指定结构设计工单的项目信息以及工单的变更基准库的信息,包含结构设计工单的状态、工单创建者ID、基准库的名称和ID等查看文档去调试
数据导出
CreateDatabaseExportOrder创建数据库导出工单查看文档去调试
CreateDataExportOrder创建SQL结果集导出工单查看文档去调试
GetDataExportPreCheckDetail查看SQL结果集导出工单预检查详情查看文档去调试
GetDataExportDownloadURL获取数据导出结果附件下载地址查看文档去调试
GetDatabaseExportOrderDetail获取数据库导出工单详情查看文档去调试
GetDataExportOrderDetail获取SQL结果集导出工单详情查看文档去调试
GetDbExportDownloadURL获取数据库导出结果附件下载地址查看文档去调试
ExecuteDataExport执行数据导出工单查看文档去调试
SuspendDataExportJob调用此接口可以中断正在执行或定时执行的SQL结果集导出任务查看文档去调试
PauseDataExportJob调用此接口可以终止SQL结果集导出任务查看文档去调试
RestartDataExportJob调用此接口重启SQL结果集导出任务查看文档去调试
RemoveDataExportJob调用此接口可以删除数据导出任务查看文档去调试
SQL审核
CreateSQLReviewOrder创建SQL审核工单查看文档去调试
GetSQLReviewCheckResultStatus获取SQL审核工单的审核结果查看文档去调试
ListSQLReviewOriginSQL获取SQL审核工单的SQL详情结果查看文档去调试
GetSQLReviewOptimizeDetail获取SQL审核优化建议的详情,适用于数据变更工单和SQLReview工单查看文档去调试
数据追踪
CreateDataTrackOrder创建数据追踪工单查看文档去调试
GetDataTrackJobDegree获取数据追踪任务进度查看文档去调试
GetDataTrackJobTableMeta获取数据追踪表元数据信息查看文档去调试
GetDataTrackOrderDetail获取数据追踪工单详情查看文档去调试
SearchDataTrackResult搜索数据追踪日志解析结果查看文档去调试
DownloadDataTrackResult下载数据追踪日志解析结果查看文档去调试
QueryDataTrackResultDownloadStatus查询下载数据追踪日志解析结果进度查看文档去调试
附件上传
CreateUploadFileJob创建上传链接形式附件任务,获得附件任务Key查看文档去调试
CreateUploadOSSFileJob创建上传OSS附件任务,获得附件任务Key查看文档去调试
GetUserUploadFileJob获取上传附件的任务信息查看文档去调试
数据归档
CreateDataArchiveOrder使用此API可以创建数据归档工单,将数据归档至专属存储、RDS MySQL等目标中查看文档去调试
GetDataArchiveOrderDetail调用此API获取数据归档工单详情,包含工单的创建时间、任务调度信息、归档任务日志和归档数据库的信息等查看文档去调试
GetDataArchiveCount获取数据归档工单量统计,包括:归档成功的工单数、归档失败的工单数、正在进行归档的工单数和归档工单的总数查看文档去调试
GetPagedInstance返回指定工单的任务信息查看文档去调试
SQL任务
OpenAPI 名称描述操作
ListDBTaskSQLJob获取SQL任务列表查看文档去调试
ListDBTaskSQLJobDetail获取SQL任务的详情信息查看文档去调试
GetDBTaskSQLJobLog获取SQL任务调度详情日志查看文档去调试
GetOnlineDDLProgress获取OnlineDDL任务执行进度详情查看文档去调试
权限管理
OpenAPI 名称描述操作
GrantUserPermission授予用户实例、库、表权限查看文档去调试
ListInstanceUserPermissions获取实例的用户权限列表查看文档去调试
ListDatabaseUserPermssions展示具备指定数据库权限的用户权限详情查看文档去调试
ListUserPermissions展示指定用户所具备的库表权限查看文档去调试
ListAuthorizedInstancesForUser调用此API可以获取指定用户有权限的实例列表查看文档去调试
ListAuthorizedUsersForInstance调用此API可以获取拥有指定实例权限的用户列表查看文档去调试
ListAuthorizedDatabasesForUser调用此API可以获取用户有权限的数据库列表查看文档去调试
ListAuthorizedUsersForDatabase调用此API可以获取拥有指定数据库权限的用户列表查看文档去调试
SetOwners设置实例、库、表的Owner查看文档去调试
RevokeUserPermission回收用户实例、库、表权限查看文档去调试
安全管理
OpenAPI 名称描述操作
安全规则
CreateStandardGroup创建安全规则集查看文档去调试
ListStandardGroups获取安全规则集列表查看文档去调试
GetStandardGroup可以获取到租户下已有的安全规则集信息,包含规则名称、描述及规则关联实例的类型等信息查看文档去调试
UpdateStandardGroup使用该API可以调整指定安全规则集的名称及描述信息查看文档去调试
DeleteStandardGroup可以删除已创建的安全规则集查看文档去调试
敏感数据管理
AddDesensitizationRule添加脱敏规则查看文档去调试
ListDesensitizationRule获取脱敏规则列表查看文档去调试
ListClassificationTemplates获取分类分级模板列表信息查看文档去调试
ListSensitiveDataAuditLog查看敏感信息审计日志详情查看文档去调试
ListSensitiveColumns搜索敏感字段列表查看文档去调试
ListSensitiveColumnsDetail获取敏感字段详情信息查看文档去调试
GetClassificationTemplate使用此API获取实例绑定的分类分级模板信息,包含模板ID、模板类型等信息查看文档去调试
ListSensitivityLevel获取分类分级模板对应的敏感序列列表查看文档去调试
ListSensitiveColumnInfo调用此接口可以获取到敏感字段所使用的脱敏算法ID、名称,以及字段的安全级别等信息查看文档去调试
ModifyDesensitizationStrategy修改字段绑定的脱敏规则查看文档去调试
ChangeColumnSecLevel调整字段敏感等级查看文档去调试
ChangeColumnSecurityLevel调整字段的安全级别查看文档去调试
安全访问代理
CreateProxy开启实例的数据安全访问功能查看文档去调试
CreateProxyAccess授予用户安全访问代理权限查看文档去调试
ListProxies获取安全访问代理列表查看文档去调试
GetProxy获取数据安全访问代理的详细信息查看文档去调试
ListProxyAccesses获取安全访问代理的授权列表查看文档去调试
InspectProxyAccessSecret获取安全访问代理的授权密码查看文档去调试
DeleteProxy关闭实例的安全访问代理查看文档去调试
DeleteProxyAccess回收目标用户的安全访问代理权限查看文档去调试
GetProxyAccess获取安全访问代理的授权查看文档去调试
权限模板
AddAuthorityTemplateItems调用此API给指定权限模板添加实例、数据库、表资源查看文档去调试
ListAuthorityTemplate获取权限模板列表,包含模板创建者、模板名称、模板创建者及模板总数等信息查看文档去调试
DeleteAuthorityTemplate可以删除已创建的权限模板查看文档去调试
GrantTemplateAuthority授予用户权限模板中的资源权限查看文档去调试
RevokeTemplateAuthority回收权限模板中的资源权限查看文档去调试
CreateAuthorityTemplate创建权限模板查看文档去调试
UpdateAuthorityTemplate更新权限模板查看文档去调试
GetAuthorityTemplateItem获取权限模板中的资源列表查看文档去调试
GetAuthorityTemplate获取权限模板详情查看文档去调试
权限策略
CreateAbacPolicy调用此API可以创建权限策略,以帮助您对DMS功能以及托管在DMS的数据资源进行细粒度的管控查看文档去调试
CreateAbacAuthorization调用此API可以给DMS用户或自定义角色授予策略权限,包含系统权限策略和自定义权限策略查看文档去调试
ListAbacPolicies调用此API可以获取已创建的权限策略列表查看文档去调试
GetAbacPolicy调用此API可以获取权限策略详情,包含策略名称、内容、创建人等信息查看文档去调试
ListAbacAuthorizations调用此API可以获取指定权限策略被授权给用户的数量及列表查看文档去调试
UpdateAbacPolicy调用此API可以指定更新权限策略的名称、描述和内容查看文档去调试
DeleteAbacAuthorization调用此API可以解除权限策略与用户或角色之间的授权关系查看文档去调试
DeleteAbacPolicy调用此API可以删除已创建的权限策略查看文档去调试
数据查询
OpenAPI 名称描述操作
ExecuteScripthot执行SQL脚本查看文档去调试
数据开发
OpenAPI 名称描述操作
任务编排
CreateScenario创建业务场景,也可以将任务流按业务场景进行分组查看文档去调试
AddTaskFlowEdges为已存在的任务流节点建立有向边查看文档去调试
CreateTaskFlow创建任务流查看文档去调试
CreateTask创建任务流任务查看文档去调试
ListTaskFlow获取任务流信息列表查看文档去调试
GetTaskInstanceRelation获取任务流运行记录的节点信息查看文档去调试
ListTaskFlowInstance获取任务流运行记录查看文档去调试
ListDAGVersions获取任务流历史发布版本信息列表查看文档去调试
ListTaskFlowsByPage分页获取任务流详情列表查看文档去调试
ListScenarios获取业务场景列表查看文档去调试
ListTaskFlowConstants获取任务流常量列表查看文档去调试
ListTaskFlowTimeVariables获取任务流时间变量列表查看文档去调试
GetRuleNumLimitOfSLA获取任务编排自定义SLA规则的限制数量,自定义的SLA规则数量不可超过该限制数查看文档去调试
GetIntervalLimitOfSLA获取任务流允许配置SLA超时规则时,其最小调度周期限制查看文档去调试
ListDefaultSLARules获取默认SLA超时提醒规则查看文档去调试
ListTaskFlowCooperators获取任务流相关人列表查看文档去调试
ListSLARules调用此API可以获取自定义SLA规则列表查看文档去调试
GetTask按照任务流节点ID获取指定节点的配置,包括任务的时间变量查看文档去调试
GetTaskFlowNotification获取任务流通知设置查看文档去调试
ListTaskFlowEdgesByCondition多条件获取指定任务流DAG图的边查看文档去调试
GetTaskFlowGraph获取任务流的DAG图查看文档去调试
ListTasksInTaskFlow获取指定任务流的任务节点列表查看文档去调试
UpdateTaskFlowConstants更新任务流常量列表查看文档去调试
OfflineTaskFlow在DMS中下线已发布的任务流查看文档去调试
ReDeployLhDagVersion重新部署任务流历史版本查看文档去调试
UpdateScenario更新任务流业务场景名称和描述查看文档去调试
ResumeTaskFlowInstance恢复已暂停运行的任务流查看文档去调试
UpdateTaskContent更新任务流中的任务查看文档去调试
UpdateTaskConfig更新任务高级配置查看文档去调试
BackFill给任务编排补数据查看文档去调试
UpdateTaskTimeVariables更新任务时间变量查看文档去调试
UpdateTaskFlowTimeVariables更新任务流时间变量查看文档去调试
UpdateTaskFlowCooperators更新任务流相关人员列表查看文档去调试
UpdateSLARules调用此API可以更新任务流SLA超时提醒查看文档去调试
MoveTaskFlowToScenario移动任务流至指定业务场景查看文档去调试
UpdateTaskName更新任务名称查看文档去调试
UpdateTaskOutput更新任务节点的输出变量查看文档去调试
UpdateTaskFlowNameAndDesc更新任务流名称和描述查看文档去调试
UpdateTaskFlowEdges批量更新指定任务流的指定边的起点节点和终点节点查看文档去调试
UpdateTaskFlowOwner更新任务流Owner查看文档去调试
UpdateTaskFlowSchedule更新任务流调度配置查看文档去调试
UpdateTaskFlowRelations全量更新任务流边查看文档去调试
UpdateTaskFlowNotification更新任务流通知设置查看文档去调试
SuspendTaskFlowInstance暂停运行中的任务流实例查看文档去调试
ReRunTaskFlowInstance重跑任务流实例查看文档去调试
MakeTaskFlowInstanceSuccess将指定任务流的状态设置为成功查看文档去调试
PublishAndDeployTaskFlow发布并部署指定任务流查看文档去调试
StopTaskFlowInstance停止运行中的任务流实例查看文档去调试
DeleteTaskFlow删除任务流查看文档去调试
DeleteScenario删除业务场景查看文档去调试
DeleteTaskFlowEdgesByCondition按照多条件删除任务流边查看文档去调试
DeleteTask删除任务流任务查看文档去调试
数仓开发
CreateLakeHouseSpace在DMS数仓开发中创建新的项目空间查看文档去调试
AddLhMembers添加DMS数仓开发项目空间管理员、空间成员或任务流开发者查看文档去调试
GetLhSpaceByName根据DMS数仓开发项目空间名查询项目空间信息查看文档去调试
ListLhTaskFlowAndScenario查询DMS数仓开发项目空间中业务场景对应的任务流列表查看文档去调试
ChangeLhDagOwner转交DMS数仓开发项目空间中的任务流责任人查看文档去调试
DeleteLakeHouseSpace删除数仓开发中的项目空间查看文档去调试
DeleteLhMembers删除DMS数仓开发项目空间成员或任务流开发者查看文档去调试
售卖订单
OpenAPI 名称描述操作
BuyPayAsYouGoOrder购买DMS按量付费的商品查看文档去调试
ListEffectiveOrders查询有效订单列表查看文档去调试
RefundPayAsYouGoOrder退订已购买的DMS按量付费商品查看文档去调试
SQL血缘
OpenAPI 名称描述操作
AnalyzeSQLLineage分析SQL语句中的表、字段之间的血缘关系(依赖和影响关系)查看文档去调试
其他
OpenAPI 名称描述操作
UpdateTaskContentV2接受大容量sql文件的更新节点内容API查看文档去调试
其它
OpenAPI 名称描述操作
TryRunTaskFlow试运行任务流查看文档去调试