文档

DataWorks OpenAPI概述

更新时间:

DataWorks为您提供了涵盖租户、元数据、数据开发、运维中心、数据集成等多个功能模块的OpenAPI接口,不同API的QPS限制、每日调用次数上限和支持使用的DataWorks服务版本存在差异。您可参考本文了解各OpenAPI支持的DataWorks版本及地域、计费方式和调用限制。

版本与地域要求

  • 版本要求:

    DataWorks为您提供不同功能模块的OpenAPI,如租户、元数据、数据开发、运维中心等功能模块。各功能模块的OpenAPI对DataWorks的版本要求与功能本身对DataWorks版本的要求一致。

    • 各版本的OpenAPI有相应的调用限制,详情请参见调用限制

    • 各版本的OpenAPI分别提供相应的每月免费调用额度,超过之后则需按量付费,可免费调用的额度及后续按量计费的详情请参见免费额度与计费方式

    • 各个OpenAPI对应的版本,请参见OpenAPI列表

  • 可用地域:

    华东1(杭州)、华东2(上海)、华南1(深圳)、华北2(北京)、华北3(张家口)、北京政务云、华东2(上海)金融云、西南1(成都)、中国(香港)、亚太东南1(新加坡)、印度尼西亚(雅加达)、美国(硅谷)、美国(弗吉尼亚)、德国(法兰克福)、英国(伦敦)、日本(东京)、澳大利亚(悉尼)关停中、马来西亚(吉隆坡) 。

调用限制

为规范DataWorks OpenAPI的调用,保障系统稳定性,将OpenAPI分为1级、2级和3级,详情请参见OpenAPI列表。不同版本和不同分级的OpenAPI分别有相应的QPS限制和每日调用次数限制,具体如下。

说明

查看OpenAPI免费额度、调用次数、调用明细等详情请参见查看OpenAPI使用情况

版本

QPS限制

每日调用次数上限

基础版

1级、2级、3级API总QPS≤5

每日API总调用次数≤100次

标准版

每日API总调用次数≤1000次

专业版

每日API总调用次数≤10000次

企业版

  • 1级API QPS≤50

  • 2级API QPS≤20

  • 3级API QPS≤5

  • 1级、2级API 每日API总调用次数不限

  • 3级API 每日API总调用次数≤10000次

重要
  • API QPS和调用次数的统计口径:每个主账号及其子账号在每个地域的累计值。

  • 当超过QPS或每日调用次数限制后,将会出现调用失败,请合理控制调用并发和次数。

  • API调用成功和调用失败的次数都会计入每日调用限制次数中。

免费额度与计费方式

OpenAPI采用版本结合按量计费的商业化方式,计费标准如下。

版本

免费调用额度

超出免费调用额度后按量计费

基础版

3100次/月

有调用限制,不支持额外按量付费。

标准版

31000次/月

专业版

310000次/月

企业版

1000000次/月

0.3元/万次

重要
  • 每个自然月会给与每个主账号(包含子账号)在每个地域的OpenAPI一定的免费调用额度,不同版本的DataWorks每月可用的免费额度不一样。

  • 受不同版本DataWorks日调用次数限制(详情见调用限制),基础版、标准版、专业版的每月实际可调用量可能无法超过免费调用额度,且不支持按量付费。

  • DataWorks企业版免费额度用尽后,支持根据按量计费的价格进行收费,公共云的计费如上所示,政务云环境下超出后的计费为0.6元/万次,金融云环境下超出后的计费为0.57元/万次,实际计费价格以最终账单显示的价格为准。

  • 只有当API调用成功后,才会消耗免费调用额度并且在超过免费调用额度后按量计费,API调用失败的话不会消耗免费调用额度且不计量计费。

OpenAPI列表

DataWorks OpenAPI包括租户、元数据、数据开发、数据集成、数据建模、运维中心、数据质量、数据服务、数据保护伞、迁移助手及安全中心。

租户

API名称

API描述

API级别

最低版本要求

(本版本及以上版本支持)

ListCalcEngines

调用ListCalcEngines查看计算引擎列表。

2级

基础版

CreateDataSource

调用CreateDataSource接口,创建DataWorks数据源。

2级

ListDataSources

调用ListDataSources接口,查询DataWorks数据源列表。

3级

UpdateDataSource

调用UpdateDataSource接口,更新数据源。

2级

DeleteDataSource

调用DeleteDataSource接口,删除一个数据源。

2级

ListResourceGroups

调用ListResourceGroups查看资源组列表。

1级

GetProject

调用GetProject查询一个DataWorks工作空间的信息。

1级

AddProjectMemberToRole

调用AddProjectMemberToRole,添加DataWorks工作空间用户至角色。用户需要先添加至DataWorks工作空间内。

