产品全部接口功能分类参考-数据管理 DMS-阿里云-数据管理 DMS-阿里云帮助中心

本产品（dms-enterprise/2018-11-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

用户管理

API	标题	API概述
UpdateUser	更新用户信息	更新用户信息。
GetUserActiveTenant	获取当前所处的租户信息	获取当前所处的租户信息。
ListUserTenants	获取当前的租户列表	获取当前的租户列表。
RegisterUser	录入新用户	录入本企业的新用户。

实例管理

API	标题	API概述
AddInstance	录入数据库实例	调用该API可以实现将您的数据库实例录入至DMS中，同时，可以为实例开启安全托管能力。
ModifyInstance	修改实例信息	当您需要修改实例的托管模式、数据库账密、功能包等基本信息，及环境类型、实例在DMS的名称、查询和导出数据的超时时间等高级信息时，可调用该API。
ListInstances	获取实例信息列表	调用ListInstances接口，获取实例信息列表。
GetInstance	获取实例详细信息	获取实例详细信息。
DeleteInstance	删除指定实例	调用deleteinstance接口，在DMS中删除指定实例。
RegisterInstance	录入新的数据库实例（旧）	在DMS中录入新的数据库实例。
UpdateInstance	更新实例信息（旧）	更新实例信息，同时检查该实例连通性。
SimplyAddInstance	简版添加实例	该API适用于特殊场景，不推荐使用。若您有录入实例至DMS的需求，建议优先调用AddInstance接口。

操作审计

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

审批流程

API	标题	API概述
ListWorkFlowTemplates	获取审批模板列表	获取审批模板列表。
ListWorkFlowNodes	获取审批节点列表	获取审批节点列表。
SetWorkflowExtraInfo	为审批流设置额外信息	调用此API可以设置DMS工单审批区域是否需要显示同意、撤销、加签等按钮。

库表元数据

API	标题	API概述
逻辑库表	逻辑库表
CreateLogicDatabase	创建逻辑库	创建DMS逻辑库。
AddLogicTableRouteConfig	逻辑表中配置路由算法	为逻辑表添加路由算法配置。
DeleteLogicDatabase	删除逻辑库中的物理库	删除DMS逻辑库。仅删除逻辑库，并不会对物理分库做任何物理删除操作。
DeleteLogicTableRouteConfig	删除逻辑表路由算法	删除逻辑表路由算法配置信息。
ListLogicDatabases	返回逻辑库详情列表	调用ListLogicDatabases接口，返回逻辑库详情列表。
GetLogicDatabase	获取逻辑库信息	获取逻辑库详情信息。
ListLogicTables	获取逻辑库中的逻辑表详情列表	获取指定逻辑库下面的逻辑表详情列表。
GetDBTopology	获取逻辑库拓扑信息	获取逻辑库与其对应物理分库的拓扑信息。
GetTableDBTopology	获取逻辑表的拓扑图	获取数据表的拓扑图。
ListLogicTableRouteConfig	获取逻辑表的路由算法列表	获取逻辑表的路由算法配置列表。
EditLogicDatabase	返回逻辑库详情信息	编辑逻辑库信息。
数据湖库表	数据湖库表
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可获取数据湖函数名称列表。
SearchDatabase	搜索数据库详情列表	搜索库详情信息。
SearchTable	搜索表详情列表	搜索表详情列表。
ListTableColumns	获取表字段信息	获取表字段信息。
ListColumns	获取表的列信息	返回表的列信息。
ListIndexes	获取表的索引信息	调用ListIndexes返回表索引信息。
GetDatabase	获取具体库详情信息	调用GetDatabase获取具体库详情信息。
GetPhysicalDatabase	获取物理库的详情	调用GetPhysicalDatabase获取物理库的详情。
GetTableTopology	获取数据表的拓扑信息	调用GetTableTopology获取数据表的拓扑信息。
GetMetaTableDetailInfo	获取表的字段、索引等信息	调用GetMetaTableDetailInfo接口获取表的字段、索引等信息。
GetMetaTableColumn	获取表的字段信息	调用GetMetaTableColumn接口获取表的字段信息。
SyncInstanceMeta	同步实例下所有数据库的元数据	调用SyncInstanceMeta同步实例下所有数据库字典元数据。
SyncDatabaseMeta	同步数据库元数据	同步数据库字典元数据。
GetTableKnowledgeInfo	获取表的资产描述	获取指定guid的元数据知识
EditMetaKnowledgeAsset	编辑元数据的资产描述	编辑指定guid的元数据业务知识

