本文为您介绍不同功能支持的API限流等级及Dataphin版本要求。
使用限制
RAM角色不支持调用OpenAPI。
为保障应用的稳定性，Dataphin将OpenAPI分为1级、2级和3级，不同版本的限流等级及API的调用额度，请参见不同Dataphin版本支持的调用额度。
权限说明
当拥有DataphinOpenAPIFullAccess系统权限，支持调用所有OpenAPI。
当拥有DataphinOpenAPIReadOnlyAccess系统权限，支持调用只读OpenAPI。
数据研发
分组 | OpenAPI名称 | API说明 | API限流等级 | 最低版本要求 |
数据架构 | 创建业务实体。 | 3级 | 智能版 | |
删除业务实体。 | 3级 | 智能版 | ||
查询业务实体的详情。 | 1级 | 智能版 | ||
查询指定版本业务实体详情。 | 1级 | 智能版 | ||
查询业务实例列表。 | 2级 | 智能版 | ||
下线业务实体。 | 2级 | 智能版 | ||
上线业务实体。 | 2级 | 智能版 | ||
更新业务实体。 | 2级 | 智能版 | ||
创建数据板块。 | 3级 | 智能版 | ||
创建主题域。 | 3级 | 智能版 | ||
删除数据板块。 | 3级 | 智能版 | ||
删除主题域。 | 3级 | 智能版 | ||
根据数据板块ID获取板块信息。 | 3级 | 智能版 | ||
查看主题域详情。 | 3级 | 智能版 | ||
查询当前租户下的所有数据板块。 | 2级 | 智能版 | ||
查询主题域列表。 | 2级 | 智能版 | ||
更新数据板块。 | 2级 | 智能版 | ||
更新主题域。 | 2级 | 智能版 | ||
即席查询 | 创建即席查询文件。 | 3级 | 敏捷版 | |
创建菜单树目录。支持计算任务、数据集成、同步任务等功能。 | 2级 | 敏捷版 | ||
获取文件夹目录树。 | 1级 | 基础版 | ||
删除即席查询文件。 | 3级 | 敏捷版 | ||
删除菜单树文件目录。 | 3级 | 敏捷版 | ||
查询文件列表。 | 1级 | 敏捷版 | ||
修改即席查询文件。 | 2级 | 敏捷版 | ||
移动菜单树文件位置。 | 2级 | 敏捷版 | ||
更新文件名。 | 2级 | 敏捷版 | ||
查询即席查询文件。 | 1级 | 敏捷版 | ||
离线计算任务 | 创建数据集成任务。 | 3级 | 基础版 | |
终止即席查询任务。 | 2级 | 敏捷版 | ||
获取即席查询的任务运行结果。 | 2级 | 敏捷版 | ||
创建离线计算任务。 | 3级 | 敏捷版 | ||
删除离线计算任务。 | 3级 | 敏捷版 | ||
执行即席查询任务。 | 2级 | 敏捷版 | ||
获取即席查询任务运行日志。 | 1级 | 敏捷版 | ||
查询离线计算任务详情。 | 1级 | 敏捷版 | ||
获取离线计算任务版本列表。 | 2级 | 敏捷版 | ||
查询离线计算任务的自定义血缘。 | 2级 | 敏捷版 | ||
查询指定版本离线计算任务详情。 | 2级 | 敏捷版 | ||
下线离线计算任务。 | 2级 | 敏捷版 | ||
解析离线计算任务的逻辑表依赖。 说明 解析结果上游依赖信息中可能包含自依赖节点（上游节点ID和解析代码的任务节点ID相同）需要用户自己进行处理。 | 2级 | 敏捷版 | ||
更新离线计算任务自定义血缘。 | 2级 | 敏捷版 | ||
提交离线计算任务。 | 2级 | 敏捷版 | ||
更新离线计算任务。 | 2级 | 敏捷版 | ||
实时研发任务 | 获取集群引擎的版本信息。 | 2级 | 基础版 | |
获取环境集群队列信息。 | 2级 | 基础版 | ||
创建流批一体任务。 | 3级 | 基础版 | ||
发布 | 获取最新的待发布记录详情。 | 2级 | 基础版 | |
分页获取待发布记录列表。 | 2级 | 基础版 | ||
分页获取发布记录列表。 | 2级 | 基础版 | ||
批量发布对象。 | 2级 | 基础版 |
运维中心
分组 | OpenAPI名称 | API说明 | API限流等级 | 最低版本要求 |
实例运维 | 修复性数据重跑。支持强制重跑下游影响范围会产生计算成本，影响数据产出。 | 2级 | 敏捷版 | |
获取实例下游实例列表。 | 1级 | 敏捷版 | ||
查询实例的上下游。支持逻辑表和代码任务。 | 2级 | 敏捷版 | ||
批量运维实例，支持物理实例和逻辑表实例。 | 2级 | 敏捷版 | ||
获取补数据工作流DagRun下实例列表。 | 1级 | 敏捷版 | ||
获取实例列表。根据指定的查询条件获取实例的分页列表，实例类型包含周期实例手动实例。 | 1级 | 敏捷版 | ||
任务运维 | 获取节点上下游。 | 2级 | 敏捷版 | |
运行手工任务。 说明
| 2级 | 敏捷版 | ||
获取补数据工作流提交状态。 | 1级 | 敏捷版 | ||
获取实例执行日志。 | 1级 | 敏捷版 | ||
查询物理调度节点。 | 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限流等级 | 最低版本要求 |
用户与授权 | 批量添加用户至租户。 说明 该API仅支持超级管理员和系统管理员调用。 | 2级 | 敏捷版 | |
通过原始用户添加租户成员。 | 2级 | 敏捷版 | ||
添加用户组成员。 | 2级 | 敏捷版 | ||
分页获取权限操作日志。 | / | / | ||
分页获取权限授权记录。 | / | / | ||
新建用户组。 | 2级 | 基础版 | ||
删除用户组。 | 2级 | 基础版 | ||
通过原始用户ID获取用户详情。 | 1级 | 敏捷版 | ||
获取用户组详情。 | 1级 | 基础版 | ||
根据UserID批量获取用户信息。 | 1级 | 敏捷版 | ||
获取可配置到租户成员的全局角色。 说明 仅限内置的全局角色，不支持自定义全局角色。 | 1级 | 敏捷版 | ||
查询租户可添加用户。 说明 仅支持超级管理员和系统管理员发起调用。 | 1级 | 敏捷版 | ||
查询租户成员列表。 | 1级 | 敏捷版 | ||
用户组列表分页查询。 | 1级 | 基础版 | ||
用户组成员分页查询。 | 1级 | 基础版 | ||
移除租户成员。 说明 支持超级管理员和系统管理员发起调用。 | 2级 | 敏捷版 | ||
移除用户组成员。 | 2级 | 基础版 | ||
编辑租户成员。 说明 仅支持超级管理员和系统管理员发起调用。 | 2级 | 敏捷版 | ||
编辑用户组。 | 2级 | 基础版 | ||
修改用户组的启用状态。 | 2级 | 基础版 | ||
获取当前用户归属租户。 | / | / | ||
获取用户角色列表。 | / | / | ||
数据源 | 校验数据源连通性。 | 3级 | 敏捷版 | |
根据数据源ID校验连通性。 | 3级 | 敏捷版 | ||
新建数据源。 说明 支持租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员新建。 | 3级 | 敏捷版 | ||
删除数据源。 说明 支持租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员删除。 | 3级 | 敏捷版 | ||
编辑数据源基础信息。 说明 支持租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员编辑。 | 3级 | 敏捷版 | ||
编辑数据源链接配置项。 说明 支持租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员编辑。 | 3级 | 敏捷版 | ||
数据源分页查询，查询结果包含数据源配置项。 | 2级 | 敏捷版 | ||
项目 | 获得项目生产账号。 说明 仅支持超级管理员发起调用。 | 1级 | 敏捷版 |