2级

CreateProjectMember

调用CreateProjectMember,添加一个用户至DataWorks工作空间。

2级

DeleteProjectMember

调用DeleteProjectMember,从DataWorks工作空间移除用户。

2级

ListProjectRoles

调用ListProjectRoles获取工作空间所有角色的列表。

1级

RemoveProjectMemberFromRole

调用RemoveProjectMemberFromRole,将DataWorks工作空间内的用户从DataWorks角色中移除。

2级

ListProjectMembers

调用ListProjectMembers查询DataWorks工作空间中已存在成员的列表。

1级

ListProjects

调用ListProjects,分页列出用户所在租户下的DataWorks工作空间列表。

1级

ListProjectIds

调用ListProjectIds,使用目标阿里云账号(包括阿里云主账号或RAM用户)的ID获取其拥有角色权限的DataWorks工作空间的ID列表。

1级

DeleteProject

调用DeleteProject接口,删除DataWorks工作空间。

3级

CreateProject

调用CreateProject接口,创建 DataWorks 工作空间。

3级

UpdateProject

调用UpdateProject接口,更新DataWorks工作空间。

3级

ChangeResourceManagerResourceGroup

调用ChangeResourceManagerResourceGroup接口,修改资源归属资源组。

3级

元数据

API名称

API描述

API级别

最低版本要求

(本版本及以上版本支持)

GetMetaDBInfo

调用GetMetaDBInfo获取引擎实例的基本元数据信息。

1级

基础版

GetMetaDBTableList

调用GetMetaDBTableList获取引擎实例下的表。

1级

基础版

检查表是否存在

调用CheckMetaTable检查表是否存在。

1级

基础版

CheckMetaPartition

调用CheckMetaPartition检查分区是否存在。

1级

基础版

SearchMetaTables

调用SearchMetaTables根据条件搜索表。

1级

基础版

GetMetaTableBasicInfo

调用GetMetaTableBasicInfo获取表的基础信息。

1级

基础版

GetMetaTableColumn

调用GetMetaTableColumn获取表的字段信息。

1级

基础版

GetMetaTablePartition

调用GetMetaTablePartition获取表的分区列表。

1级

基础版

GetMetaTableOutput

调用GetMetaTableOutput获取表的产出信息。

1级

基础版

GetMetaTableChangeLog

调用GetMetaTableChangeLog获取表的变更日志。

1级

基础版

GetMetaTableIntroWiki

调用GetMetaTableIntroWiki获取表的使用说明。

1级

基础版

CreateMetaCategory

调用CreateMetaCategory创建类目。

2级

基础版

DeleteMetaCategory

调用DeleteMetaCategory删除类目。

2级

基础版

UpdateMetaCategory

调用UpdateMetaCategory更新类目。

2级

基础版

GetMetaCategory

调用GetMetaCategory查询类目树。

1级

基础版

GetMetaTableListByCategory

调用GetMetaTableListByCategory查询指定类目下的表。

1级

基础版

AddToMetaCategory

调用AddToMetaCategory添加表至指定的类目。

2级

基础版

DeleteFromMetaCategory

调用DeleteFromMetaCategory从指定的类目中移除表。

2级

基础版

UpdateMetaTable

调用UpdateMetaTable更新表的Meta信息。

2级

企业版

UpdateMetaTableIntroWiki

调用UpdateMetaTableIntroWiki更新表的说明信息,当数据不存在时增加信息。

2级

基础版

ListMetaDB

调用ListMetaDB查询数据库列表。

1级

基础版

UpdateTableModelInfo

调用UpdateTableModelInfo修改表的主题、层级和物理分类等信息。

2级

企业版

CreateTableTheme

调用CreateTableTheme创建主题。

2级

基础版

DeleteTableTheme

调用DeleteTableTheme删除主题。

2级

基础版

UpdateTableTheme

调用UpdateTableTheme更新主题。

2级

基础版

ListTableTheme

调用ListTableTheme查询主题列表。

1级

基础版

CreateTableLevel

调用CreateTableLevel创建层级。

2级

基础版

DeleteTableLevel

调用DeleteTableLevel删除层级。

2级

基础版

UpdateTableLevel

调用UpdateTableLevel更新层级。

2级

基础版

ListTableLevel

调用ListTableLevel查询层级列表。

1级

基础版

GetMetaTableThemeLevel

调用GetMetaTableThemeLevel获取表的主题和层级关系。

1级

专业版

UpdateMetaCollection

调用UpdateMetaCollection更新集合对象。

2级

专业版

ListMetaCollections

调用ListMetaCollections查询集合信息。

2级

专业版

ListMetaCollectionEntities

