文档

API概览

更新时间:
本产品(大数据开发治理平台 DataWorks/2020-05-18)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用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概述
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注册血缘关系注册实体关系,支持用户注册自定义的实体关系。
ListEntityTags列出实体的标签列出实体的标签,目前只支持 maxcompute-table 类型的实体。
SetEntityTags设置实体的标签设置实体的标签,目前只支持 maxcompute-table 类型的实体。
RemoveEntityTags移除实体的标签移除实体的标签,目前只支持 maxcompute-table 类型的实体。
ListEntitiesByTags根据标签列出实体根据标签列出实体,目前只支持 maxcompute-table 类型的实体。

数据开发

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提交数据服务APISubmitDataServiceApi用于提交数据服务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平台。