工单操作

API	标题	API概述
通用	通用
CreateOrder	创建工单	创建工单。
GetApprovalDetail	获取工单审批详情	调用GetApprovalDetail获取工单审批详情。
ListOrders	获取工单列表信息	调用ListOrders获取工单列表信息。
GetOrderBaseInfo	获取工单基本信息	调用GetOrderBaseInfo获取工单基本信息。
SubmitOrderApproval	提交工单审批	调用SubmitOrderApproval提交工单审批。
ApproveOrder	审批工单	调用ApproveOrder接口审批工单。
CloseOrder	关闭工单	调用CloseOrder关闭工单。
GetOrderAttachmentFile	获取工单附件下载地址	调用GetOrderAttachmentFile接口，获取工单附件下载地址。
PreviewWorkflow	预览工单审批流	该API用于在正式提交审批前，预览工单审批流。
权限申请	权限申请
GetOwnerApplyOrderDetail	获取申请数据权限工单详情	获取申请库-Owner、表-Owner、实例-Owner的工单详情。
GetPermApplyOrderDetail	获取申请操作权限的工单详情	调用GetPermApplyOrderDetail获取权限申请的工单详情。
库表同步	库表同步
CreateStructSyncOrder	创建结构同步工单	创建变更工单。
GetStructSyncOrderDetail	获取结构同步的工单详情信息	调用GetStructSyncOrderDetail获取结构同步的工单详情信息。
GetStructSyncJobDetail	获取结构同步任务详情	调用GetStructSyncJobDetail获取结构同步的任务详情。
GetStructSyncJobAnalyzeResult	获取结构同步的任务分析结果	调用GetStructSyncJobAnalyzeResult获取结构同步的任务分析结果。
GetStructSyncExecSqlDetail	获取结构同步的执行SQL脚本	调用GetStructSyncExecSqlDetail获取结构同步的执行SQL脚本。
SubmitStructSyncOrderApproval	提交结构同步工单至审批流程	调用SubmitStructSyncOrderApproval提交结构同步工单至审批流程。
ExecuteStructSync	执行结构同步工单	调用此API执行结构同步工单。
数据变更	数据变更
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任务进行重试。
ListDataImportSQLPreCheckDetail	获取数据导入预检SQL详情	获取数据导入预检SQL详情。
ListDataImportSQLType	获取数据导入SQL类型	获取数据导入SQL类型。
GetDataImportSQL	获取数据导入的SQL	获取数据导入的SQL。
SkipDataCorrectRowCheck	跳过数据变更预检查行数校验	跳过数据变更预检查行数校验。
CreateProcCorrectOrder	创建可编程对象变更工单	使用此API创建可编程对象变更工单。
结构设计	结构设计
CreatePublishGroupTask	执行结构设计工单	执行结构设计工单。
ListDDLPublishRecords	获取结构设计工单详情	获取结构设计工单的发布详情。
GetTableDesignProjectFlow	获取结构设计项目流程信息	调用此API可获取结构设计工单当前所在环节、是否允许返回结构设计节点、执行发布的策略等信息。
GetTableDesignProjectInfo	获取结构设计项目信息	调用此API可获取指定结构设计工单的项目信息以及工单的变更基准库的信息，包含结构设计工单的状态、工单创建者ID、基准库的名称和ID等。
数据导出	数据导出
CreateDatabaseExportOrder	创建数据库导出工单	创建数据库导出工单。
CreateDataExportOrder	创建SQL结果集导出工单	创建SQL结果集导出工单。
ExecuteDataExport	执行数据导出工单	调用ExecuteDataExport执行数据导出工单。
GetDataExportPreCheckDetail	查看SQL结果集导出预检查详情	查看SQL结果集导出工单预检查详情。
GetDataExportDownloadURL	获取数据导出结果附件下载地址	调用GetDataExportDownloadURL获取数据导出结果附件下载地址。
GetDatabaseExportOrderDetail	获取数据库导出工单详情	获取数据库导出工单详情。
GetDataExportOrderDetail	获取SQL结果集导出工单详情	获取SQL结果集导出工单详情。
GetDbExportDownloadURL	获取数据库导出结果附件下载地址	调用GetDbExportDownloadURL接口，获取数据库导出结果附件下载地址。
SuspendDataExportJob	中断SQL结果集导出任务	调用此接口可以中断正在执行或定时执行的SQL结果集导出任务。
PauseDataExportJob	终止SQL结果集导出任务	调用此接口可以终止SQL结果集导出任务。
RemoveDataExportJob	删除数据导出任务	调用此接口可以删除数据导出任务。
RestartDataExportJob	重启SQL结果集导出任务	调用此接口重启SQL结果集导出任务。
SQL审核	SQL审核
CreateSQLReviewOrder	创建SQL审核工单	调用CreateSQLReviewOrder创建SQL审核工单。
GetSQLReviewCheckResultStatus	获取SQL审核工单的审核结果	获取SQL审核工单的审核结果。
ListSQLReviewOriginSQL	获取SQL审核工单的SQL详情	获取SQL审核工单的SQL详情结果。
GetSQLReviewOptimizeDetail	获取SQL审核优化建议的详情	获取SQL审核优化建议的详情，适用于数据变更工单和SQLReview工单。
数据追踪	数据追踪
CreateDataTrackOrder	创建数据追踪工单	创建数据追踪工单。
GetDataTrackJobDegree	获取数据追踪任务进度	获取数据追踪任务进度。
GetDataTrackJobTableMeta	获取数据追踪表元数据信息	获取数据追踪表元数据信息。
GetDataTrackOrderDetail	获取数据追踪工单详情	获取数据追踪工单详情。
SearchDataTrackResult	搜索数据追踪日志解析结果	搜索数据追踪日志解析结果。
DownloadDataTrackResult	下载数据追踪日志解析结果	下载数据追踪日志解析结果。
QueryDataTrackResultDownloadStatus	查询下载数据追踪日志解析结果进度	查询下载数据追踪日志解析结果进度。
附件上传	附件上传
CreateUploadFileJob	上传链接形式附件	创建上传链接形式附件任务，获得附件任务Key。
CreateUploadOSSFileJob	上传OSS附件	创建上传OSS附件任务，获得附件任务Key。
GetUserUploadFileJob	获取上传附件的任务信息	获取上传附件的任务信息。
数据归档	数据归档
CreateDataArchiveOrder	创建数据归档工单	使用此API可以创建数据归档工单，将数据归档至专属存储、RDS MySQL等目标中。
GetDataArchiveOrderDetail	获取数据归档工单详情	调用此API获取数据归档工单详情，包含工单的创建时间、任务调度信息、归档任务日志和归档数据库的信息等。
GetDataArchiveCount	获取数据归档工单量统计	获取数据归档工单量统计，包括：归档成功的工单数、归档失败的工单数、正在进行归档的工单数和归档工单的总数。
GetPagedInstance	获取工单任务信息	返回指定工单的任务信息。