调用ListMetaCollectionEntities查询集合中的实体。

2级

专业版

DeleteMetaCollection

调用DeleteMetaCollection删除集合。

2级

专业版

GetMetaCollectionDetail

调用GetMetaCollectionDetail查询集合详情信息。

2级

专业版

DeleteMetaCollectionEntity

调用DeleteMetaCollectionEntity删除集合中的实体。

2级

专业版

AddMetaCollectionEntity

调用AddMetaCollectionEntity添加实体到集合中。

2级

专业版

CreateMetaCollection

调用CreateMetaCollection创建集合对象。

2级

专业版

GetMetaTableProducingTasks

调用GetMetaTableProducingTasks查询表的产出任务列表。

1级

专业版

ListLineage

调用ListLineage查询实体的上下游血缘关系。

2级

image.png

DeleteLineageRelation

调用DeleteLineageRelation删除实体间血缘关系。

2级

image.png

RegisterLineageRelation

调用RegisterLineageRelation将自有实体间的血缘关系注册到DataWorks 平台上,与已有血缘关系相结合形成全链路血缘。

2级

image.png

ListEntityTags

调用ListEntityTags列出实体的标签,目前只支持 maxcompute-table 类型的实体。

2级

image.png

SetEntityTags

调用SetEntityTags设置实体的标签,目前只支持 maxcompute-table 类型的实体。

2级

image.png

RemoveEntityTags

调用RemoveEntityTags 移除实体的标签,目前只支持 maxcompute-table 类型的实体。

2级

image.png

ListEntitiesByTags

调用ListEntitiesByTags根据标签列出实体,目前只支持 maxcompute-table 类型的实体。

2级

image.png

数据开发

API名称

API描述

API级别

最低版本要求

(本版本及以上版本支持)

CreateFile

调用CreateFile,在数据开发中创建一个文件。

3级

基础版

CreateUdfFile

调用CreateUdfFile,在数据开发中创建函数类型文件。

2级

基础版

CreateBusiness

调用CreateBusiness创建业务流程。

2级

基础版

DeleteBusiness

调用DeleteBusiness删除业务流程。

3级

基础版

CreateFolder

调用CreateFolder创建文件夹。

2级

基础版

UpdateBusiness

调用UpdateBusiness更新业务流程。

2级

基础版

ListFiles

调用ListFiles查询文件列表。

1级

基础版

EstablishRelationTableToBusiness

调用EstablishRelationTableToBusiness,导入表至业务流程。相当于在数据开发页面右键单击业务流程,选择导入表的操作。

2级

基础版

SubmitFile

调用SubmitFile,提交文件至调度系统的开发环境,生成对应的任务。

3级

基础版

ListBusiness

调用ListBusiness查询业务流程的列表。

1级

基础版

GetFileVersion

调用GetFileVersion获取文件的版本详情。

1级

基础版

DeleteFolder

调用DeleteFolder删除数据开发页面的文件夹。

3级

基础版

DeleteFile

调用DeleteFile删除数据开发中的文件。

3级

基础版

GetDeployment

调用GetDeployment获取发布包的详情。

1级

基础版

UpdateFile

调用UpdateFile更新文件。

2级

基础版

GetFolder

调用GetFolder获取文件夹的详情。

1级

基础版

ListFileVersions

调用ListFileVersions查询文件的版本列表。

1级

基础版

GetFile

调用GetFile获取文件的详情。

1级

基础版

ListFolders

调用ListFolders查询文件夹的列表。

1级

基础版

DeployFile

调用DeployFile部署文件,发布文件至生产环境。

3级

基础版

UpdateUdfFile

调用UpdateUdfFile更新函数的文件信息。

2级

基础版

GetBusiness

调用GetBusiness查询业务流程的详情。

1级

基础版

UpdateFolder

调用UpdateFolder更新文件夹的信息。

2级

基础版

ListDeployments

调用ListDeployments,查询发布包列表信息。该功能与DataWorks控制台任务发布页面的发布包列表功能对应。

1级

基础版

UpdateIDEEventResult

用于在数据开发过程中触发扩展点时,通过调用UpdateIDEEventResult接口,将扩展程序对扩展点事件的检查结果返回给DataWorks的数据开发系统。

2级

企业版

GetIDEEventDetail

调用GetIDEEventDetail,根据DataWorks开放消息的消息ID,查询触发扩展点事件时的扩展点数据快照。

1级

企业版

CreateResourceFile

调用CreateResourceFile,在数据开发中创建或上传一个资源文件,此API功能与IDE界面中新建资源功能保持一致。

3级

image.png

数据集成

API名称

API描述

API级别

最低版本要求

(本版本及以上版本支持)

CreateDISyncTask

