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

空间管理

API标题API概述
工作空间工作空间
CreateProject新建工作空间创建工作空间。
UpdateProject更新工作空间该接口用于更新DataWorks工作空间。
DeleteProject移除工作空间调用DeleteProject接口,删除DataWorks工作空间。
GetProject获取工作空间详情该接口用于查询一个DataWorks工作空间的详细信息。
ListProjects获取工作空间详情列表该接口用于查询用户所在租户下的DataWorks工作空间列表。
空间角色空间角色
GetProjectRole获取工作空间角色详情查询工作空间角色详情。
ListProjectRoles获取工作空间角色详情列表分页查询工作空间角色详情。
空间成员空间成员
CreateProjectMember创建工作空间成员添加工作空间成员同时授予工作空间角色。
DeleteProjectMember移除工作空间成员移除工作空间成员及其已授予的工作空间角色。
GrantMemberProjectRoles授予工作空间成员新的空间角色授予工作空间成员角色
RevokeMemberProjectRoles撤销空间成员的空间角色撤销工作空间成员的角色
GetProjectMember查询工作空间成员详情查询工作空间成员详情
ListProjectMembers查询工作空间成员列表分页查询工作空间成员详情。

数据源

API标题API概述
CreateDataSource创建数据源在指定项目空间创建一条数据源,可以是开发环境或生产环境。
DeleteDataSource删除数据源根据数据源ID,删除指定的数据源。
UpdateDataSource修改数据源根据数据源ID,修改指定的数据源。
CloneDataSource克隆数据源根据已有的数据源,克隆一条新的数据源。
GetDataSource查看数据源详情根据数据源ID,查询指定的数据源。
ListDataSources查询数据源列表根据数据源业务信息,查询符合的数据源列表。
数据源分享规则数据源分享规则
CreateDataSourceSharedRule创建数据源分享规则创建一条数据源分享规则,即将数据源分享给其他空间或者子账号使用。
DeleteDataSourceSharedRule删除数据源分享规则根据数据源分享规则ID,删除一条数据源分享规则。
ListDataSourceSharedRules查询数据源分享规则列表查询某个数据源配置的规则列表。

资源组管理

API标题API概述
资源组资源组
CreateResourceGroup创建资源组创建资源组。
DeleteResourceGroup删除通用资源组删除通用资源组。
UpdateResourceGroup更新资源组基本信息更新资源组基本信息。
GetResourceGroup根据id获取指定资源组信息根据id获取指定资源组信息。
ListResourceGroups获取资源组列表获取资源组列表。
DissociateProjectFromResourceGroup将资源组和某个工作空间解除关联将资源组和某个工作空间解除关联。
AssociateProjectToResourceGroup关联资源组到某个工作空间关联资源组到某个工作空间。
路由路由
CreateRoute创建网络资源的路由创建网络资源的路由。
DeleteRoute删除网络资源的路由删除网络资源的路由。
UpdateRoute更新路由信息更新路由信息。
GetRoute根据id获取指定路由信息根据id获取指定路由信息。
ListRoutes获取网络资源的路由列表获取网络资源的路由列表。
网络网络
CreateNetwork创建资源组网络创建并绑定通用资源组网络资源。
DeleteNetwork解绑并删除通用资源组网络资源解绑并删除通用资源组网络资源。
GetNetwork获取某个网络资源详细信息获取某个网络资源详细信息。
ListNetworks获取资源组网络资源列表获取资源组网络资源列表。

数据开发(新版)