SQL任务

API	标题	API概述
ListDBTaskSQLJob	获取SQL任务列表	获取SQL任务列表。
ListDBTaskSQLJobDetail	获取SQL任务的详情信息	获取SQL任务的详情信息。
GetDBTaskSQLJobLog	获取SQL任务日志	获取SQL任务调度详情日志。
GetOnlineDDLProgress	获取OnlineDDL任务执行进度详情	调用GetOnlineDDLProgress接口，获取OnlineDDL任务执行进度详情。
GenerateSqlFromNL	根据自然语言生成SQL	调用该API可根据用户提供的自然语言描述，自动获取相关数据库与业务信息并生成可执行的SQL语句。

权限管理

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

安全管理

API	标题	API概述
安全规则	安全规则
CreateStandardGroup	创建安全规则集	调用CreateStandardGroup创建安全规则集。
ListStandardGroups	获取安全规则集列表	获取安全规则集列表。
UpdateStandardGroup	调整安全规则集的配置信息	使用该API可以调整指定安全规则集的名称及描述信息。
DeleteStandardGroup	删除安全规则集	调用DeleteStandardGroup接口可以删除已创建的安全规则集。
GetStandardGroup	获取安全规则集	调用GetStandardGroup接口可以获取到租户下已有的安全规则集信息，包含规则名称、描述及规则关联实例的类型等信息。
敏感数据管理	敏感数据管理
AddDesensitizationRule	添加脱敏规则	添加脱敏规则。
ListDesensitizationRule	获取脱敏规则列表	获取脱敏规则列表。
ModifyDesensitizationStrategy	修改字段绑定的脱敏规则	修改字段绑定的脱敏规则。
ListClassificationTemplates	获取分类分级模板列表	调用ListClassificationTemplates接口，获取分类分级模板列表信息。
ListSensitiveDataAuditLog	查看敏感信息审计日志详情	调用ListSensitiveDataAuditLog接口，查看敏感信息审计日志详情。
ListSensitiveColumns	搜索敏感字段列表	调用ListSensitiveColumns搜索敏感字段列表。
ListSensitiveColumnsDetail	获取敏感字段详情信息	调用ListSensitiveColumnsDetail获取敏感字段详情信息。
ChangeColumnSecLevel	调整字段敏感等级	调整字段敏感等级。
ChangeColumnSecurityLevel	调整字段安全级别	调整字段的安全级别。
GetClassificationTemplate	获取实例绑定的分类分级模板	使用此API获取实例绑定的分类分级模板信息，包含模板ID、模板类型等信息。
ListSensitivityLevel	获取分类分级模板的敏感序列列表	获取分类分级模板对应的敏感序列列表。
ListSensitiveColumnInfo	获取敏感字段的脱敏算法相关信息	调用此接口可以获取到敏感字段所使用的脱敏算法ID、名称，以及字段的安全级别等信息。
安全访问代理	安全访问代理
CreateProxy	开启数据安全访问	调用CreateProxy接口，开启实例的数据安全访问功能。
DeleteProxy	关闭安全访问代理	关闭实例的安全访问代理。
ListProxies	获取安全访问代理列表	获取安全访问代理列表。
GetProxy	获取数据安全访问代理的详细信息	获取数据安全访问代理的详细信息。
CreateProxyAccess	授予安全访问代理权限	授予用户安全访问代理权限。
DeleteProxyAccess	回收安全访问代理权限	回收目标用户的安全访问代理权限。
ListProxyAccesses	获取安全访问代理的授权列表	获取安全访问代理的授权列表。
InspectProxyAccessSecret	获取安全访问代理的授权密码	获取安全访问代理的授权密码。
GetProxyAccess	获取安全访问代理授权信息	获取安全访问代理的授权。
权限模板	权限模板
GrantTemplateAuthority	授予用户权限模板中的资源权限	授予用户权限模板中的资源权限。
RevokeTemplateAuthority	回收权限模板中的资源权限	回收权限模板中的资源权限。
CreateAuthorityTemplate	创建权限模板	创建权限模板。
UpdateAuthorityTemplate	更新权限模板	更新权限模板。
AddAuthorityTemplateItems	为权限模板添加资源	调用此API给指定权限模板添加实例、数据库、表资源。
GetAuthorityTemplateItem	获取权限模板中的资源列表	获取权限模板中的资源列表。
GetAuthorityTemplate	获取权限模板详情	获取权限模板详情。
ListAuthorityTemplate	获取权限模板列表	调用ListAuthorityTemplate接口获取权限模板列表，包含模板创建者、模板名称、模板创建者及模板总数等信息。
DeleteAuthorityTemplate	删除权限模板	调用DeleteAuthorityTemplate接口可以删除已创建的权限模板。
权限策略	权限策略
CreateAbacPolicy	创建权限策略	调用此API可以创建权限策略，以帮助您对DMS功能以及托管在DMS的数据资源进行细粒度的管控。
ListAbacPolicies	获取权限策略列表	调用此API可以获取已创建的权限策略列表。
UpdateAbacPolicy	更新权限策略信息	调用此API可以指定更新权限策略的名称、描述和内容。
DeleteAbacPolicy	删除权限策略	调用此API可以删除已创建的权限策略。
GetAbacPolicy	获取权限策略详情	调用此API可以获取权限策略详情，包含策略名称、内容、创建人等信息。
CreateAbacAuthorization	新增权限策略授权	调用此API可以给DMS用户或自定义角色授予策略权限，包含系统权限策略和自定义权限策略。
ListAbacAuthorizations	获取权限策略授权列表	调用此API可以获取指定权限策略被授权给用户的数量及列表。
DeleteAbacAuthorization	解除权限策略授权	调用此API可以解除权限策略与用户或角色之间的授权关系。