调用CreateDISyncTask创建数据集成同步任务。

3级

基础版

DeleteDISyncTask

调用DeleteDISyncTask接口,删除数据集成同步任务。当前仅支持使用该接口删除实时数据同步任务。

3级

基础版

UpdateDISyncTask

调用UpdateDISyncTask更新数据集成同步任务。

3级

基础版

TestNetworkConnection

调用TestNetworkConnection接口,测试目标数据源与所使用资源组的网络连通性。

3级

基础版

GetDataSourceMeta

调用GetDataSourceMeta获取目标数据源的Meta信息。

3级

基础版

ListDIProjectConfig

调用ListDIProjectConfig查看当前工作空间中数据集成同步解决方案任务默认的全局配置。

3级

基础版

UpdateDIProjectConfig

调用UpdateDIProjectConfig修改当前工作空间中数据集成同步解决方案任务默认的全局配置。

3级

基础版

GetDISyncTask

调用GetDISyncTask获取数据集成实时同步任务和同步解决方案的详情。

3级

基础版

DeployDISyncTask

调用DeployDISyncTask发布实时同步任务和同步解决方案任务。

3级

基础版

GetDISyncInstanceInfo

调用GetDISyncInstanceInfo获取实时同步任务和同步解决方案任务的运行状态。

3级

基础版

StartDISyncInstance

调用StartDISyncInstance接口,启动实时同步任务和解决方案同步任务。

3级

基础版

StopDISyncInstance

调用StopDISyncInstance接口,停止实时同步任务。

3级

基础版

TerminateDISyncInstance

调用TerminateDISyncInstance下线数据集成实时同步任务。

3级

基础版

GenerateDISyncTaskConfigForCreating

调用GenerateDISyncTaskConfigForCreating接口,异步生成创建数据集成同步任务的异步线程ID。

3级

基础版

GenerateDISyncTaskConfigForUpdating

调用GenerateDISyncTaskConfigForUpdating接口,异步生成更新数据集成同步任务的异步线程ID。

3级

基础版

QueryDISyncTaskConfigProcessResult

调用QueryDISyncTaskConfigProcessResult接口,通过异步线程ID,获取异步生成或更新数据集成同步任务需要的参数。

3级

基础版

CreateDIJob

调用CreateDIJob创建数据集成新版任务。

3级

基础版

DeleteDIJob

调用DeleteDIJob删除数据集成新版任务。

3级

基础版

GetDIJob

调用GetDIJob查看数据集成新版任务。

3级

基础版

ListDIJobs

调用ListDIJobs查询数据集成新版任务列表。

3级

基础版

StartDIJob

调用StartDIJob启动数据集成新版任务。

3级

基础版

StopDIJob

调用StopDIJob停止数据集成新版任务。

3级

基础版

UpdateDIJob

调用UpdateDIJob更新数据集成新版任务。

3级

基础版

CreateDIAlarmRule

调用CreateDIAlarmRule创建数据集成新版任务告警规则。

3级

基础版

GetDIAlarmRule

调用GetDIAlarmRule查询数据集成新版任务告警规则。

3级

基础版

ListDIAlarmRules

调用 ListDIAlarmRules查询数据集成新版任务告警规则列表。

3级

基础版

UpdateDIAlarmRule

调用UpdateDIAlarmRule更新数据集成新版任务告警规则。

3级

基础版

数据集成使用API创建数据集成任务,详情请参见通过OpenAPI创建、修改、删除离线同步任务

数据建模

API名称

API描述

API级别

最低版本要求

(本版本及以上版本支持)

QueryPublicModelEngine

调用QueryPublicModelEngine,使用FML语句查询数据建模引擎的信息。

1级

基础版

运维中心

API名称

API描述

API级别

最低版本要求

(本版本及以上版本支持)

ListAlertMessages

调用ListAlertMessages获取报警信息的列表。

1级

专业版

GetBaselineConfig

调用GetBaselineConfig获取配置详情。

1级

专业版

ListNodesByBaseline

调用ListNodesByBaseline获取基线中的节点。

1级

标准版

ListBaselineConfigs

调用ListBaselineConfigs获取基线列表。

1级

标准版

GetBaselineKeyPath

调用GetBaselineKeyPath获取基线实例的关键路径。

1级

标准版

GetBaselineStatus

调用GetBaselineStatus获取基线实例的详情。

1级

标准版

ListBaselineStatuses

调用ListBaselineStatuses获取基线实例列表。

1级

标准版

DeleteRemind

调用DeleteRemind删除自定义监控报警规则。

2级

基础版

UpdateRemind

调用UpdateRemind更新自定义报警规则。

3级

基础版

CreateRemind

调用CreateRemind创建自定义报警规则。

3级

基础版