API标题API概述
节点节点
CreateNode创建数据开发节点调用该接口,会在新版数据开发中创建一个数据开发节点。
DeleteNode删除数据开发节点调用此接口,可以删除指定的数据开发节点。
UpdateNode更新数据开发节点信息调用此接口,可以更新数据开发节点信息。更新通过增量更新的方式进行,更新的信息通过FlowSpec进行描述。
MoveNode移动数据开发节点路径调用此接口,可以将指定的数据开发节点的路径移动到指定位置。
RenameNode重命名数据开发节点调用此接口,可以重命名数据开发节点。
GetNode获取数据开发节点详情获取指定的数据开发节点详细信息。
ListNodes获取数据开发节点列表分页获取数据开发节点列表,也可以通过筛选条件对列表进行筛选查询。
ListNodeDependencies获取数据开发节点的依赖节点分页获取指定数据开发节点的依赖节点。
工作流工作流
CreateWorkflowDefinition创建数据开发工作流调用该接口,在数据开发指定目录下创建一个工作流。
ImportWorkflowDefinition导入数据开发工作流调用此接口,可以将通过FlowSpec定义的工作流节点和其内部的子节点都导入到数据开发中。
DeleteWorkflowDefinition删除数据开发工作流调用该接口,在数据开发中删除指定的工作流。
UpdateWorkflowDefinition更新数据开发工作流信息调用此接口,可以更新数据开发工作流基本信息。更新以增量更新的方式进行,更新信息以FlowSpec格式描述。
MoveWorkflowDefinition移动数据开发工作流路径调用此接口,可以将指定的数据开发工作流移动到数据开发目录的目标路径。
RenameWorkflowDefinition重命名数据开发工作流调用此接口,可以重命名数据开发工作流。
GetWorkflowDefinition获取数据开发工作流详情调用该接口,可以获取指定工作流的详细信息。
ListWorkflowDefinitions获取数据开发工作流列表分页获取数据开发工作流列表,也可以根据筛选条件对工作流进行筛选。
资源资源
CreateResource创建数据开发文件资源调用此接口,可以在数据开发中创建一个数据开发文件资源,文件资源的信息定义以FlowSpec格式描述。
DeleteResource删除数据开发文件资源调用此接口,可以删除指定的数据开发文件资源。
DeleteResource删除数据开发文件资源调用此接口,可以删除指定的数据开发文件资源。
UpdateResource更新数据开发文件资源信息调用此接口,可以更新数据开发文件资源的基本信息。更新以增量更新的方式进行,更新信息以FlowSpec格式描述。
MoveResource移动数据开发文件资源路径调用此接口,可以将指定数据开发文件资源移动到指定的数据开发目录中。
RenameResource重命名数据开发文件资源调用此接口,可以对数据开发文件资源进行重命名。
GetResource获取数据开发文件资源详情获取指定文件资源的详细信息。
ListResources获取数据开发文件资源列表调用此接口,可以分页获取资源文件,也可以对资源进行筛选。
函数函数
CreateFunction创建数据开发函数调用此接口,可以在数据开发中创建一个udf函数。udf函数信息以FlowSpec格式描述。
DeleteFunction删除数据开发函数调用该接口,在数据开发中删除指定的udf函数。
UpdateFunction更新数据开发函数信息调用此接口,可以更新udf函数信息。更新以增量更新的方式进行,更新信息通过FlowSpec格式描述。
UpdateFunction更新数据开发函数信息调用此接口,可以更新udf函数信息。更新以增量更新的方式进行,更新信息通过FlowSpec格式描述。
MoveFunction移动数据开发函数路径调用此接口,可以将指定udf函数移动到数据开发目录的目标路径。
RenameFunction重命名数据开发函数调用此接口,可以对指定的udf函数进行重命名。
GetFunction获取数据开发函数详情获取指定数据开发udf函数的详细信息。
ListFunctions获取数据开发函数列表调用此接口,可以分页获取数据开发中的udf函数列表,也可以使用筛选条件筛选udf函数。
发布流程发布流程
CreateDeployment创建发布流程调用此接口,可以对数据开发中的实体创建一个发布流程。
AbolishDeployment终止发布流程调用该接口,会将制定发布流程的状态变更为终止状态,但不会删除这个发布流程,仍然可以通过查询接口查询到。
ExecDeploymentStage执行发布流程的指定阶段调用此接口,可以执行发布流程的指定阶段。
GetDeployment获取发布流程详细信息调用此接口,获取发布流程详细信息。
ListDeployments获取发布流程列表分页获取发布流程列表,也可以使用筛选条件对发布流程进行筛选。

