API 概览

最近更新时间：2024-04-18 15:08:05

我的收藏

本页目录：

智能运维相关接口

接口名称	接口功能	频率限制（次/秒）
FreezeTasksByWorkflowIds	暂停工作流下的所有任务	20
DescribeDrInstancePage	分页查询试运行实例列表	20
DescribeEventConsumeTasks	事件实例-事件实例查看消费任务	20
DescribeEventCases	查找事件实例	20
DescribeTaskByCycle	周期任务统计	20
BatchRunOpsTask	任务运维-批量启动任务	20

数据开发相关接口

接口名称	接口功能	频率限制（次/秒）
DeleteProjectParamDs	删除项目参数	20
CreateWorkflowDs	创建工作流	20
CreateTaskVersionDs	提交任务版本	20
RemoveWorkflowDs	删除编排空间工作流	20
TriggerDsEvent	触发事件	50
DeleteTaskDs	删除编排空间任务	20
DescribeBatchOperateTask	批量操作页面获取任务列表	20
DeleteFilePath	开发空间-批量删除目录和文件	20
GetFileInfo	开发空间-获取数据开发脚本信息	20
FindAllFolder	编排空间批量操作页面查找全部的文件夹	20
DescribeDsFolderTree	编排空间-查询目录树	20
DeleteFile	开发空间-删除文件	20
UploadContent	开发空间-保存任务信息	20
SubmitSqlTask	提交SQL任务	20
SubmitTaskTestRun	提交工作流测试运行任务	20
DeleteResource	删除资源	20
DescribeResourceManagePathTrees	获取资源管理目录树	20
CreateCustomFunction	创建用户自定义函数	20
DeleteCustomFunction	删除用户自定义函数	20
DescribeFunctionKinds	查询函数分类	20
DescribeFunctionTypes	查询函数类型	20
DescribeOrganizationalFunctions	查询全量函数（层级化）接口	20
SaveCustomFunction	保存用户自定义函数	20
SubmitCustomFunction	提交自定义函数	20
CreateDsFolder	创建文件夹	20
DeleteDsFolder	删除文件夹	20
DescribeDsParentFolderTree	编排空间-查询父目录树	20
ModifyDsFolder	文件夹更新	20
DeleteResourceFile	【资源管理】删除资源	20
DeleteResourceFiles	【资源管理】批量删除资源	20

数据运营相关接口

接口名称	接口功能	频率限制（次/秒）
DescribeTableLineageInfo	表血缘信息查询接口	20
DescribeFieldBasicInfo	字段基础信息查询	20
DescribeTableBasicInfo	表基础信息查询	20

元数据相关接口

接口名称	接口功能	频率限制（次/秒）
DescribeColumnLineage	列出字段血缘信息	20
DescribeTableLineage	列出表血缘信息	20

任务运维相关接口

接口名称	接口功能	频率限制（次/秒）
DeleteWorkflowById	通过工作流Id删除工作流	20
DescribeDependTaskLists	通过taskIds查询task详情列表	20
DescribeWorkflowExecuteById	查询工作流画布运行起止时间	20
DescribeWorkflowTaskCount	查询工作流任务数	20
DescribeWorkflowListByProjectId	根据项目id 获取项目下所有工作流列表	20
DescribeWorkflowInfoById	通过工作流id，查询工作流详情	20
UpdateWorkflowOwner	修改工作流责任人	20
RunRerunScheduleInstances	任务运维-实例批量重跑	20
DescribeWorkflowCanvasInfo	查询工作流画布	20
DescribeAllByFolderNew	查询父目录下所有子文件夹+工作流	20
DescribeTaskRunHistory	分页查询任务运行历史	20
RunForceSucScheduleInstances	实例运维-实例批量置成功	20
KillScheduleInstances	实例运维-批量终止l实例	20
RunTasksByMultiWorkflow	批量启动工作流	20
DescribeTaskByStatusReport	任务状态趋势	20
DescribeStatisticInstanceStatusTrendOps	实例状态趋势	20
DescribeOpsWorkflows	查询用户生产工作流列表	20
DescribeSchedulerTaskTypeCnt	运维大屏-任务状态分布	20
BatchStopWorkflowsByIds	批量停止工作流	20
DescribeInstanceByCycle	周期实例统计	20
DescribeTaskByCycleReport	任务状态周期增长趋势	20
DescribeSchedulerInstanceStatus	运维大屏-实例状态分布	20
DescribeScheduleInstances	aiops-获取实例列表	20
CreateOpsMakePlan	任务运维-批量补数据（创建补录计划）	20
DescribeSchedulerTaskCntByStatus	任务状态统计	20
DescribeSchedulerRunTimeInstanceCntByStatus	运维大屏-实例运行时长排行	20
DescribeOpsMakePlanInstances	数据补录-查看补录计划任务实例	20
DescribeOpsMakePlanTasks	数据补录-查看补录计划任务	20
DescribeOpsMakePlans	数据补录-查询补录计划	20
KillOpsMakePlanInstances	数据补录-按补录计划批量终止实例	20
BatchDeleteOpsTasks	任务运维-批量删除任务	20
DescribeFolderWorkflowList	拉取文件夹下的工作流	20
DescribeTaskScript	查询任务脚本	20
ModifyTaskInfo	更新任务	20
ModifyTaskLinks	添加父任务依赖	20
ModifyTaskScript	修改任务脚本	20
ModifyWorkflowSchedule	更新工作流调度	20
RegisterEvent	注册事件（新建事件）	20
RegisterEventListener	注册事件监听器	20
SetTaskAlarmNew	设置任务告警，新建（更新）告警信息	20
SubmitTask	提交任务	20
SubmitWorkflow	提交工作流	20
TriggerEvent	触发事件生成事件实例	20
BatchModifyOpsOwners	任务运维-批量修改任务责任人	20
BatchStopOpsTasks	智能运维-批量停止任务	20
CountOpsInstanceState	智能运维-统计任务实例状态	20
DescribeDependOpsTasks	根据层级查找上-下游任务节点	20
DescribeOperateOpsTasks	智能运维-任务运维列表组合条件查询	20
DescribeSuccessorOpsTaskInfos	获取任务全部下游（开发态）	20
FreezeOpsTasks	批量冻结任务	20
CreateTask	创建任务	20
ModifyWorkflowInfo	更新工作流信息	20