GetRemind

调用GetRemind获取自定义监控报警规则的详情。

1级

基础版

ListReminds

调用ListReminds获取或搜索自定义监控规则列表。

1级

基础版

ListTopics

调用ListTopics获取或搜索事件列表。

1级

标准版

GetTopic

调用GetTopic获取事件的详情。

1级

标准版

GetTopicInfluence

调用GetTopicInfluence获取事件影响的基线实例列表。

1级

标准版

GetNode

调用GetNode获取节点的详情。

1级

基础版

ListNodeInputOrOutput

调用ListNodeInputOrOutput查询当前节点的上下游节点信息。该API只能查询上游或下游的一层节点信息。

1级

基础版

ListNodes

调用ListNodes获取节点的列表。

1级

基础版

GetNodeCode

调用GetNodeCode获取节点的代码。

1级

基础版

GetInstance

调用GetInstance获取实例的详情。

1级

基础版

ListInstances

调用ListInstances获取实例的列表。

1级

基础版

GetInstanceLog

调用GetInstanceLog获取实例的日志。

1级

基础版

StopInstance

调用StopInstance终止实例。

2级

基础版

RestartInstance

调用RestartInstance重启实例。

2级

基础版

SetSuccessInstance

调用SetSuccessInstance,重置失败状态的实例为成功。

2级

基础版

SuspendInstance

调用SuspendInstance暂停实例。

2级

基础版

ResumeInstance

调用ResumeInstance恢复暂停状态的实例。

2级

基础版

RunCycleDagNodes

调用RunCycleDagNodes创建补数据工作流。

2级

基础版

RunSmokeTest

调用RunSmokeTest创建冒烟测试工作流。

2级

基础版

ListSuccessInstanceAmount

调用ListSuccessInstanceAmount,获取业务日期当天生成的周期实例任务,在业务日期的不同整点时刻,运行成功的实例数量统计趋势。

3级

基础版

ListInstanceAmount

调用ListInstanceAmount获取指定时间段周期实例数量的趋势。

1级

基础版

TopTenElapsedTimeInstance

调用TopTenElapsedTimeInstance获取实例运行时长排行。

1级

基础版

TopTenErrorTimesInstance

调用TopTenErrorTimesInstance获取近一个月节点的出错排行。

1级

基础版

GetFileTypeStatistic

调用GetFileTypeStatistic获取节点任务类型的分布情况。

1级

基础版

GetInstanceStatusStatistic

调用GetInstanceStatusCount获取实例任务不同运行状态的数量统计。

1级

基础版

ListFileType

调用ListFileType查询任务节点的类型信息,包括类型Code和类型名称。

1级

基础版

RunManualDagNodes

调用RunManualDagNodes触发手动业务流程执行。手动业务流程必须已经在界面提交发布,运维中心能够找到对应的手动业务流程,才能使用该接口。

2级

基础版

ListManualDagInstances

调用ListManualDagInstances获取手动执行的业务流程实例的信息。

1级

基础版

GetDag

调用GetDag,根据DagId获取Dag详情。

1级

基础版

ListDags

根据OpSeq获取单次补数据的所有Dag详情。

1级

基础版

ListNodesByOutput

调用ListNodesByOutput根据节点的输出结果精确查询目标节点。

1级

基础版

RunTriggerNode

调用RunTriggerNode运行一个触发式节点。

2级

基础版

GetNodeParents

调用GetNodeParents获取节点上游列表。

2级

基础版

GetNodeChildren

调用GetNodeChildren获取节点下游列表。

2级

基础版

UpdateNodeRunMode

调用UpdateNodeRunMode冻结或解冻目标节点。

2级

基础版

UpdateNodeOwner

调用UpdateNodeOwner修改目标节点的负责人。

2级

基础版

UpdateWorkbenchEventResult

所属扩展程序的运维中心回调API,当运维中心的流程被扩展程序卡住后,调用UpdateWorkbenchEventResult返回扩展程序的处理结果。

2级

基础版

ListShiftPersonnels

调用ListShiftPersonnels获取值班表的值班人员列表。

1级

基础版

ListShiftSchedules

调用ListShiftSchedules获取运维中心值班表列表。

1级

基础版

ListInstanceHistory

调用ListInstanceHistory,获取所有实例历史记录,任务重跑一次就会生成一条历史记录。

1级

基础版

ListInnerNodes

调用ListInnerNodes获取内部节点详情,例如查询组合节点、循环节点等节点类型的内部节点,不支持PAI节点的内部节点查询。

1级

基础版

OfflineNode

调用OfflineNode下线节点。

3级

基础版

CreateBaseline

调用CreateBaseline创建基线。

3级

标准版

UpdateBaseline