数据查询

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超时提醒	调用此API可以更新任务流SLA超时提醒。
GetRuleNumLimitOfSLA	获取自定义SLA规则数量限制	调用GetRuleNumLimitOfSLA接口，获取任务编排自定义SLA规则的限制数量，自定义的SLA规则数量不可超过该限制数。
GetIntervalLimitOfSLA	获取超时规则最小调度周期	调用GetIntervalLimitOfSLA接口，获取任务流允许配置SLA超时规则时，其最小调度周期限制。
ListDefaultSLARules	获取默认SLA超时规则	调用ListDefaultSLARules，获取默认SLA超时提醒规则。
ListTaskFlowCooperators	获取任务流相关人列表	获取任务流相关人列表。
ListSLARules	获取自定义SLA规则列表	调用此API可以获取自定义SLA规则列表。
GetTask	获取任务流节点配置	调用GetTask接口，按照任务流节点ID获取指定节点的配置，包括任务的时间变量。
MoveTaskFlowToScenario	移动任务流至指定业务场景	调用MoveTaskFlowToScenario接口，移动任务流至指定业务场景。
GetTaskFlowNotification	获取任务流通知设置	调用GetTaskFlowNotification接口，获取任务流通知设置。
UpdateTaskName	更新任务名称	调用UpdateTaskName接口，更新任务名称。
UpdateTaskOutput	更新任务节点的输出变量	调用UpdateTaskOutput接口，更新任务节点的输出变量。
DeleteTaskFlowEdgesByCondition	按照多条件删除任务流边	调用DeleteTaskFlowEdgesByCondition接口，按照多条件删除任务流边。
ListTaskFlowEdgesByCondition	获取指定任务流DAG图的边	调用ListTaskFlowEdgesByCondition接口，多条件获取指定任务流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接口，创建任务流任务。
UpdateTaskContentV2	更新任务流中的大任务	接受大容量sql文件的更新节点内容API。
TryRunTaskFlow	试运行任务流	调用该API可试运行任务编排的任务流。
数仓开发	数仓开发
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按量付费商品。