数据集成

API标题API概述
同步任务同步任务
CreateDIJob创建任务创建数据集成新版任务。
UpdateDIJob更新任务更新数据集成任务。
DeleteDIJob删除任务删除数据集成新版任务。
StopDIJob停止同步任务中止数据集成任务。
StartDIJob启动任务启动数据集成新版任务。
GetDIJob查看任务查看数据集成任务。
GetDIJobLog查看任务日志获取数据集成任务日志。
ListDIJobs查看任务查询数据集成新版任务列表。
ListDIJobRunDetails查看任务运行信息获取数据集成运行信息。
ListDIJobMetrics查看任务指标获取数据集成任务指标。
ListDIJobEvents查看任务事件获取数据集成任务事件。
任务告警任务告警
CreateDIAlarmRule创建告警规则创建数据集成报警规则。
UpdateDIAlarmRule更新告警规则更新数据集成报警规则。
DeleteDIAlarmRule删除告警规则删除数据集成报警规则。
ListDIAlarmRules查询告警规则查看数据集成报警规则。

运维中心

API标题API概述
监控告警监控告警
ListAlertRules获取自定义规则列表分页获取自定义监控告警规则
GetAlertRule获取自定义监控告警规则获取自定义监控告警规则
UpdateAlertRule更新自定义监控告警规则更新自定义监控告警规则
DeleteAlertRule删除自定义规则删除自定义监控报警规则
CreateAlertRule创建自定义监控告警规则创建自定义监控告警规则
任务任务
DeleteTask删除任务删除指定的任务。
GetTask获取任务的详情获取指定的任务的详细信息。
ListTasks获取任务列表分页获取任务列表,也可以通过条件进行筛选查询。
ListUpstreamTasks获取上游任务列表分页获取指定任务的上游任务列表。
ListDownstreamTasks获取下游任务列表分页获取指定任务的下游任务列表。
ListTaskOperationLogs获取任务的操作日志列表分页获取指定任务的操作日志列表。
任务实例任务实例
UpdateTaskInstances修改任务实例属性批量修改多个任务实例的属性,包括优先级、调度资源组、数据源等。
GetTaskInstance获取任务实例的详情获取指定的任务实例的详细信息。
GetTaskInstanceLog获取任务实例的运行日志获取指定任务实例某一次运行的运行日志。
ListTaskInstances获取任务实例列表分页获取任务实例列表,也可以通过条件进行筛选查询。
ListUpstreamTaskInstances获取上游任务实例列表分页获取指定任务实例的上游任务实例列表。
ListTaskInstanceOperationLogs获取任务实例的操作日志列表分页获取指定任务实例的操作日志列表。
ListDownstreamTaskInstances获取下游任务实例列表分页获取指定任务实例的下游任务实例列表。
SuspendTaskInstances暂停任务实例批量暂停多个任务实例。
ResumeTaskInstances恢复任务实例批量恢复多个已暂停的任务实例。
StopTaskInstances终止任务实例批量终止多个任务实例。
SetSuccessTaskInstances置成功任务实例批量置成功多个任务实例。
RerunTaskInstances重跑任务实例批量重跑多个任务实例。
RemoveTaskInstanceDependencies移除任务实例的依赖关系批量移除某任务实例的多个上游依赖关系。
TriggerSchedulerTaskInstance触发调度任务实例在某个定时时间,触发指定HTTP触发器调度任务运行。

数据质量

API标题API概述
ListDataQualityRules查询质量规则列表质量监控规则分页查询
ListDataQualityResults查询质量结果列表质量结果列表分页查询。
ListDataQualityEvaluationTasks查询质量监控任务列表质量监控任务列表分页查询。
ListDataQualityEvaluationTaskInstances查询质量监控任务实例列表质量监控任务实例列表分页查询。

开放平台

API标题API概述
GetJobStatus获取异步API运行状态返回异步任务的状态信息,调用异步化API后,通过轮训此API来获取成功状态。