调用UpdateBaseline修改基线配置。

3级

标准版

GetBaseline

调用GetBaseline根据基线ID获取基线配置。

1级

标准版

ListBaselines

调用ListBaselines获取基线配置列表。

1级

标准版

DeleteBaseline

调用DeleteBaseline根据基线ID删除基线配置。

2级

标准版

数据质量

API名称

API描述

API级别

最低版本要求

(本版本及以上版本支持)

UpdateQualityFollower

调用UpdateQualityFollower更新订阅关系。

2级

基础版

UpdateQualityRule

调用UpdateQualityRule更新规则。

2级

GetQualityRule

调用GetQualityRule获取规则的信息。

1级

ListQualityRules

调用ListQualityRules根据分区表达式获取规则列表。

3级

CreateQualityRule

调用CreateQualityRule创建质量监控规则。

3级

DeleteQualityFollower

调用DeleteQualityFollower删除分区表达式的订阅人。

2级

DeleteQualityRule

调用DeleteQualityRule删除规则。

2级

GetQualityFollower

调用GetQualityFollower获取分区表达式的订阅人。

1级

CreateQualityFollower

调用CreateQualityFollower创建分区表达式的订阅人。

3级

DeleteQualityEntity

调用DeleteQualityEntity删除分区表达式。

2级

GetQualityEntity

调用GetQualityEntity获取分区表达式。

1级

CreateQualityEntity

调用CreateQualityEntity创建数据质量的分区表达式。

2级

CreateQualityRelativeNode

调用CreateQualityRelativeNode创建分区表达式关联。

3级

DeleteQualityRelativeNode

调用DeleteQualityRelativeNode删除调度关联。

2级

ListQualityResultsByEntity

调用ListQualityResultsByEntity,根据分区表达式查询校验历史结果。

1级

ListQualityResultsByRule

调用ListQualityResultsByRule,根据规则查询校验结果。

1级

数据服务

API名称

API描述

API级别

最低版本要求

(本版本及以上版本支持)

CreateDataServiceApi

调用CreateDataServiceApi创建数据服务API。

3级

基础版

PublishDataServiceApi

调用PublishDataServiceApi发布数据服务API。

3级

DeleteDataServiceApi

调用DeleteDataServiceApi删除数据服务API。

3级

ListDataServiceApis

调用ListDataServiceApis获取数据服务API开发中的信息列表。

1级

GetDataServiceApi

调用GetDataServiceApi查询数据服务API开发态的详情。

1级

UpdateDataServiceApi

调用UpdateDataServiceApi更新数据服务API开发态的信息。

3级

GetDataServicePublishedApi

调用GetDataServicePublishedApi查询数据服务API的发布态信息。

1级

ListDataServicePublishedApis

调用ListDataServicePublishedApis获取数据服务API的发布态信息列表。

1级

ListDataServiceApiAuthorities

调用ListDataServiceApiAuthorities获取授权给他人的API列表。

1级

ListDataServiceAuthorizedApis

调用ListDataServiceAuthorizedApis获取获得授权的API信息列表。

1级

AbolishDataServiceApi

调用AbolishDataServiceApi下线数据服务API。

3级

GetDataServiceApplication

调用GetDataServiceApplication查询数据服务App的详情。

1级

ListDataServiceApplications

调用ListDataServiceApplications获取数据服务应用的基础信息列表。

1级

CreateDataServiceFolder

调用CreateDataServiceFolder创建数据服务文件夹。

2级

GetDataServiceFolder

调用GetDataServiceFolder查询数据服务文件夹。

1级

ListDataServiceFolders

调用ListDataServiceFolders查询数据服务文件夹列表。

1级

CreateDataServiceGroup

调用CreateDataServiceGroup创建数据服务业务流程。

2级

GetDataServiceGroup

调用GetDataServiceGroup查询数据服务业务流程。

1级

ListDataServiceGroups

调用ListDataServiceGroups查询数据服务业务流程列表。

1级

CreateDataServiceApiAuthority

调用CreateDataServiceApiAuthority新增数据服务API授权。

1级

DeleteDataServiceApiAuthority

调用DeleteDataServiceApiAuthority取消数据服务API授权。

1级

ListDataServiceApiTest

调用ListDataServiceApiTest列出数据服务API测试记录。

1级

TestDataServiceApi

调用TestDataServiceApi接口测试API。

1级

GetDataServiceApiTest

调用TestDataServiceApi接口获取测试结果。

1级

SubmitDataServiceApi

SubmitDataServiceApi用于提交数据服务API。

3级

SaveDataServiceApiTestResult

SaveDataServiceApiTestResult用于保存API测试的结果。

3级

数据分析

API名称

API描述

API级别

最低版本要求

