本文为您介绍不同功能支持的API限流等级及Dataphin版本要求。
使用限制
RAM角色不支持调用OpenAPI。
为保障应用的稳定性，Dataphin将OpenAPI分为1级、2级和3级，不同版本的限流等级及API的调用额度，请参见不同Dataphin版本支持的调用额度。
权限说明
当拥有DataphinOpenAPIFullAccess系统权限，支持调用所有OpenAPI。
当拥有DataphinOpenAPIReadOnlyAccess系统权限，支持调用只读OpenAPI。
数据研发
分组 | OpenAPI名称 | API说明 | API限流等级 | 最低版本要求 |
目录树 | 创建菜单树目录，支持计算任务、数据集成、同步任务等功能。 | 2级 | 敏捷版 | |
删除菜单树文件目录。 | 3级 | 敏捷版 | ||
更新文件名。 | 2级 | 敏捷版 | ||
移动菜单树文件位置。 | 2级 | 敏捷版 | ||
获取文件夹目录树。 | 1级 | 敏捷版 | ||
查询目录树文件列表。 | 1级 | 敏捷版 | ||
数据架构 | 创建业务实体。 | 3级 | 智能版 | |
删除业务实体。 | 3级 | 智能版 | ||
查询业务实体的详情。 | 1级 | 智能版 | ||
查询指定版本业务实体详情。 | 1级 | 智能版 | ||
查询业务实例列表。 | 2级 | 智能版 | ||
下线业务实体。 | 2级 | 智能版 | ||
上线业务实体。 | 2级 | 智能版 | ||
更新业务实体。 | 2级 | 智能版 | ||
创建数据板块。 | 3级 | 智能版 | ||
创建主题域。 | 3级 | 智能版 | ||
删除数据板块。 | 3级 | 智能版 | ||
删除主题域。 | 3级 | 智能版 | ||
根据数据板块ID获取板块信息。 | 3级 | 智能版 | ||
查看主题域详情。 | 3级 | 智能版 | ||
查询当前租户下的所有数据板块。 | 2级 | 智能版 | ||
查询主题域列表。 | 3级 | 智能版 | ||
更新数据板块。 | 3级 | 智能版 | ||
更新主题域。 | 3级 | 智能版 | ||
即席查询 | 创建即席查询文件。 | 3级 | 敏捷版 | |
删除即席查询文件。 | 3级 | 敏捷版 | ||
修改即席查询文件。 | 2级 | 敏捷版 | ||
查询即席查询文件。 | 1级 | 敏捷版 | ||
终止即席查询任务。 | 2级 | 敏捷版 | ||
获取即席查询的任务运行结果。 | 2级 | 敏捷版 | ||
执行即席查询任务。 | 2级 | 敏捷版 | ||
获取即席查询任务运行日志。 | 1级 | 敏捷版 | ||
非结构化数据 | 使用JSON脚本模式创建非结构化工作流任务。 | 1级 | 基础版 | |
创建数据集。 | 1级 | 基础版 | ||
删除数据集。 | 1级 | 基础版 | ||
获取数据集。 | 3级 | 基础版 | ||
数据集列表查询。 | 3级 | 基础版 | ||
更新数据集信息。 | 1级 | 基础版 | ||
运行记录 | 分页查询运行记录。 | 2级 | 敏捷版 | |
获取运行记录运行代码。 | 2级 | 敏捷版 | ||
根据ID获取单条运行记录。 | 2级 | 敏捷版 | ||
获取运行记录详情，包括日志和结果。 | 1级 | 敏捷版 | ||
离线集成 | 创建集成管道/非结构化工作流任务。 | 3级 | 敏捷版 | |
异步创建集成管道/非机构化工作流任务。 | 3级 | 敏捷版 | ||
下线管道任务。 | 3级 | 敏捷版 | ||
异步下线管道任务。 | 3级 | 敏捷版 | ||
查询管道异步执行结果。 | 1级 | 敏捷版 | ||
根据管道ID查询管道任务。 | 1级 | 敏捷版 | ||
更新管道任务。 | 3级 | 敏捷版 | ||
异步更新集成管道任务。 | 3级 | 敏捷版 | ||
离线计算任务 | 查询运行记录运行代码。 | / | 敏捷版 | |
创建数据集成任务。 说明 从V5.3.1版本开始不建议使用，请使用CreatePipeline。 | 3级 | 基础版 | ||
创建离线计算任务。 | 3级 | 敏捷版 | ||
删除离线计算任务。 | 3级 | 敏捷版 | ||
查询离线计算任务详情。 | 1级 | 敏捷版 | ||
获取离线计算任务版本列表。 | 2级 | 敏捷版 | ||
查询离线计算任务的自定义血缘。 | 2级 | 敏捷版 | ||
查询指定版本离线计算任务详情。 | 2级 | 敏捷版 | ||
下线离线计算任务。 | 3级 | 敏捷版 | ||
解析离线计算任务的逻辑表依赖。 说明 解析结果上游依赖信息中可能包含自依赖节点（上游节点ID和解析代码的任务节点ID相同）需要用户自己进行处理。 | 3级 | 敏捷版 | ||
更新离线计算任务自定义血缘。 | 3级 | 敏捷版 | ||
提交离线计算任务。 | 3级 | 敏捷版 | ||
更新离线计算任务。 | 3级 | 敏捷版 | ||
离线计算任务模板 | 分页查询离线计算任务模板列表。 | 3级 | 敏捷版 | |
获取模板版本列表。 | 3级 | 敏捷版 | ||
实时研发任务 | 获取实时研发任务。 | 2级 | 基础版 | |
获取集群引擎的版本信息。 | 2级 | 基础版 | ||
获取环境集群队列信息。 | 2级 | 基础版 | ||
创建流批一体任务。 | 2级 | 基础版 | ||
资源 | 获取资源文件详情。 | 2级 | 敏捷版 | |
获取资源文件指定版本详情。 | 2级 | 敏捷版 | ||
编辑资源文件。 | 2级 | 敏捷版 | ||
获取文件存储临时读写授权。 | 2级 | 敏捷版 | ||
删除资源文件。 | 3级 | 敏捷版 | ||
创建资源文件。 | 3级 | 敏捷版 | ||
函数 | 获取自定义函数详情。 | 2级 | 敏捷版 | |
查询自定义函数指定版本详情。 | 2级 | 敏捷版 | ||
编辑自定义函数。 | 2级 | 敏捷版 | ||
删除自定义函数。 | 3级 | 敏捷版 | ||
创建自定义函数。 | 3级 | 敏捷版 | ||
发布 | 获取最新的待发布记录详情。 | 2级 | 基础版 | |
分页获取待发布记录列表。 | 2级 | 基础版 | ||
分页获取发布记录列表。 | 2级 | 基础版 | ||
批量发布对象。 | 2级 | 基础版 |
运维中心
分组 | OpenAPI名称 | API说明 | API限流等级 | 最低版本要求 |
实例运维 | 修复性数据重跑。支持强制重跑下游影响范围会产生计算成本，影响数据产出。 | 2级 | 敏捷版 | |
获取实例下游实例列表。 | 2级 | 敏捷版 | ||
查询实例的上下游。支持逻辑表和代码任务。 | 2级 | 敏捷版 | ||
批量运维实例，支持物理实例和逻辑表实例。 | 2级 | 敏捷版 | ||
列出补数据工作流下具体一个业务日期的所有节点的实例。 | 1级 | 敏捷版 | ||
获取实例信息。 | 1级 | 敏捷版 | ||
分页查询实例。 | 1级 | 敏捷版 | ||
任务运维 | 获取节点上下游。 | 2级 | 敏捷版 | |
运行手工任务。 说明
| 2级 | 敏捷版 | ||
获取补数据工作流提交状态。 | 1级 | 敏捷版 | ||
获取实例执行日志。 | 2级 | 敏捷版 | ||
查询物理调度节点。 | 1级 | 敏捷版 | ||
查询调度节点代码内容。 | 1级 | 敏捷版 | ||
查询节点的操作日志。 | 1级 | 敏捷版 | ||
获取补数据工作流Dagrun列表。 | 1级 | 敏捷版 | ||
查询节点下游，创建补数据工作流时可以作为数据参考。 | 2级 | 敏捷版 | ||
查询调度节点列表。 | 1级 | 敏捷版 | ||
暂停物理节点调度，接口调用成功后，会暂停任务的调度，下游任务将无法调起，暂时仅支持离线代码任务及集成任务。 | 2级 | 敏捷版 | ||
恢复物理节点调度。 | 2级 | 敏捷版 | ||
通用补数据接口，支持列表模式补数据和海量模式补数据。 说明
| 2级 | 敏捷版 | ||
查询开发态对象上游依赖。 | 2级 | 敏捷版 | ||
运行触发式节点。 | 敏捷版 | |||
根据输出名查询物理节点，仅支持离线代码节点及集成任务节点。 | 1级 | 敏捷版 | ||
告警信息 | 获取告警事件详情。 | 1级 | 敏捷版 | |
根据条件查询多个告警事件。 | 1级 | 敏捷版 | ||
根据条件查询多个推送记录。 | 1级 | 敏捷版 |
数据权限
分组 | OpenAPI名称 | API说明 | API限流等级 | 最低版本要求 |
权限管理 | 校验用户是否有操作指定资源的权限。 | 2级 | 敏捷版 | |
根据资源授权用户。 说明 该API仅支持超级管理员和资源所有者（项目管理员、数据源管理员）发起调用，目前支持表、数据源。 | 2级 | 敏捷版 | ||
回收用户资源权限。 说明 该API仅支持超级管理员和资源所有者（项目管理员、数据源管理员）发起调用，目前支持表、数据源。 | 2级 | 敏捷版 |
数据资产
分组 | OpenAPI名称 | API说明 | API限流等级 | 最低版本要求 |
资产 | 查询表血缘信息。 | 2级 | 敏捷版 | |
查询表字段血缘信息。 | 2级 | 敏捷版 | ||
新增注册血缘。 | 2级 | 敏捷版 | ||
删除注册血缘。 | 2级 | 敏捷版 | ||
新建业务指标。 | 3级 | 敏捷版 | ||
更新业务指标。 | 3级 | 敏捷版 | ||
删除业务指标。 | 3级 | 敏捷版 | ||
查询业务指标详情。 | 2级 | 敏捷版 | ||
查询资产目录列表（精准匹配+模糊搜索）。 | 2级 | 敏捷版 | ||
查询资产目录中资产详情信息。 | 2级 | 敏捷版 | ||
查询资产表血缘信息。 | / | 敏捷版 | ||
根据归属资产GUID查询映射关系。 | / | 敏捷版 | ||
根据资产对象GUID查询映射关系。 | / | 敏捷版 | ||
分页查询资产表元数据。 | / | 敏捷版 | ||
查询资产表字段血缘信息。 | / | 敏捷版 | ||
查询资产清单中Dataphin表的字段，支持表类型：维度逻辑表、事实逻辑表、汇总逻辑表、标签逻辑表、逻辑表视图、物理表、物理视图、物化视图表。 | / | 智能版 | ||
数据标准 | 更新数据标准词根。 | / | 基础版 | |
创建数据标准词根。 | / | 基础版 | ||
创建数据标准模板。 | / | 基础版 | ||
创建标准集。 | / | 基础版 | ||
创建标准关联关系。 | / | 基础版 | ||
创建标准映射关系, 包括有效映射和无效映射。 | / | 基础版 | ||
创建数据标准码表。 | / | 基础版 | ||
创建标准。 | / | 基础版 | ||
分页查询标准列表。 | / | 基础版 | ||
获取数据标准词根详情。 | / | 基础版 | ||
获取数据标准模板详情。 | / | 基础版 | ||
查询目录下按照标准类型统计标准数目。 | / | 基础版 | ||
获取标准集详情。 | / | 基础版 | ||
获取数据标准码表详情。 | / | 基础版 | ||
获取标准详情。 | / | 基础版 | ||
更新数据标准模板。 | / | 基础版 | ||
更新标准集。 | / | 基础版 | ||
将标准映射关系置为无效映射。 | / | 基础版 | ||
更新数据标准码表。 | / | 基础版 | ||
更新标准。 | / | 基础版 | ||
下线标准。 | / | 基础版 | ||
发布标准。 | / | 基础版 | ||
删除数据标准词根。 | / | 基础版 | ||
删除有效映射关系。 | / | 基础版 | ||
删除标准集。 | / | 基础版 | ||
批量删除标准关联关系。 | / | 基础版 | ||
删除数据标准码表。 | / | 基础版 | ||
删除无效映射关系。 | / | 基础版 | ||
删除标准。 | / | 基础版 | ||
数据质量 | 指定质量规则和调度设置进行绑定。 | / | 基础版 | |
分页查询质量监控对象。 | / | 基础版 | ||
分页查询质量监控任务。 | / | 基础版 | ||
分页查询质量模板。 | / | 基础版 | ||
分页查询质量规则。 | / | 基础版 | ||
分页查询质量规则任务。 | / | 基础版 | ||
获取监控任务对象的日志内容。 | / | 基础版 | ||
获取监控任务对象。 | / | 基础版 | ||
通过监控对象原始ID获取监控对象记录，例如：数据源、表、指标等的ID。 | / | 基础版 | ||
获取质量监控对象。 | / | 基础版 | ||
获取质量模板对象。 | / | 基础版 | ||
通过监控对象ID获取调度设置列表。 | / | 基础版 | ||
获取质量调度对象。 | / | 基础版 | ||
获取质量任务对象日志内容。 | / | 基础版 | ||
获取质量任务对象详情。 | / | 基础版 | ||
获取质量规则对象。 | / | 基础版 | ||
通过监控对象ID获取告警设置。 | / | 基础版 | ||
新建或者修改监控对象告警设置。 | / | 基础版 | ||
新建或更改质量监控对象, 支持添加多种类型的质量监控对象，包括：Dataphin表，全域表，数据源，指标，实时元表。 | / | 基础版 | ||
新建或者修改质量模板。 | / | 基础版 | ||
新建或者修改调度设置。 | / | 基础版 | ||
新建或者修改质量规则。 | / | 基础版 | ||
批量开启或关闭质量监控对象。 | / | 基础版 | ||
批量开启或关闭质量规则。 | / | 基础版 | ||
批量提交监控对象校验任务。 | / | 基础版 | ||
批量提交规则任务,支持试跑。 | / | 基础版 | ||
批量删除质量规则和调度的绑定关系。 | / | 基础版 | ||
批量删除质量监控对象。 | / | 基础版 | ||
批量删除质量模板对象。 | / | 基础版 | ||
批量删除质量调度对象。 | / | 基础版 | ||
批量删除质量规则对象。 | / | 基础版 | ||
更新数据分级。 | / | 基础版 | ||
更新安全识别结果的生效状态。 | / | 基础版 | ||
更新数据分类目录。 | / | 基础版 | ||
更新数据分类。 | / | 基础版 | ||
新建数据分级。 | / | 基础版 | ||
新建安全识别结果。 | / | 基础版 | ||
新建数据分类目录。 | / | 基础版 | ||
新建数据分类。 | / | 基础版 | ||
分页查询安全识别结果。 | / | 基础版 | ||
分页查询安全识别结果的识别记录。 | / | 基础版 | ||
通过密钥名称获取密钥值。 | / | 基础版 | ||
获取数据分级详情。 | / | 基础版 | ||
获取识别结果详情。 | / | 基础版 | ||
获取数据分类详情。 | / | 基础版 | ||
删除数据分级。 | / | 基础版 | ||
批量删除安全识别结果。 | / | 基础版 | ||
删除数据分类目录。 | / | 基础版 | ||
删除数据分类。 | / | 基础版 |
数据服务
分组 | OpenAPI名称 | API说明 | API限流等级 | 最低版本要求 | |
数据服务 | API管理 | 创建新的数据服务API并提交。 | 2级 | 敏捷版 | |
发布数据服务API到生产环境。 | 3级 | 敏捷版 | |||
分页查询已发布的API列表。 | 2级 | 敏捷版 | |||
查询数据服务API分组列表。 | 1级 | 敏捷版 | |||
获取API文档。 | 2级 | 敏捷版 | |||
根据APP查询API列表。 | 1级 | 敏捷版 | |||
查询应用已申请的API的具体的字段列表。 | 1级 | 敏捷版 | |||
API授权 | API授权。 | 3级 | 敏捷版 | ||
回收API授权。 | 3级 | 敏捷版 | |||
申请数据服务API权限。 | 2级 | 敏捷版 | |||
获取我管理的API权限列表。 | 1级 | 敏捷版 | |||
应用管理 | 查询租户下所有的应用列表。 | 1级 | 敏捷版 | ||
查询应用详情。 | 1级 | 敏捷版 | |||
创建数据服务应用。 | 3级 | 敏捷版 | |||
更新数据服务应用。 | 3级 | 敏捷版 | |||
删除数据服务应用。 | 3级 | 敏捷版 | |||
重置数据服务应用密钥。 | 3级 | 敏捷版 | |||
申请数据服务应用权限。 | 2级 | 敏捷版 | |||
查询分组下应用列表。 | 1级 | 敏捷版 | |||
应用分组 | 查询数据服务项目的应用分组列表。 | 1级 | 敏捷版 | ||
创建应用分组。 | 3级 | 敏捷版 | |||
更新应用分组。 | 3级 | 敏捷版 | |||
删除应用分组。 | 3级 | 敏捷版 | |||
根据APP分组ID查询账号有权限的应用列表。 | 1级 | 敏捷版 | |||
应用成员 | 查询应用成员列表。 | 2级 | 敏捷版 | ||
新增应用成员。 | 3级 | 敏捷版 | |||
更新应用成员。 | 3级 | 敏捷版 | |||
删除应用成员。 | 3级 | 敏捷版 | |||
获取应用有权限的用户列表。 | 1级 | 敏捷版 | |||
项目管理 | 获取当前用户作为负责人的项目列表。 | 1级 | 敏捷版 | ||
查询有权限的项目列表。 | 1级 | 敏捷版 | |||
获取可添加到项目成员的用户列表。 | 1级 | 敏捷版 | |||
添加数据服务项目用户并设置角色。 | 2级 | 敏捷版 | |||
权限查询 | 查询当前用户有权限的应用。 | 1级 | 敏捷版 | ||
查询当前用户有权限的应用列表。 | 1级 | 敏捷版 | |||
运维监控 | 运维监控：API访问趋势分析。 | 1级 | 敏捷版 | ||
运维监控：获取API调用汇总统计。 | 1级 | 敏捷版 | |||
运维分析：API调用统计信息。 | 3级 | 敏捷版 | |||
分页查询数据服务调用日志。 | 2级 | 敏捷版 | |||
分页查询数据服务API异常调用影响。 | 2级 | 敏捷版 | |||
获取API异常影响汇总。 | 2级 | 敏捷版 | |||
平台管理
分组 | OpenAPI名称 | API说明 | API限流等级 | 最低版本要求 |
用户与授权 | 一键转交负责人。 | 3级 | 敏捷版 | |
重新转交运行失败的转交任务。 | 3级 | 敏捷版 | ||
根据转交任务ID查询转交任务的进度。 | 2级 | 敏捷版 | ||
同步部门信息。 | / | 敏捷版 | ||
同步部门成员信息。 | / | 敏捷版 | ||
批量添加用户至租户。 说明 该API仅支持超级管理员和系统管理员调用。 | 3级 | 敏捷版 | ||
通过原始用户添加租户成员。 | 2级 | 敏捷版 | ||
添加用户组成员。 | 2级 | 敏捷版 | ||
分页获取权限操作日志。 | 3级 | 敏捷版 | ||
分页获取权限授权记录。 | 3级 | 敏捷版 | ||
获得项目生产账号。 说明 仅支持超级管理员发起调用。 | 1级 | 敏捷版 | ||
新建用户组。 | 3级 | 基础版 | ||
删除用户组。 | 3级 | 基础版 | ||
通过原始用户ID获取用户详情。 | 1级 | 敏捷版 | ||
获取用户组详情。 | 1级 | 基础版 | ||
根据UserID批量获取用户信息。 | 1级 | 敏捷版 | ||
获取可配置到租户成员的全局角色。 说明 仅限内置的全局角色，不支持自定义全局角色。 | 1级 | 敏捷版 | ||
查询租户可添加用户。 说明 仅支持超级管理员和系统管理员发起调用。 | 1级 | 敏捷版 | ||
查询租户成员列表。 | 1级 | 敏捷版 | ||
用户组列表分页查询。 | 1级 | 基础版 | ||
用户组成员分页查询。 | 1级 | 基础版 | ||
移除租户成员。 说明 支持超级管理员和系统管理员发起调用。 | 2级 | 敏捷版 | ||
移除用户组成员。 | 2级 | 基础版 | ||
编辑租户成员。 说明 仅支持超级管理员和系统管理员发起调用。 | 2级 | 敏捷版 | ||
编辑用户组。 | 3级 | 基础版 | ||
修改用户组的启用状态。 | 3级 | 基础版 | ||
获取当前用户归属租户。 | 1级 | 敏捷版 | ||
获取用户角色列表。 | 1级 | 敏捷版 | ||
行级权限 | 删除行级权限。 | 3级 | 敏捷版 | |
根据行级权限ID获取某一行级权限下的所有授权账号。 | 3级 | 敏捷版 | ||
分页查询行级权限。 | 3级 | 敏捷版 | ||
分页查询指定用户行级权限。 | 3级 | 敏捷版 | ||
更新行级权限。 | 3级 | 敏捷版 | ||
创建行级权限。 | 3级 | 敏捷版 | ||
根据表GUID获取行级权限。 | 3级 | 敏捷版 | ||
计算源 | 计算源连通性校验。 | 3级 | 敏捷版 | |
通过计算源ID校验已存在计算源连通性。 | 3级 | 敏捷版 | ||
查询计算源列表。 | 2级 | 敏捷版 | ||
编辑计算源：业务板块管理员、项目管理员有权限操作。 | 3级 | 敏捷版 | ||
通过计算源ID获取计算源详情。 | 2级 | 敏捷版 | ||
删除计算源。 | 3级 | 敏捷版 | ||
新建计算源。 说明 支持业务板块管理员和项目管理员新建。 | 3级 | 敏捷版 | ||
获取计算源对应集群的Spark客户信息。 | 2级 | 敏捷版 | ||
数据源 | 查询数据源变更影响的集成任务及数据库SQL任务 | 3级 | 敏捷版 | |
校验数据源连通性。 | 3级 | 敏捷版 | ||
根据数据源ID校验连通性。 | 3级 | 敏捷版 | ||
新建数据源。 说明 支持租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员新建。 | 3级 | 敏捷版 | ||
删除数据源。 说明 支持租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员删除。 | 3级 | 敏捷版 | ||
编辑数据源基础信息。 说明 支持租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员编辑。 | 3级 | 敏捷版 | ||
编辑数据源链接配置项。 说明 支持租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员编辑。 | 3级 | 敏捷版 | ||
数据源分页查询，查询结果包含数据源配置项。 | 2级 | 敏捷版 | ||
查询数据源连通性测试历史记录。 | 3级 | 敏捷版 | ||
项目 | 校验项目是否被任务等数据依赖。 | 3级 | 敏捷版 | |
通过项目ID获取项目详情。 | 1级 | 敏捷版 | ||
通过项目名获取项目详情。 | 1级 | |||
新增项目成员。 说明 支持项目管理员新增项目成员。 | 2级 | 敏捷版 | ||
获取项目白名单。 | 1级 | 敏捷版 | ||
查询项目成员列表 | 1级 | 敏捷版 | ||
获取项目列表。 | 1级 | 敏捷版 | ||
删除项目成员。 说明 支持项目管理员删除。 | 2级 | 敏捷版 | ||
更新项目白名单。 | 3级 | 敏捷版 | ||
编辑项目成员。 | 2级 | 敏捷版 | ||
修改租户计算设置。 | 3级 | 敏捷版 |