资产类目

API	标题	API概述
CreateMetaCategory	创建资产类目	创建资产类目。
ListMetaCategory	获取资产类目列表	获取资产类目列表。
UpdateMetaCategory	更新资产类目信息	更新资产类目信息。
DeleteMetaCategory	删除资产类目	删除资产类目。
ListTablesInCategory	获取归属类目下的表列表	获取类目下的表列表。
AddTableToCategory	资产类目添加表	添加表到资产类目。
RemoveTableFromCategory	从资产类目中移除表	从资产类目移除表。

工作空间

API	标题	API概述
DeleteWorkspace	删除工作空间	该接口用于删除工作空间。
GetWorkspace	获取工作空间详情	该接口用于获取工作空间的详情信息。

其他

API	标题	API概述
OptimizeSqlByMetaAgent	SQL优化	根据用户提供的SQL数据库ID，分析SQL性能并优化
FixSqlByMetaAgent	SQL报错修复	根据用户提供的SQL，报错信息和数据库ID，分析SQL报错原因并修复
AnswerSqlSyntaxByMetaAgent	语法回答	根据用户提供的数据库ID，回答对应引擎的语法问题
ListUserOwnedResources	获取用户Owner的资源列表	获取用户Owner的资源列表。
CheckBatchTableAccessPermission	批量校验表权限	批量校验数据表权限
ChatWithDesensitize	脱敏聊天API	带有DMS脱敏能力的聊天API接口
ChatWithDesensitizeSSE	数据脱敏聊天的SSE接口	数据脱敏聊天的SSE接口
CreateWorkspace	创建工作空间	该接口用于创建工作空间。
DeleteUser	删除产品内的云账号	调用该API可删除已录入DMS的用户（阿里云账号）。
DisableUser	禁用产品内的云账号	可禁用产品内暂时不需要的云账号。
EnableUser	启用产品内禁用的云账号	可启用产品内先前已经禁用的云账号。
GetAIOrderApprovalCommentSSE	获取大模型工单审批建议	获取大模型工单审批建议
GetUser	获取用户信息	获取特定的用户信息。
ListDatabases	获取实例的数据库详情列表	调用ListDatabases获取一个实例下的数据库列表详情信息。
ListTables	获取数据库的表详情列表	调用ListTables获取一个库下面的表详情列表。
ListTagMetaAsset	获取DataAgent协作空间数据中心添加库表信息	获取DataAgent协作空间数据中心添加库表信息。
ListUsers	获取用户详情列表	获取用户的详情列表。
ListWorkspaces	获取工作空间列表	该接口用于获取租户下的工作空间列表。
UpdateWorkspace	更新工作空间	该接口用于更新工作空间的信息。