API概览_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

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

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

认证文件管理

API	标题	API概述
ImportCertificate	导入认证文件	导入认证文件。
GetCertificate	查看认证文件	查看认证文件。
ListCertificates	查询证书文件列表	查询认证文件列表。
DeleteCertificate	删除认证文件	删除认证文件。

空间管理

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

数据源

API	标题	API概述
TestDataSourceConnectivity	测试数据源的连通性	测试数据源在资源组上的连通性。
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函数。
发布流程	发布流程
CreatePipelineRun	创建发布流程	调用此接口，可以对新版数据开发中的实体创建一个发布流程。
AbolishPipelineRun	终止发布流程	调用该接口，会将指定发布流程的状态变更为终止状态，但不会删除这个发布流程，仍然可以通过查询接口查询到。
ExecPipelineRunStage	执行发布流程的指定阶段	调用此接口，可以执行发布流程的指定阶段。
GetPipelineRun	获取发布流程详细信息	调用此接口，获取发布流程详细信息。
ListPipelineRuns	获取发布流程列表	分页获取发布流程列表，也可以使用筛选条件对发布流程进行筛选。
ListPipelineRunItems	获取发布内容	通过发布流程的ID获取发布内容。

数据开发（旧版）

API	标题	API概述
文件	文件
CreateFile	在数据开发中创建一个文件	调用CreateFile，在数据开发中创建一个文件。目前不支持调用该接口创建数据集成节点任务。
CreateResourceFile	创建资源文件	支持用户指定自己的文件（比如jar，py，arhive，file等）创建数据开发资源文件。
CreateUdfFile	在数据开发中创建函数类型文件	调用CreateUdfFile，在数据开发中创建函数类型文件。
DeleteFile	删除数据开发中的文件	调用DeleteFile删除数据开发中的文件。如果文件已经提交过，那么DeleteFile API会同时触发一个异步在调度系统删除的流程，需要用DeleteFile API返回的DeploymentId继续调用GetDeployment轮询被触发的异步删除流程的状态。
UpdateFile	更新已有的文件节点	调用UpdateFile更新已创建的文件。
UpdateUdfFile	更新函数的文件信息	调用UpdateUdfFile更新函数的文件信息。
GetFile	获取文件的详情	该接口用于获取文件的详情。
ListFiles	查询文件列表	调用ListFiles查询文件列表。
SubmitFile	提交文件至调度系统开发环境	提交文件至调度系统的开发环境，生成对应的任务。
DeployFile	部署文件	发布文件至生产环境。
文件夹	文件夹
CreateFolder	创建文件夹	调用CreateFolder创建文件夹。
DeleteFolder	删除数据开发页面的文件夹	调用DeleteFolder删除数据开发页面的文件夹。
UpdateFolder	更新文件夹的信息	调用UpdateFolder更新文件夹的信息。
GetFolder	获取文件夹的详情	调用GetFolder获取文件夹的详情。
ListFolders	查询文件夹的列表	调用ListFolders查询文件夹的列表。
业务流程	业务流程
CreateBusiness	创建业务流程	调用CreateBusiness，创建数据开发（DataStudio）的业务流程。
DeleteBusiness	删除业务流程	调用DeleteBusiness删除业务流程。
UpdateBusiness	更新业务流程	该接口用于更新业务流程。
GetBusiness	查询业务流程的详情	调用GetBusiness查询业务流程的详情。
ListBusiness	查询业务流程的列表	调用ListBusiness查询业务流程的列表。
发布包	发布包
GetDeploymentPackage	获取发布包的详情	调用GetDeploymentPackage获取发布包的详情。
ListDeploymentPackages	查询发布包列表信息	查询发布包列表。
ListDeploymentPackageFiles	获取待发布的文件版本列表	获取待发布的文件版本列表。
文件版本	文件版本
GetFileVersion	获取文件的版本详情	调用GetFileVersion获取文件的版本详情。
ListFileVersions	查询文件的版本列表	调用ListFileVersions查询文件的版本列表。
扩展点事件	扩展点事件
UpdateIDEEventResult	更新扩展点事件的检查结果	回调扩展点消息的检查结果。
GetIDEEventDetail	查询触发扩展点事件时的数据快照	根据DataWorks开放消息的消息ID，查询触发扩展点事件时的扩展点数据快照。
表	表
EstablishRelationTableToBusiness	导入表至业务流程	相当于在数据开发页面右键单击业务流程，选择导入表的操作。

