本产品（
大数据开发治理平台 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概述 |
|---|---|---|
| GetJobStatus | 获取异步API运行状态 | 返回异步任务的状态信息，调用异步化API后，通过轮训此API来获取成功状态。 |