(本版本及以上版本支持)

UmountDirectory

调用UmountDirectory将指定内容从数据分析左侧导航目录中移除。

2级

基础版

MountDirectory

调用MountDirectory将指定内容挂载到数据分析左侧导航目录。

2级

基础版

数据保护伞

API名称

API描述

API级别

最低版本要求

(本版本及以上版本支持)

GetOpSensitiveData

调用GetOpSensitiveData,获取租户下所有DataWorks工作空间指定日期的敏感数据访问记录。

1级

标准版

DesensitizeData

调用DesensitizeData输入待脱敏数据,返回脱敏后的结果数据。

1级

专业版

GetOpRiskData

调用GetOpRiskData,获取租户下所有DataWorks工作空间指定日期中有风险的敏感数据访问记录。

1级

标准版

GetSensitiveData

调用GetSensitiveData,获取租户下所有DataWorks工作空间的最新敏感数据识别结果。

1级

标准版

ScanSensitiveData

调用ScanSensitiveData识别输入数据中是否存在敏感数据。

1级

标准版

DsgQuerySensResult

调用DsgQuerySensResult接口,获取数据保护伞的敏感数据识别结果。

1级

专业版

QueryDefaultTemplate

调用QueryDefaultTemplate接口查询数据保护伞定义的默认分类分级模板。

1级

标准版

DsgStopSensIdentify

调用DsgStopSensIdentify接口,停止数据保护伞定义的敏感数据识别任务。

1级

标准版

QuerySensClassification

调用QuerySensClassification接口,查询数据保护伞分类分级中的分类节点。

1级

标准版

QuerySensLevel

调用QuerySensLevel接口,查询在数据保护伞定义的敏感数据等级。

1级

标准版

QueryRecognizeRulesType

调用QueryRecognizeRulesType接口,查询数据保护伞定义的敏感字段内置识别规则类型。

1级

标准版

DsgRunSensIdentify

调用DsgRunSensIdentify接口启动一个数据保护伞的敏感数据识别任务。

1级

标准版

DeleteRecognizeRule

调用DeleteRecognizeRule接口,删除在数据保护伞定义的分类分级规则。

1级

标准版

QuerySensNodeInfo

调用QuerySensNodeInfo接口查询数据保护伞的分类分级识别规则。

1级

标准版

AddRecognizeRule

调用AddRecognizeRule接口新增数据保护伞分类分级定义的敏感字段。

1级

标准版

EditRecognizeRule

调用EditRecognizeRule接口编辑数据保护伞分类分级定义的敏感字段。

1级

标准版

QueryRecognizeDataByRuleType

调用QueryRecognizeDataByRuleType接口获取数据保护伞的敏感字段识别方式列表。

1级

标准版

QueryRecognizeRuleDetail

调用QueryRecognizeRuleDetail接口查询数据保护伞的指定敏感字段详情。

1级

标准版

DsgUserGroupGetOdpsRoleGroups

调用DsgUserGroupGetOdpsRoleGroups接口,查询该租户在数据保护伞创建或修改用户组时,用户组成员可选择的MaxCompute角色列表。

1级

标准版

DsgDesensPlanAddOrUpdate

调用DsgDesensPlanAddOrUpdate接口新建或编辑数据脱敏规则。

1级

标准版

DsgPlatformQueryProjectsAndSchemaFromMeta

调用DsgPlatformQueryProjectsAndSchemaFromMeta接口,查询当前租户下不同类型的引擎实例列表。

1级

标准版

DsgUserGroupDelete

调用DsgUserGroupDelete接口,删除数据保护伞配置的用户组。

1级

标准版

DsgWhiteListDeleteList

调用DsgWhiteListDeleteList接口,删除数据保护伞中配置的脱敏白名单。

1级

标准版

DsgScenedDeleteScene

调用DsgScenedDeleteScene接口,删除数据保护伞中已创建的二级脱敏场景。

1级

标准版

DsgDesensPlanDelete

调用DsgDesensPlanDelete接口,删除数据保护伞中已创建的脱敏规则。

1级

标准版

DsgDesensPlanUpdateStatus

调用DsgDesensPlanUpdateStatus接口,修改脱敏规则的生效状态。

1级

标准版

DsgWhiteListQueryList

调用DsgWhiteListQueryList接口,查询数据保护伞中配置的脱敏白名单。

1级

标准版

DsgSceneAddOrUpdateScene

调用DsgSceneAddOrUpdateScene接口,新增或编辑二级脱敏场景。

1级

标准版

DsgSceneQuerySceneListByName

调用DsgSceneQuerySceneListByName接口,获取脱敏场景列表。

1级

标准版

DsgUserGroupAddOrUpdate