数据集成

API	标题	API概述
同步任务	同步任务
CreateDIJob	创建数据集成同步任务	创建数据集成新版任务。
UpdateDIJob	更新数据集成同步任务	更新数据集成任务。
DeleteDIJob	删除数据集成同步任务	删除数据集成新版任务。
StopDIJob	停止数据集成同步任务	中止数据集成任务。
StartDIJob	启动数据集成同步任务	启动数据集成新版任务。
GetDIJob	查看数据集成同步任务配置详情	查看数据集成任务。
GetDIJobLog	查看数据集成同步任务的运行日志	获取数据集成任务日志。
ListDIJobs	获取数据集成同步任务配置列表	查询数据集成新版任务列表，包括整库同步实时任务，整库同步离线任务，单表同步实时任务等数据集成任务。
ListDIJobRunDetails	获取数据集成同步任务运行的执行进展	获取数据集成运行信息。
ListDIJobMetrics	查看数据集成同步任务运行指标	获取数据集成任务指标。
ListDIJobEvents	获取数据集成同步任务的运行事件列表	获取数据集成任务事件。
任务告警	任务告警
CreateDIAlarmRule	创建数据集成同步任务告警规则	创建数据集成报警规则。
UpdateDIAlarmRule	更新数据集成同步任务告警规则	更新数据集成报警规则。
DeleteDIAlarmRule	删除数据集成同步任务告警规则	删除数据集成报警规则。
ListDIAlarmRules	获取数据集成同步任务告警规则列表	查看数据集成报警规则。

数据地图

