本产品(
大数据开发治理平台 DataWorks/2020-05-18
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
租户
API | 标题 | API概述 |
---|---|---|
ListCalcEngines | 查看数据开发中绑定的数据源列表 | 该接口用于查询指定DataWorks工作空间的数据开发中绑定的数据源列表。 |
CreateDataSource | 创建数据源 | 该接口用于创建DataWorks数据源。 |
ListDataSources | 查询数据源列表 | 该接口用于查询DataWorks的数据源列表。 |
UpdateDataSource | 更新数据源 | 该接口用于更新数据源。 |
DeleteDataSource | 删除数据源 | 该接口用于删除数据源。 |
ListResourceGroups | 查看资源组列表 | 该接口用于查看指定类型的资源组列表。 |
GetProject | 查询工作空间详细信息 | 该接口用于查询一个DataWorks工作空间的详细信息。 |
AddProjectMemberToRole | 添加工作空间用户至角色 | 该接口用于添加DataWorks工作空间用户至角色。使用该接口前,您需要先添加目标账号为DataWorks工作空间的成员。 |
CreateProjectMember | 添加一个用户至工作空间 | 该接口用于添加一个用户至DataWorks工作空间。 |
DeleteProjectMember | 从DataWorks工作空间移除用户 | 该接口用于从DataWorks工作空间移除用户。 |
ListProjectRoles | 获取工作空间所有角色的列表 | 该接口用于获取工作空间所有角色的列表。 |
RemoveProjectMemberFromRole | 将工作空间内用户从角色中移除 | 该接口用于将DataWorks工作空间内的用户从DataWorks角色中移除。 |
ListProjectMembers | 查询工作空间成员列表 | 该接口用于查询DataWorks工作空间中已存在成员的列表。 |
ListProjects | 查询工作空间列表 | 该接口用于查询用户所在租户下的DataWorks工作空间列表。 |
ListProjectIds | 查询指定账号下DataWorks工作空间ID列表 | 该接口用于查询指定阿里云账号(包括阿里云主账号或RAM用户)在目标地域下拥有角色权限的DataWorks工作空间的ID列表。 |
CreateProject | 创建DataWorks工作空间 | 该接口用于创建一个DataWorks工作空间。 |
ChangeResourceManagerResourceGroup | 修改资源归属资源组 | 该接口用于修改资源归属资源组。 |
ListMeasureData | 查询计量数据 | 该接口用于查询用户所在租户下最近30天电话告警、短信告警计量数据。 |
元数据
API | 标题 | API概述 |
---|---|---|
ListTables | 获取表列表 | 分页获取租户下面的数据源类型粒度的表名称。 |
GetMetaDBInfo | 获取引擎实例的基本元数据信息 | 该接口用于获取引擎实例的基本元数据信息。 |
GetMetaDBTableList | 获取引擎实例下的表 | 该接口用于获取引擎实例中的表。 |
CheckMetaTable | 检查表是否存在 | 该接口用于检查表是否存在。 |
CheckMetaPartition | 检查分区是否存在 | 该接口用于检查分区是否存在。 |
SearchMetaTables | 根据条件搜索表 | 该接口用于根据条件搜索表。 |
GetMetaTableBasicInfo | 获取表的基础信息 | 该接口用于获取表的基础信息。 |
GetMetaTableColumn | 获取表的字段信息 | 该接口用于获取表的字段信息。 |
GetMetaTablePartition | 获取表的分区列表 | 该接口用于获取表的分区列表。 |
GetMetaTableOutput | 获取表的产出信息 | 该接口用于获取表的产出信息。 |
GetMetaTableChangeLog | 获取表的变更日志 | 该接口用于获取表的变更日志。 |
GetMetaTableIntroWiki | 获取表的使用说明 | 该接口用于获取表的使用说明。 |
CreateMetaCategory | 创建类目 | 该接口用于创建类目。 |
DeleteMetaCategory | 删除类目 | 该接口用于删除类目。 |
UpdateMetaCategory | 更新类目 | 该接口用于更新类目。 |
GetMetaCategory | 查询类目树 | 该接口用于查询类目树。 |
GetMetaTableListByCategory | 查询指定类目下的表 | 该接口用于查询指定类目下的表。 |
AddToMetaCategory | 添加表至指定的类目 | 该接口用于添加表至指定的类目。 |
DeleteFromMetaCategory | 从指定的类目中移除表 | 该接口用于从指定的类目中移除表。 |
UpdateMetaTable | 更新表的Meta信息 | 该接口用于更新表的Meta信息。 |
UpdateMetaTableIntroWiki | 更新表的说明信息 | 该接口用于更新表的说明信息,当数据不存在时增加信息。 |
ListMetaDB | 查询数据库列表 | 该接口用于查询数据库列表。 |
UpdateTableModelInfo | 修改表模型信息 | 修改表的主题、层级和物理分类等信息。 |
CreateTableTheme | 创建主题 | 调用CreateTableTheme创建主题。不建议使用该API,后续将有新API上线覆盖此功能。 |
DeleteTableTheme | 删除主题 | 调用DeleteTableTheme删除主题。不建议使用该API,后续将有新API上线覆盖此功能。 |
UpdateTableTheme | 更新主题 | 调用UpdateTableTheme更新主题。不建议使用该API,后续将有新API上线覆盖此功能。 |
ListTableTheme | 查询主题列表 | 调用ListTableTheme查询主题列表。不建议使用该API,后续将有新API上线覆盖此功能。 |
GetMetaTableThemeLevel | 获取表的主题和层级信息 | 获取表的主题和层级信息。 |
CreateTableLevel | 创建层级 | 调用CreateTableLevel创建层级。不建议使用该API,后续将有新API上线覆盖此功能。 |
UpdateTableLevel | 更新层级 | 调用UpdateTableLevel更新层级。不建议使用该API,后续将有新API上线覆盖此功能。 |
DeleteTableLevel | 删除层级 | 调用DeleteTableLevel删除层级。不建议使用该API,后续将有新API上线覆盖此功能。 |
ListTableLevel | 查询层级列表 | 调用ListTableLevel查询层级列表。不建议使用该API,后续将有新API上线覆盖此功能。 |
UpdateMetaCollection | 更新集合对象 | 该接口用于更新集合对象的名称和注释。 |
ListMetaCollections | 查询集合信息 | 查询集合信息。 集合的概念包括数据地图页面上的专辑、专辑中的子类目等。 通过本接口可以指定集合类型查询集合信息。 |
ListMetaCollectionEntities | 查询集合中的实体 | 该接口用于查询集合中的实体。 |
DeleteMetaCollection | 删除集合 | 删除集合。 |
GetMetaCollectionDetail | 查询集合详情信息 | 该接口用于查询集合的详细信息。 |
DeleteMetaCollectionEntity | 删除集合中的实体 | 该接口用于删除集合中的实体。 |
AddMetaCollectionEntity | 添加实体到集合中 | 该接口用于添加实体到集合中。 |
CreateMetaCollection | 创建集合对象 | 创建集合对象。 |
ListLineage | 查询实体血缘 | 查询实体的上下游血缘关系。 |
DeleteLineageRelation | 删除血缘关系 | 删除实体间血缘关系。 仅限于删除用户注册的自定义血缘关系。 |
RegisterLineageRelation | 注册血缘关系 | 注册实体关系,支持用户注册自定义的实体关系。 |
数据开发
API | 标题 | API概述 |
---|---|---|
CreateFile | 在数据开发中创建一个文件 | 调用CreateFile,在数据开发中创建一个文件。目前不支持调用该接口创建数据集成节点任务。 |
CreateUdfFile | 在数据开发中创建函数类型文件 | 调用CreateUdfFile,在数据开发中创建函数类型文件。 |
CreateBusiness | 创建业务流程 | 调用CreateBusiness,创建数据开发(DataStudio)的业务流程。 |
DeleteBusiness | 删除业务流程 | 调用DeleteBusiness删除业务流程。 |
CreateFolder | 创建文件夹 | 调用CreateFolder创建文件夹。 |
UpdateBusiness | 更新业务流程 | 调用UpdateBusiness更新业务流程。 |
ListFiles | 查询文件列表 | 调用ListFiles查询文件列表。 |
EstablishRelationTableToBusiness | 导入表至业务流程 | 相当于在数据开发页面右键单击业务流程,选择导入表的操作。 |
SubmitFile | 提交文件至调度系统开发环境 | 提交文件至调度系统的开发环境,生成对应的任务。 |
ListBusiness | 查询业务流程的列表 | 调用ListBusiness查询业务流程的列表。 |
GetFileVersion | 获取文件的版本详情 | 调用GetFileVersion获取文件的版本详情。 |
DeleteFolder | 删除数据开发页面的文件夹 | 调用DeleteFolder删除数据开发页面的文件夹。 |
DeleteFile | 删除数据开发中的文件 | 调用DeleteFile删除数据开发中的文件。如果文件已经提交过,那么DeleteFile API会同时触发一个异步在调度系统删除的流程,需要用DeleteFile API返回的DeploymentId继续调用GetDeployment轮询被触发的异步删除流程的状态。 |
GetDeployment | 获取发布包的详情 | 调用GetDeployment获取发布包的详情。 |
UpdateFile | 更新已有的文件节点 | 调用UpdateFile更新已创建的文件。 |
GetFolder | 获取文件夹的详情 | 调用GetFolder获取文件夹的详情。 |
ListFileVersions | 查询文件的版本列表 | 调用ListFileVersions查询文件的版本列表。 |
GetFile | 获取文件的详情 | 该接口用于获取文件的详情。 |
ListFolders | 查询文件夹的列表 | 调用ListFolders查询文件夹的列表。 |
DeployFile | 部署文件 | 发布文件至生产环境。 |
UpdateUdfFile | 更新函数的文件信息 | 调用UpdateUdfFile更新函数的文件信息。 |
GetBusiness | 查询业务流程的详情 | 调用GetBusiness查询业务流程的详情。 |
UpdateFolder | 更新文件夹的信息 | 调用UpdateFolder更新文件夹的信息。 |
ListDeployments | 查询发布包列表信息 | 查询发布包列表信息。该功能与DataWorks控制台任务发布页面的发布包列表功能对应。 |
UpdateIDEEventResult | 更新扩展点事件的检查结果 | 用于在数据开发过程中触发扩展点时,通过将扩展程序对扩展点事件的检查结果返回给数据开发系统。 |
GetIDEEventDetail | 查询触发扩展点事件时的数据快照 | 根据DataWorks开放消息的消息ID,查询触发扩展点事件时的扩展点数据快照。 |
CreateResourceFile | 创建资源文件 | 调用CreateResourceFile接口,在数据开发中创建或上传一个资源文件,此API功能与IDE界面中新建资源功能保持一致。 |
数据集成
API | 标题 | API概述 |
---|---|---|
CreateDISyncTask | 创建数据集成同步任务 | 调用CreateDISyncTask创建数据集成同步任务。 |
DeleteDISyncTask | 删除数据集成同步任务 | 调用DeleteDISyncTask接口,删除数据集成同步任务。当前仅支持使用该接口删除实时数据同步任务。 |
UpdateDISyncTask | 更新同步任务 | 更新数据集成同步任务。 |
TestNetworkConnection | 测试数据源网络连通性 | 测试目标数据源与所使用资源组的网络连通性。 |
GetDataSourceMeta | 获取目标数据源的Meta信息 | 调用GetDataSourceMeta获取目标数据源的Meta信息。 |
ListDIProjectConfig | 查看数据集成项目默认配置 | 查看当前工作空间中数据集成同步解决方案任务默认的全局配置。 |
UpdateDIProjectConfig | 修改同步解决方案任务的全局配置 | 修改当前工作空间中数据集成同步解决方案任务默认的全局配置。 |
GetDISyncTask | 查询数据同步任务 | 获取数据集成实时同步任务和同步解决方案的详情。 |
DeployDISyncTask | 部署发布同步任务 | 该接口用于发布实时同步任务。 |
GetDISyncInstanceInfo | 获取同步任务实例信息 | 获取实时同步任务和同步解决方案任务的运行状态。 |
TerminateDISyncInstance | 终止同步任务 | 下线数据集成实时同步任务。 |
GenerateDISyncTaskConfigForCreating | 异步生成同时任务的JSON | 异步生成同时任务的JSON。 |
GenerateDISyncTaskConfigForUpdating | 异步生成更新同步任务配置 | 异步生成更新同步任务的JSON。 |
StartDISyncInstance | 启动实时同步任务和解决方案同步任务 | 调用StartDISyncInstance接口,启动实时同步任务和解决方案同步任务。 |
StopDISyncInstance | 停止实时同步任务 | 调用StopDISyncInstance接口,停止实时同步任务。 |
QueryDISyncTaskConfigProcessResult | 查询异步任务结果 | 查询异步任务结果。 |
CreateDIJob | 创建数据集成新版任务 | 创建数据集成新版任务,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。 |
DeleteDIJob | 删除数据集成新版任务 | 删除数据集成新版任务,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。 |
GetDIJob | 查看数据集成新版任务 | 查看数据集成新版任务,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。 |
ListDIJobs | 查询数据集成新版任务列表 | 查询数据集成新版任务列表,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。 |
StartDIJob | 启动数据集成新版任务 | 启动数据集成新版任务,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。 |
StopDIJob | 停止数据集成新版任务 | 停止数据集成新版任务,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。 |
UpdateDIJob | 更新数据集成新版任务 | 更新数据集成新版任务,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。 |
CreateDIAlarmRule | 创建数据集成新版任务告警规则 | 创建数据集成新版任务告警规则,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。 |
DeleteDIAlarmRule | 删除数据集成新版任务告警规则 | 删除数据集成新版任务告警规则,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。 |
GetDIAlarmRule | 查询数据集成新版任务告警规则 | 查询数据集成新版任务告警规则,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。 |
ListDIAlarmRules | 查询数据集成新版任务告警规则列表 | 查询数据集成新版任务告警规则列表,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。 |
UpdateDIAlarmRule | 更新数据集成新版任务告警规则 | 更新数据集成新版任务告警规则,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。 |
数据建模
API | 标题 | API概述 |
---|---|---|
QueryPublicModelEngine | 查询数据建模引擎的信息 | 使用FML语句查询数据建模引擎的信息。 |
运维中心
API | 标题 | API概述 |
---|---|---|
GetAlertMessage | 查询报警信息 | 调用GetAlertMessage接口,通过获取的AlertId查询报警信息。 |
ListAlertMessages | 获取报警信息的列表 | 调用ListAlertMessages获取报警信息的列表。 |
GetBaselineConfig | 获取配置详情 | 调用GetBaselineConfig获取配置详情。 |
ListNodesByBaseline | 获取基线中的节点 | 获取基线中的节点(不包含这些节点的上游节点)。 |
ListBaselineConfigs | 获取基线列表 | 调用ListBaselineConfigs获取基线列表。 |
GetBaselineKeyPath | 获取基线实例的关键路径 | 调用GetBaselineKeyPath获取基线实例的关键路径。 |
GetBaselineStatus | 获取基线实例的详情 | 调用GetBaselineStatus获取基线实例的详情。 |
ListBaselineStatuses | 获取基线实例列表 | 调用ListBaselineStatuses获取基线实例列表。 |
DeleteRemind | 删除自定义监控报警规则 | 调用DeleteRemind删除自定义监控报警规则。 |
UpdateRemind | 更新自定义报警规则 | 调用UpdateRemind更新自定义监控规则。 |
CreateRemind | 创建自定义报警规则 | 调用CreateRemind创建自定义报警规则。 |
GetRemind | 获取自定义监控报警规则详情 | 调用GetRemind接口,获取自定义监控报警规则的详情。 |
ListReminds | 获取自定义监控规则列表 | 获取或搜索自定义监控规则列表。 |
ListTopics | 获取或搜索事件列表 | 调用ListTopics获取或搜索事件列表。 |
GetTopic | 获取事件的详情 | 调用GetTopic获取事件的详情。 |
GetTopicInfluence | 获取事件影响的基线实例列表 | 调用GetTopicInfluence获取事件影响的基线实例列表。 |
GetNode | 获取节点详情 | 获取节点的详情。 |
ListNodeInputOrOutput | 查询上下游节点信息 | 查询当前节点的上下游节点信息。该API只能查询上游或下游的一层节点信息。 |
ListNodes | 获取节点的列表 | 调用ListNodes获取节点的列表。 |
GetNodeCode | 获取节点的代码 | 调用GetNodeCode获取节点的代码。 |
GetInstance | 获取实例的详情 | 调用GetInstance接口,获取实例的详细信息。 |
ListInstances | 获取实例的列表 | 调用ListInstances获取实例的列表。 |
GetInstanceLog | 获取实例的日志 | 调用GetInstanceLog获取实例的日志。 |
StopInstance | 终止实例 | 调用StopInstance终止实例。 |
RestartInstance | 重启实例 | 调用RestartInstance重启实例。 |
SetSuccessInstance | 重置失败状态的实例为成功 | 调用SetSuccessInstance,重置失败状态的实例为成功。 |
SuspendInstance | 暂停实例 | 调用SuspendInstance暂停实例。 |
ResumeInstance | 恢复暂停状态的实例 | 调用ResumeInstance恢复暂停状态的实例。 |
RunCycleDagNodes | 创建补数据工作流 | 调用RunCycleDagNodes创建补数据工作流。 |
RunSmokeTest | 运行冒烟测试 | 创建冒烟测试工作流。 |
ListSuccessInstanceAmount | 获取运行成功的实例数量 | 获取业务日期当天生成的周期实例任务,在业务日期的不同整点时刻,运行成功的实例数量统计趋势。 |
ListInstanceAmount | 获取指定时间段周期实例数量趋势 | 获取指定时间段周期实例数量的趋势。 |
TopTenElapsedTimeInstance | 获取昨天耗时最长的任务排行 | 获取实例运行时长排行。 |
TopTenErrorTimesInstance | 获取近一个月节点的出错排行 | 获取近一个月节点的出错排行。 |
GetFileTypeStatistic | 获取节点任务类型分布情况 | 获取节点任务类型的分布情况。 |
GetInstanceStatusStatistic | 获取实例运行状态统计数据 | 用GetInstanceStatusCount获取实例任务不同运行状态的数量统计。 |
ListFileType | 查询任务节点类型 | 查询任务节点的类型信息,包括类型Code和类型名称。 |
RunManualDagNodes | 执行手动业务流程 | 手动业务流程必须已在环境界面提交发布,之后运维中心才会显示对应手动业务流程,您才可以使用该接口。 |
ListManualDagInstances | 获取手动执行的业务流程实例的信息 | 获取手动执行的业务流程实例的信息。 |
GetDag | 根据DagId获取Dag详情 | 支持查询手动业务流程、手动任务、补数据的Dag详情信息,不支持查询日常调度Dag详情。 |
ListDags | 获取单次补数据的所有Dag详情 | 根据OpSeq(补数据唯一标识)获取单次补数据的所有Dag详情。 |
ListNodesByOutput | 根据节点的输出结果精确查询目标节点 | 根据节点的输出结果精确查询目标节点。 |
RunTriggerNode | 运行一个触发式节点 | 调用RunTriggerNode运行一个触发式节点。 |
GetNodeParents | 获取节点上游列表 | 调用GetNodeParents获取节点上游列表。 |
GetNodeChildren | 获取节点下游列表 | 调用GetNodeChildren获取节点下游列表。 |
UpdateNodeRunMode | 冻结或解冻目标节点 | 调用UpdateNodeRunMode冻结或解冻目标节点。 |
UpdateNodeOwner | 修改目标节点负责人 | 修改目标节点的负责人。 |
UpdateWorkbenchEventResult | 更新扩展程序的处理结果 | 所属扩展程序的运维中心回调API,当运维中心的流程被扩展程序卡住后,调用UpdateWorkbenchEventResult返回扩展程序的处理结果。 |
ListShiftPersonnels | 获取值班表的值班人员列表 | 获取值班表的值班人员列表。 |
ListShiftSchedules | 获取运维中心值班表列表 | 获取运维中心值班表列表。 |
ListInstanceHistory | 获取所有实例历史记录 | 调用ListInstanceHistory,获取所有实例历史记录,任务重跑一次就会生成一条历史记录。 |
ListInnerNodes | 获取内部节点列表 | 调用ListInnerNodes获取内部节点详情,例如查询组合节点、循环节点等节点类型的内部节点,不支持PAI节点的内部节点查询。 |
OfflineNode | 下线节点 | 调用OfflineNode下线节点。 |
GetBaseline | 获取基线配置 | 根据基线ID获取基线配置。 |
DeleteBaseline | 删除基线配置 | 根据基线ID删除基线配置,只有基线上游没有任何节点的情况下才允许删除。可通过调用UpdateBaseline接口修改基线上游节点。 |
ListBaselines | 获取基线列表 | 该接口用于获取基线列表。 |
CreateBaseline | 创建基线 | 该接口用于创建基线。 |
UpdateBaseline | 修改基线配置 |
数据质量
API | 标题 | API概述 |
---|---|---|
UpdateQualityFollower | 更新订阅关系 | 调用UpdateQualityFollower更新订阅关系。 |
UpdateQualityRule | 更新规则 | 调用UpdateQualityRule更新校验规则的信息。 |
GetQualityRule | 获取规则的信息 | 调用GetQualityRule获取校验规则的信息。 |
ListQualityRules | 根据分区表达式获取规则列表 | 调用ListQualityRules根据分区表达式获取校验规则列表。 |
CreateQualityRule | 创建质量监控规则 | 调用CreateQualityRule创建质量监控规则。 |
DeleteQualityFollower | 删除分区表达式的订阅人 | 调用DeleteQualityFollower删除分区表达式的订阅人。 |
DeleteQualityRule | 删除规则 | 调用DeleteQualityRule删除规则。 |
GetQualityFollower | 获取分区表达式的订阅人 | 调用GetQualityFollower获取分区表达式的订阅人。 |
CreateQualityFollower | 创建分区表达式的订阅人 | 调用CreateQualityFollower创建分区表达式的订阅人。 |
DeleteQualityEntity | 删除分区表达式 | 调用DeleteQualityEntity删除分区表达式。 |
GetQualityEntity | 获取分区表达式 | 调用GetQualityEntity获取分区表达式。 |
CreateQualityEntity | 创建数据质量的分区表达式 | 调用CreateQualityEntity创建数据质量的分区表达式。 |
CreateQualityRelativeNode | 创建分区表达式关联 | 调用CreateQualityRelativeNode创建分区表达式关联。 |
DeleteQualityRelativeNode | 删除调度关联 | 调用DeleteQualityRelativeNode删除调度关联。 |
ListQualityResultsByEntity | 根据分区表达式查询校验历史结果 | 调用ListQualityResultsByEntity,根据分区表达式查询历史校验结果。 |
ListQualityResultsByRule | 校验数据源质量 | 根据校验规则校验数据源的质量,并查询校验结果。 |
数据服务
API | 标题 | API概述 |
---|---|---|
CreateDataServiceApi | 创建数据服务API | 调用CreateDataServiceApi创建数据服务API。 |
PublishDataServiceApi | 发布数据服务API | 调用PublishDataServiceApi发布数据服务API。 |
DeleteDataServiceApi | 删除数据服务API | 调用DeleteDataServiceApi删除数据服务API。 |
ListDataServiceApis | 获取数据服务API开发中的信息列表 | 调用ListDataServiceApis获取数据服务API开发中的信息列表。 |
GetDataServiceApi | 查询数据服务API开发态的详情 | 调用GetDataServiceApi查询数据服务API开发态的详情。 |
UpdateDataServiceApi | 更新数据服务API开发态的信息 | 调用UpdateDataServiceApi更新数据服务API开发态的信息。 |
GetDataServicePublishedApi | 查询数据服务API的发布态信息 | 调用GetDataServicePublishedApi查询数据服务API的发布态信息。 |
ListDataServicePublishedApis | 获取数据服务API的发布态信息列表 | 调用ListDataServicePublishedApis获取数据服务API的发布态信息列表。 |
ListDataServiceApiAuthorities | 获取授权给他人的API列表 | 调用ListDataServiceApiAuthorities获取授权给他人的API列表。 |
ListDataServiceAuthorizedApis | 获取获得授权的API信息列表 | 调用ListDataServiceAuthorizedApis获取获得授权的API信息列表。 |
AbolishDataServiceApi | 下线数据服务API | 调用AbolishDataServiceApi下线数据服务API。 |
GetDataServiceApplication | 查询数据服务App的详情 | 调用GetDataServiceApplication查询数据服务App的详情。 |
ListDataServiceApplications | 获取数据服务应用的基础信息列表 | 调用ListDataServiceApplications获取数据服务应用的基础信息列表。 |
CreateDataServiceFolder | 创建数据服务文件夹 | 调用CreateDataServiceFolder创建数据服务文件夹。 |
GetDataServiceFolder | 查询数据服务文件夹 | 调用GetDataServiceFolder查询数据服务文件夹。 |
ListDataServiceFolders | 查询数据服务文件夹列表 | 调用ListDataServiceFolders查询数据服务文件夹列表。 |
CreateDataServiceGroup | 创建数据服务业务流程 | 调用CreateDataServiceGroup创建数据服务业务流程。 |
GetDataServiceGroup | 查询数据服务业务流程 | 调用GetDataServiceGroup查询数据服务业务流程。 |
ListDataServiceGroups | 查询数据服务业务流程列表 | 调用ListDataServiceGroups查询数据服务业务流程列表。 |
CreateDataServiceApiAuthority | 新增数据服务API授权 | 调用CreateDataServiceApiAuthority新增数据服务API授权。 |
DeleteDataServiceApiAuthority | 取消数据服务API授权 | 调用DeleteDataServiceApiAuthority取消数据服务API授权。 |
ListDataServiceApiTest | 列出数据服务API测试记录 | 列出数据服务API测试记录,只能查询最近一个月数据。 |
TestDataServiceApi | 测试数据服务API | 测试API,异步测试,需要GetDataServiceApiTest接口获取测试结果。 |
GetDataServiceApiTest | 获取API测试结果 | 获取API测试结果。 |
SubmitDataServiceApi | 提交数据服务API | SubmitDataServiceApi用于提交数据服务API。 |
SaveDataServiceApiTestResult | 保存API测试结果 | 该接口用于保存API测试的结果。 |
数据分析
API | 标题 | API概述 |
---|---|---|
UmountDirectory | 从数据分析左侧导航目录中移除内容 | 该接口用于将指定内容从数据分析左侧导航目录中移除。 |
MountDirectory | 数据分析左侧导航目录挂载内容 | 该接口用于将指定内容挂载到数据分析左侧导航目录。 |
数据保护伞
API | 标题 | API概述 |
---|---|---|
GetOpSensitiveData | 获取敏感数据访问记录 | 获取租户下所有DataWorks工作空间指定日期的敏感数据访问记录。 |
DesensitizeData | 数据脱敏 | 输入待脱敏数据,返回脱敏后的结果数据。 |
GetOpRiskData | 获取有风险的敏感数据访问记录 | 获取租户下所有DataWorks工作空间指定日期中有风险的敏感数据访问记录。 |
GetSensitiveData | 获取敏感数据 | 调用GetSensitiveData,获取租户下所有DataWorks工作空间的最新敏感数据识别结果。 |
ScanSensitiveData | 扫描敏感数据 | 调用ScanSensitiveData识别输入数据中是否存在敏感数据。 |
DsgQuerySensResult | 获取敏感数据识别结果 | 该接口用于获取数据保护伞的敏感数据识别结果。 |
QueryDefaultTemplate | 查询默认分类分级模板 | 调用QueryDefaultTemplate接口查询数据保护伞定义的默认分类分级模板。 |
DsgStopSensIdentify | 停止分类分级敏感数据识别任务 | 调用DsgStopSensIdentify接口,停止数据保护伞定义的分类分级敏感数据识别任务。 |
QuerySensClassification | 查询分类分级中的分类节点 | 调用QuerySensClassification接口,查询数据保护伞分类分级中的分类节点。 |
QuerySensLevel | 查询敏感数据等级 | 调用QuerySensLevel接口,查询在数据保护伞定义的敏感数据等级。 |
QueryRecognizeRulesType | 查询敏感字段内置识别规则类型 | 调用QueryRecognizeRulesType接口,查询数据保护伞定义的敏感字段内置识别规则类型。 |
DsgRunSensIdentify | 启动敏感数据识别任务 | 调用DsgRunSensIdentify接口启动一个数据保护伞的敏感数据识别任务。 |
DeleteRecognizeRule | 删除分类分级规则 | 调用DeleteRecognizeRule接口,删除在数据保护伞定义的分类分级规则。 |
QuerySensNodeInfo | 查询分类分级识别规则 | 调用QuerySensNodeInfo接口查询数据保护伞的分类分级识别规则。 |
AddRecognizeRule | 新增分类分级定义的敏感字段 | 调用AddRecognizeRule接口新增数据保护伞分类分级定义的敏感字段。 |
EditRecognizeRule | 编辑分类分级定义的敏感字段 | 调用EditRecognizeRule接口编辑数据保护伞分类分级定义的敏感字段。 |
QueryRecognizeDataByRuleType | 获取敏感字段识别方式列表 | 调用QueryRecognizeDataByRuleType接口获取数据保护伞的敏感字段识别方式列表。 |
QueryRecognizeRuleDetail | 查询指定敏感字段详情 | 调用QueryRecognizeRuleDetail接口查询数据保护伞的指定敏感字段详情。 |
DsgUserGroupGetOdpsRoleGroups | 查询可选择的MaxCompute角色列表 | 调用DsgUserGroupGetOdpsRoleGroups接口,查询该租户在数据保护伞创建或修改用户组时,用户组成员可选择的MaxCompute角色列表。 |
DsgDesensPlanAddOrUpdate | 新建或编辑数据脱敏规则 | 调用DsgDesensPlanAddOrUpdate接口新建或编辑数据脱敏规则。 |
DsgPlatformQueryProjectsAndSchemaFromMeta | 查询当前租户下的引擎实例列表 | 调用DsgPlatformQueryProjectsAndSchemaFromMeta接口,查询当前租户下不同类型的引擎实例列表。 |
DsgUserGroupDelete | 删除数据保护伞配置的用户组 | 调用DsgUserGroupDelete接口,删除数据保护伞配置的用户组。 |
DsgWhiteListDeleteList | 删除脱敏白名单 | 调用DsgWhiteListDeleteList接口,删除数据保护伞中配置的脱敏白名单。 |
DsgScenedDeleteScene | 删除二级脱敏场景 | 调用DsgScenedDeleteScene接口,删除数据保护伞中已创建的二级脱敏场景。 |
DsgDesensPlanDelete | 删除脱敏规则 | 调用DsgDesensPlanDelete接口,删除数据保护伞中已创建的脱敏规则。 |
DsgDesensPlanUpdateStatus | 修改脱敏规则的生效状态 | 调用DsgDesensPlanUpdateStatus接口,修改脱敏规则的生效状态。 |
DsgWhiteListQueryList | 查询脱敏白名单 | 调用DsgWhiteListQueryList接口,查询数据保护伞中配置的脱敏白名单。 |
DsgSceneAddOrUpdateScene | 新增或编辑二级脱敏场景 | 调用DsgSceneAddOrUpdateScene接口,新增或编辑二级脱敏场景。 |
DsgSceneQuerySceneListByName | 获取脱敏场景列表 | 调用DsgSceneQuerySceneListByName接口,获取脱敏场景列表。 |
DsgUserGroupAddOrUpdate | 新增或编辑数据保护伞中的用户组 | 调用DsgUserGroupAddOrUpdate接口,新增或编辑数据保护伞中的用户组。 |
DsgUserGroupQueryList | 查询数据保护伞的用户组列表 | 调用DsgUserGroupQueryList接口,查询数据保护伞的用户组列表。 |
DsgUserGroupQueryUserList | 查询当前租户下的用户或角色列表 | 调用DsgUserGroupQueryUserList接口,查询当前租户下的用户或角色列表。 |
DsgDesensPlanQueryList | 脱敏规则列表 | 调用DsgDesensPlanQueryList接口,查询数据保护伞的脱敏规则列表。 |
DsgWhiteListAddOrUpdate | 新增或编辑脱敏白名单 | 调用DsgWhiteListAddOrUpdate接口,新增或编辑脱敏白名单。 |
DsgQueryDefaultTemplates | 查询可选择的敏感类型模版列表及详情 | 调用DsgQueryDefaultTemplates接口,查询可选择的敏感类型模版列表及该模版支持的脱敏规则。您可参考该接口的返回参数配置脱敏规则。 |
迁移助手
API | 标题 | API概述 |
---|---|---|
CreateImportMigration | 创建导入迁移 | 调用CreateImportMigration创建导入任务,导入任务包含数据源信息、任务、表等对象的DataWorks导入导出包。 |
GetMigrationProcess | 获取迁移过程 | 调用GetMigrationProcess获取导入导出任务的进度状态。 |
StartMigration | 开始迁移 | 调用StartMigration启动执行导入导出任务。 |
CreateExportMigration | 创建导出任务 | 使用CreateExportMigration,新建DataWorks导出任务且仅创建导出任务。 |
GetMigrationSummary | 获取导入导出任务的信息 | 调用GetMigrationSummary,获取导入导出任务的信息。 |
ListMigrations | 获取迁移任务列表 | 获取导入导出迁移任务列表。 |
安全中心
API | 标题 | API概述 |
---|---|---|
CreatePermissionApplyOrder | 创建权限申请单 | 创建一个权限申请单。 |
GetPermissionApplyOrderDetail | 查询权限申请单的详细信息 | 查询一个权限申请单的详细信息。 |
ListPermissionApplyOrders | 查询权限申请单列表 | 查询权限申请单列表。 |
ApprovePermissionApplyOrder | 审批权限申请单 | 审批一个权限申请单。 |
RevokeColumnPermission | 撤销用户的字段权限 | 撤销用户的字段权限。 |
RevokeTablePermission | 撤销用户的表权限 | 撤销用户的表权限。 |
RevokeTablePermission | 撤销用户的表权限 | 撤销用户的表权限。 |
开放平台
API | 标题 | API概述 |
---|---|---|
ListExtensions | 获取扩展程序列表 | 拉取开放平台的扩展程序列表。 |
GetExtension | 获取扩展程序详情 | 获取某个扩展程序详情。 |
GetOptionValueForProject | 获取扩展程序选项配置在项目空间下的配置 | 获取扩展程序选项配置在项目空间下的配置。 |
ListEnabledExtensionsForProject | 获取已经开启的扩展程序列表 | 调用ListEnabledExtensionsForProject来获取项目空间下已经开启的扩展程序列表,包含系统扩展程序和自定义扩展程序。 |
CallbackExtension | 返回扩展程序对扩展点事件的检查结果 | 用于在DataWorks平台使用过程中触发扩展点时,通过调用CallbackExtension接口,将扩展程序对扩展点事件的检查结果返回给DataWorks平台。 |
其他
API | 标题 | API概述 |
---|---|---|
UpdateClusterConfigs | 更新集群的配置信息 | 更新集群在某个工作空间下分模块的配置信息,目前支持更新 SPARK 参数。 |
ListClusterConfigs | 列出集群的配置信息 | 列出集群在某个工作空间下分模块的配置信息,目前支持列出 SPARK 参数。 |
ListClusters | 列出集群信息 | 列出注册到 DataWorks 的集群信息,目前支持 EMR 集群、CDH 集群。 |
废弃API
API | 标题 | API概述 |
---|---|---|
ListEntitiesByTags | 根据标签列出实体 | 根据标签列出实体,目前只支持 maxcompute-table 类型的实体。 |
RemoveEntityTags | 移除实体的标签 | 移除实体的标签,目前只支持 maxcompute-table 类型的实体。 |
SetEntityTags | 设置实体的标签 | 设置实体的标签,目前只支持 maxcompute-table 类型的实体。 |
ListEntityTags | 列出实体的标签 | 列出实体的标签,目前只支持 maxcompute-table 类型的实体。 |