调用DsgUserGroupAddOrUpdate接口,新增或编辑数据保护伞中的用户组。

1级

标准版

DsgUserGroupQueryList

调用DsgUserGroupQueryList接口,查询数据保护伞的用户组列表。

1级

标准版

DsgUserGroupQueryUserList

调用DsgUserGroupQueryUserList接口,查询当前租户下的用户或角色列表。

1级

标准版

DsgDesensPlanQueryList

调用DsgDesensPlanQueryList接口,查询数据保护伞的脱敏规则列表。

1级

标准版

DsgWhiteListAddOrUpdate

调用DsgWhiteListAddOrUpdate接口,新增或编辑脱敏白名单。

1级

标准版

DsgQueryDefaultTemplates

调用DsgQueryDefaultTemplates接口,查询可选择的敏感类型模版列表及该模版支持的脱敏规则。您可参考该接口的返回参数配置脱敏规则。

1级

标准版

迁移助手

API名称

API描述

API级别

最低版本要求

(本版本及以上版本支持)

CreateImportMigration

调用CreateImportMigration创建导入任务,导入任务包含数据源信息、任务、表等对象的DataWorks导入导出包。

2级

基础版

GetMigrationProcess

调用GetMigrationProcess获取导入导出任务的进度状态。

1级

StartMigration

调用StartMigration启动执行导入导出任务。

2级

CreateExportMigration

调用CreateExportMigration,新建一个DataWorks的导出任务。该API仅创建导出任务,不会启动执行导出任务。

2级

GetMigrationSummary

调用GetMigrationSummary,获取导入导出任务的信息。

2级

ListMigrations

调用ListMigrations,获取导入导出任务的列表。

2级

安全中心

API名称

API描述

API级别

最低版本要求

(本版本及以上版本支持)

CreatePermissionApplyOrder

调用CreatePermissionApplyOrder创建一个权限申请单。

2级

基础版

GetPermissionApplyOrderDetail

调用GetPermissionApplyOrderDetail查询一个权限申请单的详细信息。

2级

ListPermissionApplyOrders

调用ListPermissionApplyOrders查询权限申请单列表。

3级

ApprovePermissionApplyOrder

调用ApprovePermissionApplyOrder审批一个权限申请单。

2级

RevokeColumnPermission

调用RevokeColumnPermission,撤销用户的表字段权限。

2级

RevokeTablePermission

调用RevokeTablePermission,撤销用户的表权限。

2级

开放平台

API名称

API描述

API级别

最低版本要求

ListExtensions

调用ListExtensions拉取开放平台的扩展程序列表。

1级

企业版

GetExtension

调用GetExtension获取某个扩展程序详情。

1级

GetOptionValueForProject

调用GetOptionValueForProject获取扩展程序选项配置在项目空间下的配置。

1级

ListEnabledExtensionsForProject

调用ListEnabledExtensionsForProject来获取项目空间下已经开启的扩展程序列表,包含系统扩展程序和自定义扩展程序。

1级

CallbackExtension

调用CallbackExtension用于在DataWorks平台使用过程中触发扩展点时,通过调用CallbackExtension接口,将扩展程序对扩展点事件的检查结果返回给DataWorks平台。

1级

相关参数获取方式

  • 查看个人信息(AccessKey、UID)

    1. 进入RAM访问控制。

    2. 身份管理 > 用户页面,单击目标用户,进入用户详情页查看用户的详细信息(例如,UID)。

    3. 用户详情页面的认证管理 > 用户AccessKey区域,获取个人AccessKey信息。

  • 查看当前工作空间所在地域(RegionId)

    您可通过工作空间数据开发(DataStudio)模块的URL获取工作空间所在地域。下图示例工作空间地域为华东2(上海)。

    说明

    进入数据开发模块的操作,请参见进入数据开发

    工作空间

  • 查看工作空间ID(ProjectId)

    工作空间ID为每个工作空间所拥有的唯一标识。您可通过如下步骤获取:

    1. 进入管理中心页面。

      登录DataWorks控制台,切换至目标地域后,单击左侧导航栏的管理中心,在下拉框中选择对应工作空间后单击进入管理中心

    2. 在左侧导航栏单击工作空间,在基础配置 > 基本属性区域获取工作空间ID

  • 查看租户ID(tenantId)

    每个阿里云主账号都拥有自己的租户ID,用来与其他阿里云主账号进行区分。同一阿里云主账号下各RAM用户(即子账号)均属于该租户,即同账号的主账号与子账号租户ID相同。租户ID可通过如下步骤获取:

    1. 进入数据开发。

    2. 在数据开发(DataStudio)页面,单击右上方当前登录用户名称,单击菜单 > 用户信息,获取租户ID

常见问题