API	标题	API概述
元数据采集器类型	元数据采集器类型
ListCrawlerTypes	获取数据地图元数据采集器类型列表	查询数据地图支持的元数据采集器类型列表，其中包含元数据采集器类型，及给定类型支持的子类型和子类型之间的层级关系信息。
元数据实体	元数据实体
数据目录	数据目录
ListCatalogs	查询数据地图数据目录列表	查询数据地图下的数据目录列表，当前支持dlf与starrocks类型。 dlf类型返回支持的所有数据目录列表，starrocks类型返回特定实例下的数据目录列表。
GetCatalog	获取数据地图数据目录详情	获取数据地图中给定数据目录的详情信息，当前支持dlf与starrocks类型。
数据库	数据库
ListDatabases	查询数据地图数据库列表	查询数据地图中给定实例/集群/数据目录下的数据库列表。对于dlf/starrocks类型，查询给定数据目录下的数据库列表，其中starocks类型仅支持查询Internal Catalog；对于其他类型，查询给定实例/集群下的数据库列表。
GetDatabase	获取数据地图数据库详情	获取数据地图给定数据库的详情信息。
模式	模式
ListSchemas	查询数据地图数据库模式列表	查询数据地图中给定数据库或maxcompute项目下的模式列表，当前支持maxcompute和holo类型。
GetSchema	获取数据地图数据库模式信息	获取数据地图中给定模式的详细信息，当前支持maxcompute和holo类型。
数据表	数据表
ListTables	查询数据地图数据表列表	查询数据地图中的数据表列表。对于不支持schema级别的类型，支持查询给定数据库下的数据表列表；对于支持schema级别的类型，支持查询给定数据库/maxcompute项目/模式下的数据表列表。返回结果中仅包含数据表基础信息，不包含技术元数据与业务元数据信息。
GetTable	获取数据地图数据表详情	获取数据地图中给定数据表详情。是否返回业务元数据可选。
UpdateTableBusinessMetadata	更新数据地图数据表的业务元数据	更新数据地图数据表的业务元数据，当前仅支持更新表的使用说明。
字段	字段
ListColumns	查询数据地图数据表字段列表	查询数据地图给定数据表的字段列表。
GetColumn	获取数据地图数据表字段信息	获取数据地图数据表给定字段的详细信息。
UpdateColumnBusinessMetadata	更新数据地图数据表字段的业务元数据	更新数据地图数据表给定字段的业务元数据，当前仅支持更新字段的业务描述。
分区	分区
ListPartitions	查询数据地图数据表的分区列表	查询数据地图给定数据表的分区列表，当前支持maxcompute和hms（EMR集群）类型。
GetPartition	获取数据地图数据表的分区详情	获取数据地图数据表的分区详情，当前仅支持maxcompute和hms（EMR集群）类型。
血缘关系	血缘关系
ListLineageRelationships	查询数据地图血缘关系列表	查询数据地图给定两实体（表、字段、oss文件等）之间的血缘关系信息列表。
GetLineageRelationship	获取数据地图血缘关系	获取数据地图中给定的血缘关系详情信息。
DeleteLineageRelationship	删除数据地图血缘关系	删除给定的数据地图血缘关系。
CreateLineageRelationship	注册数据地图血缘关系	注册数据地图的血缘关系，要求其中一方为自定义实体。
ListLineages	查询数据地图实体血缘列表	查询数据地图中给定实体的上下游血缘实体列表，是否包含具体的血缘关系信息可选。
元数据集合	元数据集合
ListMetaCollections	查询数据地图集合列表	查询数据地图集合列表，支持查询数据地图类目以及数据专辑两种类型。
CreateMetaCollection	创建数据地图集合对象	创建数据地图集合对象，支持创建数据地图类目（包括多级子类目）、数据专辑（专辑子类目）两种类型的集合对象。
GetMetaCollection	获取数据地图集合信息	获取数据地图给定集合的详细信息，支持查询数据地图类目和数据专辑两种类型。
UpdateMetaCollection	更新数据地图集合对象	更新数据地图集合对象，包括数据地图类目和数据专辑，支持更新集合名称，描述和管理员信息。更新数据专辑时，要求调用者具有AliyunDataWorksFullAccess 权限，或者为专辑的创建者或管理员。
DeleteMetaCollection	删除数据地图集合对象	删除给定数据地图中的集合对象，包括数据地图类目和数据专辑。删除数据专辑时，要求调用者具有AliyunDataWorksFullAccess 权限，或者为专辑的创建者或管理员。
ListEntitiesInMetaCollection	查询数据地图集合中的实体列表	查询数据地图集合中的实体列表，集合支持数据地图类目和数据专辑，实体当前仅支持数据表类型。
AddEntityIntoMetaCollection	向数据地图集合中添加实体对象	向数据地图集合中添加给定实体对象，集合对象支持数据地图类目和数据专辑两种，实体对象当前仅支持数据表类型。向数据专辑添加实体时，要求调用者具有AliyunDataWorksFullAccess 权限，或者为专辑的创建者或管理员。
RemoveEntityFromMetaCollection	从数据地图集合中移除实体对象	从数据地图集合中移除实体对象，集合支持数据地图类目和数据专辑，实体当前仅支持数据表类型。从数据专辑移除实体时，要求调用者具有AliyunDataWorksFullAccess 权限，或者为专辑的创建者或管理员。

运维中心

API	标题	API概述
监控告警	监控告警
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	获取工作流列表	分页获取工作流列表，也可以通过条件进行筛选查询。
工作流实例	工作流实例
GetRerunWorkflowInstancesResult	获取重跑工作流实例结果	查询异步重跑工作流实例的结果
RerunWorkflowInstances	重跑工作流实例	重跑工作流实例
CreateWorkflowInstances	创建工作流实例	根据配置创建工作流实例，如补数据工作流实例。
GetCreateWorkflowInstancesResult	获取创建工作流实例结果	查询异步创建工作流实例的结果。
GetWorkflowInstance	获取工作流实例的详情	获取指定的工作流实例的详细信息。
ListWorkflowInstances	获取工作流实例列表	分页获取工作流实例列表，也可以通过条件进行筛选查询。
StartWorkflowInstances	启动工作流实例	批量启动多个工作流实例。
StopWorkflowInstances	终止工作流实例	批量终止多个工作流实例。
ExecuteAdhocWorkflowInstance	执行临时工作流实例	根据配置创建一个临时工作流实例。

标签管理

API	标题	API概述
CreateDataAssetTag	创建标签	创建标签。
DeleteDataAssetTag	删除标签	删除标签。
UpdateDataAssetTag	更新标签	更新标签。
ListDataAssetTags	查询标签列表	查询标签列表。
TagDataAssets	绑定数据资产标签	为资产绑定标签。
UnTagDataAssets	解绑数据资产标签	为数据资产解绑标签关系。
ListDataAssets	查询已关联标签的资产列表	分页查询已关联标签的DataWorks数据资产。

开放平台

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