空间管理
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
工作空间 | ||
CreateProject![]() | 创建工作空间 | 查看文档去调试 |
GetProject | 该接口用于查询一个DataWorks工作空间的详细信息 | 查看文档去调试 |
ListProjects![]() | 该接口用于查询用户所在租户下的DataWorks工作空间列表 | 查看文档去调试 |
UpdateProject | 该接口用于更新DataWorks工作空间 | 查看文档去调试 |
DeleteProject | 删除DataWorks工作空间 | 查看文档去调试 |
空间角色 | ||
GetProjectRole | 查询工作空间角色详情 | 查看文档去调试 |
ListProjectRoles | 分页查询工作空间角色详情 | 查看文档去调试 |
空间成员 | ||
CreateProjectMember | 添加工作空间成员同时授予工作空间角色 | 查看文档去调试 |
GetProjectMember | 查询工作空间成员详情 | 查看文档去调试 |
ListProjectMembers | 分页查询工作空间成员详情 | 查看文档去调试 |
GrantMemberProjectRoles | 授予工作空间成员角色 | 查看文档去调试 |
RevokeMemberProjectRoles | 撤销工作空间成员的角色 | 查看文档去调试 |
DeleteProjectMember | 移除工作空间成员及其已授予的工作空间角色 | 查看文档去调试 |
数据源
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
数据源分享规则 | ||
CreateDataSourceSharedRule | 创建一条数据源分享规则,即将数据源分享给其他空间或者子账号使用 | 查看文档去调试 |
ListDataSourceSharedRules | 查询某个数据源配置的规则列表 | 查看文档去调试 |
DeleteDataSourceSharedRule | 根据数据源分享规则ID,删除一条数据源分享规则 | 查看文档去调试 |
CreateDataSource | 在指定项目空间创建一条数据源,可以是开发环境或生产环境 | 查看文档去调试 |
CloneDataSource | 根据已有的数据源,克隆一条新的数据源 | 查看文档去调试 |
GetDataSource | 根据数据源ID,查询指定的数据源 | 查看文档去调试 |
ListDataSources | 根据数据源业务信息,查询符合的数据源列表 | 查看文档去调试 |
UpdateDataSource | 根据数据源ID,修改指定的数据源 | 查看文档去调试 |
DeleteDataSource | 根据数据源ID,删除指定的数据源 | 查看文档去调试 |
TestDataSourceConnectivity | 测试数据源在资源组上的连通性 | 查看文档去调试 |
资源组管理
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
资源组 | ||
CreateResourceGroup | 创建资源组 | 查看文档去调试 |
GetResourceGroup | 根据ID获取指定资源组信息 | 查看文档去调试 |
ListResourceGroups | 获取资源组列表 | 查看文档去调试 |
UpdateResourceGroup | 更新资源组基本信息 | 查看文档去调试 |
AssociateProjectToResourceGroup | 关联资源组到某个工作空间 | 查看文档去调试 |
DeleteResourceGroup | 删除通用资源组 | 查看文档去调试 |
DissociateProjectFromResourceGroup | 将资源组和某个工作空间解除关联 | 查看文档去调试 |
路由 | ||
CreateRoute | 创建网络资源的路由 | 查看文档去调试 |
GetRoute | 根据ID获取指定路由信息 | 查看文档去调试 |
ListRoutes | 获取网络资源的路由列表 | 查看文档去调试 |
UpdateRoute | 更新路由信息 | 查看文档去调试 |
DeleteRoute | 删除网络资源的路由 | 查看文档去调试 |
网络 | ||
CreateNetwork | 创建并绑定通用资源组网络资源 | 查看文档去调试 |
GetNetwork | 获取某个网络资源详细信息 | 查看文档去调试 |
ListNetworks | 获取资源组网络资源列表 | 查看文档去调试 |
DeleteNetwork | 解绑并删除通用资源组网络资源 | 查看文档去调试 |
数据开发(新版)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
节点 | ||
CreateNode![]() | 调用该接口,会在新版数据开发中创建一个数据开发节点 | 查看文档去调试 |
GetNode![]() | 获取指定的数据开发节点详细信息 | 查看文档去调试 |
ListNodes![]() | 分页获取数据开发节点列表,也可以通过筛选条件对列表进行筛选查询 | 查看文档去调试 |
ListNodeDependencies | 分页获取指定数据开发节点的依赖节点 | 查看文档去调试 |
UpdateNode | 调用此接口,可以更新数据开发节点信息。更新通过增量更新的方式进行,更新的信息通过FlowSpec进行描述 | 查看文档去调试 |
MoveNode | 调用此接口,可以将指定的数据开发节点的路径移动到指定位置 | 查看文档去调试 |
RenameNode | 调用此接口,可以重命名数据开发节点 | 查看文档去调试 |
DeleteNode | 调用此接口,可以删除指定的数据开发节点 | 查看文档去调试 |
工作流定义 | ||
CreateWorkflowDefinition | 调用该接口,在数据开发指定目录下创建一个工作流 | 查看文档去调试 |
ImportWorkflowDefinition | 调用此接口,可以将通过FlowSpec定义的工作流节点和其内部的子节点都导入到数据开发中 | 查看文档去调试 |
GetWorkflowDefinition | 调用该接口,可以获取指定工作流的详细信息 | 查看文档去调试 |
ListWorkflowDefinitions | 分页获取数据开发工作流列表,也可以根据筛选条件对工作流进行筛选 | 查看文档去调试 |
UpdateWorkflowDefinition | 调用此接口,可以更新数据开发工作流基本信息。更新以增量更新的方式进行,更新信息以FlowSpec格式描述 | 查看文档去调试 |
MoveWorkflowDefinition | 调用此接口,可以将指定的数据开发工作流移动到数据开发目录的目标路径 | 查看文档去调试 |
RenameWorkflowDefinition | 调用此接口,可以重命名数据开发工作流 | 查看文档去调试 |
DeleteWorkflowDefinition | 调用该接口,在数据开发中删除指定的工作流 | 查看文档去调试 |
资源 | ||
CreateResource | 调用此接口,可以在数据开发中创建一个数据开发文件资源,文件资源的信息定义以FlowSpec格式描述 | 查看文档去调试 |
GetResource | 获取指定文件资源的详细信息 | 查看文档去调试 |
ListResources | 调用此接口,可以分页获取资源文件,也可以对资源进行筛选 | 查看文档去调试 |
UpdateResource | 调用此接口,可以更新数据开发文件资源的基本信息。更新以增量更新的方式进行,更新信息以FlowSpec格式描述 | 查看文档去调试 |
MoveResource | 调用此接口,可以将指定数据开发文件资源移动到指定的数据开发目录中 | 查看文档去调试 |
RenameResource | 调用此接口,可以对数据开发文件资源进行重命名 | 查看文档去调试 |
DeleteResource | 调用此接口,可以删除指定的数据开发文件资源 | 查看文档去调试 |
函数 | ||
CreateFunction | 调用此接口,可以在数据开发中创建一个udf函数。udf函数信息以FlowSpec格式描述 | 查看文档去调试 |
GetFunction | 获取指定数据开发udf函数的详细信息 | 查看文档去调试 |
ListFunctions | 调用此接口,可以分页获取数据开发中的udf函数列表,也可以使用筛选条件筛选udf函数 | 查看文档去调试 |
UpdateFunction | 调用此接口,可以更新udf函数信息。更新以增量更新的方式进行,更新信息通过FlowSpec格式描述 | 查看文档去调试 |
MoveFunction | 调用此接口,可以将指定udf函数移动到数据开发目录的目标路径 | 查看文档去调试 |
RenameFunction | 调用此接口,可以对指定的udf函数进行重命名 | 查看文档去调试 |
DeleteFunction | 调用该接口,在数据开发中删除指定的udf函数 | 查看文档去调试 |
发布流程 | ||
CreateDeployment | 调用此接口,可以对数据开发中的实体创建一个发布流程 | 查看文档去调试 |
GetDeployment | 调用此接口,获取发布流程详细信息 | 查看文档去调试 |
ListDeployments | 分页获取发布流程列表,也可以使用筛选条件对发布流程进行筛选 | 查看文档去调试 |
ExecDeploymentStage | 调用此接口,可以执行发布流程的指定阶段 | 查看文档去调试 |
AbolishDeployment | 调用该接口,会将制定发布流程的状态变更为终止状态,但不会删除这个发布流程,仍然可以通过查询接口查询到 | 查看文档去调试 |
数据集成
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
同步任务 | ||
CreateDIJob![]() | 创建数据集成新版任务 | 查看文档去调试 |
GetDIJobLog | 获取数据集成任务日志 | 查看文档去调试 |
ListDIJobs | 查询数据集成新版任务列表,包括整库同步实时任务,整库同步离线任务,单表同步实时任务等数据集成任务 | 查看文档去调试 |
ListDIJobRunDetails | 获取数据集成运行信息 | 查看文档去调试 |
ListDIJobMetrics | 获取数据集成任务指标 | 查看文档去调试 |
ListDIJobEvents | 获取数据集成任务事件 | 查看文档去调试 |
UpdateDIJob | 更新数据集成任务 | 查看文档去调试 |
StopDIJob | 中止数据集成任务 | 查看文档去调试 |
StartDIJob | 启动数据集成新版任务 | 查看文档去调试 |
GetDIJob | 查看数据集成任务 | 查看文档去调试 |
DeleteDIJob | 删除数据集成新版任务 | 查看文档去调试 |
任务告警 | ||
CreateDIAlarmRule | 创建数据集成报警规则 | 查看文档去调试 |
ListDIAlarmRules | 查看数据集成报警规则 | 查看文档去调试 |
UpdateDIAlarmRule | 更新数据集成报警规则 | 查看文档去调试 |
DeleteDIAlarmRule | 删除数据集成报警规则 | 查看文档去调试 |
运维中心
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
监控告警 | ||
ListAlertRules | 分页获取自定义监控告警规则 | 查看文档去调试 |
GetAlertRule | 获取自定义监控告警规则 | 查看文档去调试 |
UpdateAlertRule | 更新自定义监控告警规则 | 查看文档去调试 |
DeleteAlertRule | 删除自定义监控报警规则 | 查看文档去调试 |
CreateAlertRule | 创建自定义监控告警规则 | 查看文档去调试 |
任务 | ||
DeleteTask | 删除指定的任务 | 查看文档去调试 |
UpdateTask | 以全量更新的方式,更新指定任务 | 查看文档去调试 |
BatchUpdateTasks | 以增量更新的方式,批量更新多个任务 | 查看文档去调试 |
GetTask![]() | 获取指定的任务的详细信息 | 查看文档去调试 |
ListTasks![]() | 分页获取任务列表,也可以通过条件进行筛选查询 | 查看文档去调试 |
ListUpstreamTasks | 分页获取指定任务的上游任务列表 | 查看文档去调试 |
ListDownstreamTasks | 分页获取指定任务的下游任务列表 | 查看文档去调试 |
ListTaskOperationLogs | 分页获取指定任务的操作日志列表 | 查看文档去调试 |
任务实例 | ||
UpdateTaskInstances | 批量修改多个任务实例的属性,包括优先级、调度资源组、数据源等 | 查看文档去调试 |
GetTaskInstance![]() | 获取指定的任务实例的详细信息 | 查看文档去调试 |
GetTaskInstanceLog | 获取指定任务实例某一次运行的运行日志 | 查看文档去调试 |
ListTaskInstances![]() | 分页获取任务实例列表,也可以通过条件进行筛选查询 | 查看文档去调试 |
ListUpstreamTaskInstances | 分页获取指定任务实例的上游任务实例列表 | 查看文档去调试 |
ListTaskInstanceOperationLogs | 分页获取指定任务实例的操作日志列表 | 查看文档去调试 |
ListDownstreamTaskInstances | 分页获取指定任务实例的下游任务实例列表 | 查看文档去调试 |
SuspendTaskInstances | 批量暂停多个任务实例 | 查看文档去调试 |
ResumeTaskInstances | 批量恢复多个已暂停的任务实例 | 查看文档去调试 |
StopTaskInstances | 批量终止多个任务实例 | 查看文档去调试 |
SetSuccessTaskInstances | 批量置成功多个任务实例 | 查看文档去调试 |
RerunTaskInstances | 批量重跑多个任务实例 | 查看文档去调试 |
RemoveTaskInstanceDependencies | 批量移除某任务实例的多个上游依赖关系 | 查看文档去调试 |
TriggerSchedulerTaskInstance | 在某个定时时间,触发指定HTTP触发器调度任务运行 | 查看文档去调试 |
工作流 | ||
DeleteWorkflow | 删除指定的工作流 | 查看文档去调试 |
UpdateWorkflow | 以全量更新的方式,更新指定工作流 | 查看文档去调试 |
GetWorkflow | 获取指定的工作流的详细信息 | 查看文档去调试 |
ListWorkflows | 分页获取工作流列表,也可以通过条件进行筛选查询 | 查看文档去调试 |
工作流实例 | ||
CreateWorkflowInstances | 根据配置创建工作流实例,如补数据工作流实例 | 查看文档去调试 |
GetCreateWorkflowInstancesResult | 查询异步创建工作流实例的结果 | 查看文档去调试 |
GetWorkflowInstance | 获取指定的工作流实例的详细信息 | 查看文档去调试 |
ListWorkflowInstances | 分页获取工作流实例列表,也可以通过条件进行筛选查询 | 查看文档去调试 |
StartWorkflowInstances | 批量启动多个工作流实例 | 查看文档去调试 |
StopWorkflowInstances | 批量终止多个工作流实例 | 查看文档去调试 |
ExecuteAdhocWorkflowInstance | 根据配置创建一个临时工作流实例 | 查看文档去调试 |
数据质量
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
质量监控任务 | ||
ListDataQualityEvaluationTasks | 质量监控任务列表分页查询 | 查看文档去调试 |
CreateDataQualityEvaluationTask | 创建DataWorks数据质量监控 | 查看文档去调试 |
GetDataQualityEvaluationTask | 查询数据质量校验任务详情 | 查看文档去调试 |
UpdateDataQualityEvaluationTask | 更新数据质量校验任务 | 查看文档去调试 |
DetachDataQualityRulesFromEvaluationTask | 取消数据质量规则和数据质量校验任务的关联 | 查看文档去调试 |
AttachDataQualityRulesToEvaluationTask | 把数据质量规则关联到数据质量校验任务上 | 查看文档去调试 |
DeleteDataQualityEvaluationTask | 删除数据质量校验任务 | 查看文档去调试 |
质量规则 | ||
ListDataQualityRules | 质量监控规则分页查询 | 查看文档去调试 |
CreateDataQualityRule | 创建质量规则 | 查看文档去调试 |
GetDataQualityRule | 查询质量规则详情 | 查看文档去调试 |
UpdateDataQualityRule | 更新质量规则 | 查看文档去调试 |
DeleteDataQualityRule | 删除质量规则 | 查看文档去调试 |
质量监控任务实例 | ||
ListDataQualityEvaluationTaskInstances | 质量监控任务实例列表分页查询 | 查看文档去调试 |
CreateDataQualityEvaluationTaskInstance | 创建数据质量校验任务实例 | 查看文档去调试 |
GetDataQualityEvaluationTaskInstance | 获取数据质量校验任务实例详情 | 查看文档去调试 |
质量规则实例 | ||
ListDataQualityResults | 质量结果列表分页查询 | 查看文档去调试 |
规则模版 | ||
CreateDataQualityRuleTemplate | 创建规则模版 | 查看文档去调试 |
GetDataQualityRuleTemplate | 查询质量规则模版详情 | 查看文档去调试 |
UpdateDataQualityRuleTemplate | 更新质量规则模版 | 查看文档去调试 |
DeleteDataQualityRuleTemplate | 删除自定义质量规则模版 | 查看文档去调试 |
ListDataQualityRuleTemplates | 查询质量规则模版列表 | 查看文档去调试 |