本文为您介绍DataWorks OpenAPI的可用范围、计费方式和调用限制。

可用范围

  • 可用版本:DataWorks企业版和旗舰版。
  • 可用地域:华东1(杭州)、华东2(上海)、华南1(深圳)、华北2(北京)、华北3(张家口)、北京政务云、华东2(上海)金融云、西南1(成都)、中国(香港)、亚太东南1(新加坡)、印度尼西亚(雅加达)和美国(硅谷) 。

计费方式

OpenAPI采用版本结合按量计费的商业化方式,计费标准如下。
分类 企业版 旗舰版
免费额度 100万次/月 1000万次/月
按量计费调用次数 0.3元/万次

每个自然月会附赠每个主账号(包含子账号)在每个地域的OpenAPI调用免费额度。免费额度用尽后,根据0.3元/万次的价格进行收费。

调用限制

为规范DataWorks OpenAPI的调用,保障系统稳定性,将OpenAPI分为1级、2级和3级,详情请参见OpenAPI列表。不同级别OpenAPI的调用限制如下。
OpenAPI级别 调用限制
1级 QPS<=50
2级 QPS<=20
3级 QPS<=5,且每日的总调用次数<=10000次
注释的说明如下:
  • ①:每个主账号及其子账号在每个地域中,针对当前级别的OpenAPI的总QPS。
  • ②:每个主账号及其子账号在每个地域中,针对3级OpenAPI的每日总调用次数。

OpenAPI列表

DataWorks OpenAPI包括租户、元数据、数据开发、数据集成、运维中心、数据质量和数据服务。如果您在数据开发过程中需要使用DataWorks OpenAPI,使用方式请参见数据开发API调用示例
  • 租户
    API名称 API描述 API级别
    ListCalcEngines 调用ListCalcEngines查看计算引擎列表。 3级
    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级
  • 元数据
    API名称 API描述 API级别
    GetMetaDBInfo 调用GetMetaDBInfo获取引擎实例的基本元数据信息。 1级
    GetMetaDBTableList 调用GetMetaDBTableList获取引擎实例下的表。 1级
    CheckMetaTable 调用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级
    GetMetaTableLineage 调用GetMetaTableLineage获取表的血缘关系。 1级
    GetMetaColumnLineage 调用GetMetaColumnLineage获取字段的血缘关系。 3级
    CreateMetaCategory 调用CreateMetaCategory创建类目。 2级
    DeleteMetaCategory 调用DeleteMetaCategory删除类目。 2级
    UpdateMetaCategory 调用UpdateMetaCategory更新类目。 2级
    GetMetaCategory 调用GetMetaCategory查询类目树。 1级
    GetMetaTableListByCategory 调用GetMetaTableListByCategory查询指定类目下的表。 1级
    AddToMetaCategory 调用AddToMetaCategory添加表至指定的类目。 2级
    DeleteFromMetaCategory 调用DeleteFromMetaCategory从指定的类目中移除表。 2级
    CreateTable 调用CreateTable创建一个MaxCompute表。 2级
    UpdateTable 调用UpdateTable更新MaxCompute表。 2级
    DeleteTable 调用DeleteTable删除MaxCompute表。 2级
    GetDDLJobStatus 调用GetDDLJobStatus获取创建表、更新表和删除表的任务状态。 1级
    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级
  • 数据开发
    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级
  • 数据集成
    API名称 API描述 API级别
    CreateDISyncTask 调用CreateDISyncTask创建数据集成同步任务。 3级
    UpdateDISyncTask 调用UpdateDISyncTask更新数据集成同步任务。 3级
    ListRefDISyncTasks 调用ListRefDISyncTasks接口,查看目标数据源所关联的数据集成同步任务。 3级
    ImportDataSources 调用ImportDataSources批量导入本地数据源至目标DataWorks工作空间。 3级
    ExportDataSources 调用ExportDataSources批量导出指定条件的目标数据源至本地。 3级
    TestNetworkConnection 调用TestNetworkConnection接口,测试目标数据源与所使用资源组的网络连通性。 3级
    SetDataSourceShare 调用SetDataSourceShare分享目标数据源至指定DataWorks工作空间或指定用户。分享后,该工作空间的所有成员或指定的用户可以查看和使用目标数据源。 3级
    GetDataSourceMeta 调用GetDataSourceMeta获取目标数据源的Meta信息。 3级
    ListDIProjectConfig 调用ListDIProjectConfig查看当前工作空间中数据集成同步解决方案任务默认的全局配置。 3级
    UpdateDIProjectConfig 调用UpdateDIProjectConfig修改当前工作空间中数据集成同步解决方案任务默认的全局配置。 3级
  • 运维中心
    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级
    ListNodesByOutput 调用ListNodesByOutput根据节点的输出结果精确查询目标节点。 1级
    RunTriggerNode 调用RunTriggerNode运行一个触发式节点。 2级
    GetNodeParents 调用GetNodeParents获取节点上游列表。 2级
    GetNodeChildren 调用GetNodeChildren获取节点下游列表。 2级
    UpdateNodeRunMode 调用UpdateNodeRunMode冻结或解冻目标节点。 2级
    UpdateNodeOwner 调用UpdateNodeOwner修改目标节点的负责人。 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级
  • 数据保护伞
    API名称 API描述 API级别
    GetOpSensitiveData 调用GetOpSensitiveData,获取租户下所有DataWorks工作空间指定日期的敏感数据访问记录。 1级
    DesensitizeData 调用DesensitizeData输入待脱敏数据,返回脱敏后的结果数据。 1级
    GetOpRiskData 调用GetOpRiskData,获取租户下所有DataWorks工作空间指定日期中有风险的敏感数据访问记录。 1级
    GetSensitiveData 调用GetSensitiveData,获取租户下所有DataWorks工作空间的最新敏感数据识别结果。 1级
    ScanSensitiveData 调用ScanSensitiveData识别输入数据中是否存在敏感数据。 1级
  • 迁移助手
    API名称 API描述 API级别
    CreateImportMigration 调用CreateImportMigration创建导入任务,导入任务包含数据源信息、任务、表等对象的DataWorks导入导出包。 2级
    GetMigrationProcess 调用GetMigrationProcess获取导入导出任务的进度状态。 1级
    StartMigration 调用StartMigration启动执行导入导出任务。 2级
  • 安全中心
    API名称 API描述 API级别
    CreatePermissionApplyOrder 调用CreatePermissionApplyOrder创建一个权限申请单。 2级
    GetPermissionApplyOrderDetail 调用GetPermissionApplyOrderDetail查询一个权限申请单的详细信息。 2级
    ListPermissionApplyOrders 调用ListPermissionApplyOrders查询权限申请单列表。 3级
    ApprovePermissionApplyOrder 调用ApprovePermissionApplyOrder审批一个权限申请单。 2级
    RevokeTablePermission 调用RevokeTablePermission,撤销用户的表权限。 2级

如果调用API时产生报错,您可以在对应API文档查看错误码的描述信息,也可以进入错误中心查看错误码详情。