实例运维相关接口

接口名称	接口功能	频率限制（次/秒）
DescribeInstanceLogFile	下载日志文件	20
DescribeThirdTaskRunLog	实例运维-获取第三方运行日志	20
DescribeEvent	实例运维-事件实例-查询事件详情	20
DiagnosePro	实例诊断信息-新	20
DagInstances	拉取dag实例	20
DescribeOpsInstanceLogList	实例运维-获取实例日志列表	20
DescribeInstanceLogDetail	实例运维-获取具体实例相关日志信息内容	20

数据地图数据字典相关接口

接口名称	接口功能	频率限制（次/秒）
DescribeColumnsMeta	查询表的所有列元数据	20
DescribeDatabaseMetas	查询数据库列表	20
DescribeTableMeta	查询表元数据详情	20
DescribeTableMetas	获取表元数据list	20

数据质量相关接口

接口名称	接口功能	频率限制（次/秒）
CommitRuleGroupTask	提交规则组运行任务接口	20
CreateRule	创建质量规则接口	20
CreateRuleTemplate	创建规则模板	20
DeleteRule	删除质量规则接口	20
DeleteRuleTemplate	删除规则模板	20
DescribeDataCheckStat	数据质量数据监测情况接口	20
DescribeDimensionScore	查询维度评分	20
DescribeExecStrategy	查询规则组执行策略	20
DescribeQualityScore	查询质量评分	20
DescribeQualityScoreTrend	查询质量分趋势	20
DescribeRule	查询规则详情	20
DescribeRuleDimStat	数据质量触发维度分布统计接口	20
DescribeRuleExecDetail	查询规则执行结果详情	20
DescribeRuleExecLog	规则执行日志查询	20
DescribeRuleExecResults	规则执行结果列表查询	20
DescribeRuleExecStat	数据质量规则运行情况接口	20
DescribeRuleGroup	查询规则组详情接口	20
DescribeRuleGroupExecResultsByPage	规则组执行结果分页查询接口	20
DescribeRuleGroupSubscription	查询规则组订阅信息	20
DescribeRuleGroupTable	查询表绑定执行规则组信息	20
DescribeRuleGroupsByPage	分页查询规则组接口	20
DescribeRuleTemplate	查询模板详情	20
DescribeRuleTemplates	查询规则模板列表	20
DescribeRules	查询质量规则列表	20
DescribeRulesByPage	分页查询质量规则	20
DescribeTableQualityDetails	查询表质量详情	20
DescribeTableScoreTrend	查询表得分趋势	20
DescribeTemplateDimCount	查询规则模板维度分布情况	20
DescribeTopTableStat	数据质量表排行接口	20
DescribeTrendStat	数据质量概览页面趋势接口	20
ModifyDimensionWeight	修改维度权重	20
ModifyExecStrategy	更新规则组执行策略	20
ModifyMonitorStatus	更新监控状态	20
ModifyRule	更新质量规则接口	20
ModifyRuleGroupSubscription	更新规则组订阅信息	20
ModifyRuleTemplate	编辑规则模板	20

数据集成相关接口

