阿里云OpenAPI开发者门户

大数据开发治理平台 DataWorks - OpenAPI 概览2024-05-18
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
认证文件管理
OpenAPI 名称描述操作
ImportCertificate导入认证文件查看文档去调试
GetCertificate查看认证文件查看文档去调试
ListCertificates查询认证文件列表查看文档去调试
DeleteCertificate删除认证文件查看文档去调试
空间管理
OpenAPI 名称描述操作
工作空间
CreateProjecthot创建工作空间查看文档去调试
GetProject该接口用于查询一个DataWorks工作空间的详细信息查看文档去调试
ListProjectshot该接口用于查询用户所在租户下的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 名称描述操作
节点
CreateNodehot调用该接口,会在新版数据开发中创建一个数据开发节点查看文档去调试
GetNodehot获取指定的数据开发节点详细信息查看文档去调试
ListNodeshot分页获取数据开发节点列表,也可以通过筛选条件对列表进行筛选查询查看文档去调试
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 名称描述操作
同步任务
CreateDIJobhot创建数据集成新版任务查看文档去调试
GetDIJobLog获取数据集成任务日志查看文档去调试
ListDIJobs查询数据集成新版任务列表,包括整库同步实时任务,整库同步离线任务,单表同步实时任务等数据集成任务查看文档去调试
ListDIJobRunDetails获取数据集成运行信息查看文档去调试
ListDIJobMetrics获取数据集成任务指标查看文档去调试
ListDIJobEvents获取数据集成任务事件查看文档去调试
UpdateDIJob更新数据集成任务查看文档去调试
StopDIJob中止数据集成任务查看文档去调试
StartDIJob启动数据集成新版任务查看文档去调试
GetDIJob查看数据集成任务查看文档去调试
DeleteDIJob删除数据集成新版任务查看文档去调试
任务告警
CreateDIAlarmRule创建数据集成报警规则查看文档去调试
ListDIAlarmRules查看数据集成报警规则查看文档去调试
UpdateDIAlarmRule更新数据集成报警规则查看文档去调试
DeleteDIAlarmRule删除数据集成报警规则查看文档去调试
运维中心
OpenAPI 名称描述操作
监控告警
ListAlertRules分页获取自定义监控告警规则查看文档去调试
GetAlertRule获取自定义监控告警规则查看文档去调试
UpdateAlertRule更新自定义监控告警规则查看文档去调试
DeleteAlertRule删除自定义监控报警规则查看文档去调试
CreateAlertRule创建自定义监控告警规则查看文档去调试
任务
DeleteTask删除指定的任务查看文档去调试
UpdateTask以全量更新的方式,更新指定任务查看文档去调试
BatchUpdateTasks以增量更新的方式,批量更新多个任务查看文档去调试
GetTaskhot获取指定的任务的详细信息查看文档去调试
ListTaskshot分页获取任务列表,也可以通过条件进行筛选查询查看文档去调试
ListUpstreamTasks分页获取指定任务的上游任务列表查看文档去调试
ListDownstreamTasks分页获取指定任务的下游任务列表查看文档去调试
ListTaskOperationLogs分页获取指定任务的操作日志列表查看文档去调试
任务实例
UpdateTaskInstances批量修改多个任务实例的属性,包括优先级、调度资源组、数据源等查看文档去调试
GetTaskInstancehot获取指定的任务实例的详细信息查看文档去调试
GetTaskInstanceLog获取指定任务实例某一次运行的运行日志查看文档去调试
ListTaskInstanceshot分页获取任务实例列表,也可以通过条件进行筛选查询查看文档去调试
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查询质量规则模版列表查看文档去调试
标签管理
OpenAPI 名称描述操作
CreateDataAssetTag创建标签查看文档去调试
DeleteDataAssetTag删除标签查看文档去调试
UpdateDataAssetTag更新标签查看文档去调试
ListDataAssetTags查询标签列表查看文档去调试
TagDataAssets为资产绑定标签查看文档去调试
UnTagDataAssets为数据资产解绑标签关系查看文档去调试
ListDataAssets分页查询已关联标签的DataWorks数据资产查看文档去调试
开放平台
OpenAPI 名称描述操作
GetJobStatus返回异步任务的状态信息,调用异步化API后,通过轮训此API来获取成功状态查看文档去调试