接口名称	接口功能	频率限制（次/秒）
BatchCreateIntegrationTaskAlarms	批量创建任务告警规则	20
BatchDeleteIntegrationTasks	批量删除集成任务	20
BatchForceSuccessIntegrationTaskInstances	批量置成功集成任务实例	20
BatchKillIntegrationTaskInstances	批量终止集成任务实例	20
BatchMakeUpIntegrationTasks	批量补数据	20
BatchRerunIntegrationTaskInstances	批量重跑集成任务实例	20
BatchResumeIntegrationTasks	批量继续执行集成任务	20
BatchStartIntegrationTasks	批量运行集成任务	20
BatchStopIntegrationTasks	批量停止集成任务	20
BatchSuspendIntegrationTasks	批量暂停集成任务	20
BatchUpdateIntegrationTasks	批量更新集成任务	20
CheckAlarmRegularNameExist	判断告警规则重名	20
CheckIntegrationNodeNameExists	判断集成节点名称是否存在	20
CheckIntegrationTaskNameExists	判断集成任务名称是否存在	20
CheckTaskNameExist	离线任务重名校验	20
CommitIntegrationTask	提交集成任务	20
CreateHiveTable	建hive表	20
CreateHiveTableByDDL	创建hive表	20
CreateIntegrationNode	创建集成节点	20
CreateIntegrationTask	创建集成任务	20
CreateTaskAlarmRegular	创建任务告警规则	20
DeleteIntegrationNode	删除集成节点	20
DeleteIntegrationTask	删除集成任务	20
DeleteOfflineTask	删除任务	20
DeleteTaskAlarmRegular	删除任务告警规则	20
DescribeAlarmEvents	告警事件列表	20
DescribeAlarmReceiver	告警接收人详情	20
DescribeInstanceLastLog	获取日志详情页面	20
DescribeInstanceList	获取离线运维实例列表	20
DescribeInstanceLog	获取实例运行日志	20
DescribeInstanceLogList	获取离线任务实例运行日志列表	20
DescribeIntegrationNode	查询集成节点	20
DescribeIntegrationStatistics	数据集成大屏概览	20
DescribeIntegrationStatisticsInstanceTrend	数据集成大屏实例状态统计趋势	20
DescribeIntegrationStatisticsRecordsTrend	数据集成大屏同步条数统计趋势	20
DescribeIntegrationStatisticsTaskStatus	数据集成大屏任务状态分布统计	20
DescribeIntegrationStatisticsTaskStatusTrend	数据集成大屏任务状态统计趋势	20
DescribeIntegrationTask	查询集成任务详情	20
DescribeIntegrationTasks	查询集成任务列表	20
DescribeIntegrationVersionNodesInfo	查询集成任务版本节点信息	20
DescribeOfflineTaskToken	获取离线任务长连接Token	20
DescribeRealTimeTaskInstanceNodeInfo	查询实时任务实例节点信息	20
DescribeRealTimeTaskSpeed	实时任务同步速度趋势	20
DescribeRuleTemplatesByPage	规则模板查询接口	20
DescribeStreamTaskLogList	查询实时任务日志列表	20
DescribeTaskAlarmRegulations	查询任务告警规则列表	20
DescribeTaskLockStatus	查看任务锁状态信息	20
DryRunDIOfflineTask	调试运行集成任务	20
GenHiveTableDDLSql	生成建hive表的sql	20
GetIntegrationNodeColumnSchema	提取数据集成节点字段Schema	20
GetOfflineDIInstanceList	获取离线任务实例列表(新)	20
GetOfflineInstanceList	获取离线任务实例	20
LockIntegrationTask	锁定集成任务	20
ModifyIntegrationNode	更新集成节点	20
ModifyIntegrationTask	更新集成任务	20
ModifyTaskAlarmRegular	修改任务告警规则	20
ModifyTaskName	重命名任务（任务编辑）	20
ResumeIntegrationTask	继续集成任务	20
RobAndLockIntegrationTask	抢占锁定集成任务	20
StartIntegrationTask	启动集成任务	20
StopIntegrationTask	停止集成任务	20
SuspendIntegrationTask	暂停集成任务	20
TaskLog	查询实时任务日志接口	20
UnlockIntegrationTask	解锁集成任务	20
CreateOfflineTask	创建离线任务	20
DescribeRealTimeTaskMetricOverview	实时任务运行指标概览	20

平台管理相关接口

接口名称	接口功能	频率限制（次/秒）
DeleteProjectUsers	删除项目用户	20
DescribeApproveList	获取待审批列表	20
DescribeApproveTypeList	获取审批分类列表	20
DescribeProject	获取项目信息	20
ModifyApproveStatus	修改审批单状态	20

数据源管理相关接口

接口名称	接口功能	频率限制（次/秒）
CreateDataSource	数据源管理-创建数据源	20
DeleteDataSources	数据源管理-删除数据源	20
DescribeDataSourceInfoList	获取数据源信息	20
DescribeDataSourceList	数据源管理-查询数据源分页列表	20
DescribeDatabaseInfoList	获取数据库信息	20
DescribeDatasource	数据源管理-数据源详情	20
DescribeTableInfoList	获取数据表信息	20
DescribeTableSchemaInfo	获取表schema信息	20
ModifyDataSource	数据源管理-修改数据源	20