API限流等级及版本要求

本文为您介绍不同功能支持的API限流等级及Dataphin版本要求。

使用限制

  • RAM角色不支持调用OpenAPI。

  • 为保障应用的稳定性,DataphinOpenAPI分为1级、2级和3级,不同版本的限流等级及API的调用额度,请参见不同Dataphin版本支持的调用额度

权限说明

  • 当拥有DataphinOpenAPIFullAccess系统权限,支持调用所有OpenAPI。

  • 当拥有DataphinOpenAPIReadOnlyAccess系统权限,支持调用只读OpenAPI。

数据研发

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

目录树

CreateDirectory

创建菜单树目录,支持计算任务、数据集成、同步任务等功能。

2

敏捷版

DeleteDirectory

删除菜单树文件目录。

3

敏捷版

UpdateFileName

更新文件名。

2

敏捷版

UpdateFileDirectory

移动菜单树文件位置。

2

敏捷版

GetDirectoryTree

获取文件夹目录树。

1

敏捷版

ListFiles

查询目录树文件列表。

1

敏捷版

数据架构

CreateBizEntity

创建业务实体。

3

智能版

DeleteBizEntity

删除业务实体。

3

智能版

GetBizEntityInfo

查询业务实体的详情。

1

智能版

GetBizEntityInfoByVersion

查询指定版本业务实体详情。

1

智能版

ListBizEntities

查询业务实例列表。

2

智能版

OfflineBizEntity

下线业务实体。

2

智能版

OnlineBizEntity

上线业务实体。

2

智能版

UpdateBizEntity

更新业务实体。

2

智能版

CreateBizUnit

创建数据板块。

3

智能版

CreateDataDomain

创建主题域。

3

智能版

DeleteBizUnit

删除数据板块。

3

智能版

DeleteDataDomain

删除主题域。

3

智能版

GetBizUnitInfo

根据数据板块ID获取板块信息。

3

智能版

GetDataDomainInfo

查看主题域详情。

3

智能版

ListBizUnits

查询当前租户下的所有数据板块。

2

智能版

ListDataDomains

查询主题域列表。

3

智能版

UpdateBizUnit

更新数据板块。

3

智能版

UpdateDataDomain

更新主题域。

3

智能版

即席查询

CreateAdHocFile

创建即席查询文件。

3

敏捷版

DeleteAdHocFile

删除即席查询文件。

3

敏捷版

UpdateAdHocFile

修改即席查询文件。

2

敏捷版

GetAdHocFile

查询即席查询文件。

1

敏捷版

离线计算任务

CreatePipelineNode

创建数据集成任务。

3

基础版

StopAdHocTask

终止即席查询任务。

2

敏捷版

GetAdHocTaskResult

获取即席查询的任务运行结果。

2

敏捷版

CreateBatchTask

创建离线计算任务。

3

敏捷版

DeleteBatchTask

删除离线计算任务。

3

敏捷版

ExecuteAdHocTask

执行即席查询任务。

2

敏捷版

GetAdHocTaskLog

获取即席查询任务运行日志。

1

敏捷版

GetBatchTaskInfo

查询离线计算任务详情

1

敏捷版

GetBatchTaskVersions

获取离线计算任务版本列表。

2

敏捷版

GetBatchTaskUdfLineages

查询离线计算任务的自定义血缘。

2

敏捷版

GetBatchTaskInfoByVersion

查询指定版本离线计算任务详情

2

敏捷版

OfflineBatchTask

下线离线计算任务。

3

敏捷版

ParseBatchTaskDependency

解析离线计算任务的逻辑表依赖。

说明

解析结果上游依赖信息中可能包含自依赖节点(上游节点ID和解析代码的任务节点ID相同)需要用户自己进行处理。

3

敏捷版

UpdateBatchTaskUdfLineages

更新离线计算任务自定义血缘。

3

敏捷版

SubmitBatchTask

提交离线计算任务。

3

敏捷版

UpdateBatchTask

更新离线计算任务。

3

敏捷版

实时研发任务

GetStreamJobs

获取实时研发任务。

2

基础版

GetQueueEngineVersionByEnv

获取集群引擎的版本信息。

2

基础版

GetClusterQueueInfoByEnv

获取环境集群队列信息。

2

基础版

CreateStreamBatchJobMapping

创建流批一体任务。

2

基础版

资源

GetResource

获取资源文件详情。

2

敏捷版

GetResourceByVersion

获取资源文件指定版本详情。

2

敏捷版

UpdateResource

编辑资源文件。

2

敏捷版

GetFileStorageCredential

获取文件存储临时读写授权。

2

敏捷版

DeleteResource

删除资源文件。

3

敏捷版

CreateResource

创建资源文件。

3

敏捷版

函数

GetUdf

获取自定义函数详情。

2

敏捷版

GetUdfByVersion

查询自定义函数指定版本详情。

2

敏捷版

UpdateUdf

编辑自定义函数。

2

敏捷版

DeleteUdf

删除自定义函数。

3

敏捷版

CreateUdf

创建自定义函数。

3

敏捷版

发布

GetLatestSubmitDetail

获取最新的待发布记录详情。

2

基础版

ListSubmitRecords

分页获取待发布记录列表。

2

基础版

ListPublishRecords

分页获取发布记录列表。

2

基础版

PublishObjectList

批量发布对象。

2

基础版

运维中心

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

实例运维

FixData

修复性数据重跑。支持强制重跑下游影响范围会产生计算成本,影响数据产出。

2

敏捷版

GetInstanceDownStream

获取实例下游实例列表。

2

敏捷版

GetInstanceUpDownStream

查询实例的上下游。支持逻辑表和代码任务。

2

敏捷版

OperateInstance

批量运维实例,支持物理实例和逻辑表实例。

2

敏捷版

GetSupplementDagrunInstance

列出补数据工作流下具体一个业务日期的所有节点的实例。

1

敏捷版

GetPhysicalInstance

获取实例信息。

1

敏捷版

ListInstances

分页查询实例。

1

敏捷版

任务运维

GetNodeUpDownStream

获取节点上下游。

2

敏捷版

ExecuteManualNode

运行手工任务。

说明
  • 会生成手工调度节点,影响相关表。

  • 会进行任务运行,造成计算的费用以及存储的费用。

2

敏捷版

GetOperationSubmitStatus

获取补数据工作流提交状态。

1

敏捷版

GetPhysicalInstanceLog

获取实例执行日志。

2

敏捷版

GetPhysicalNode

查询物理调度节点。

1

敏捷版

GetPhysicalNodeContent

查询调度节点代码内容。

1

敏捷版

GetPhysicalNodeOperationLog

查询节点的操作日志。

1

敏捷版

GetSupplementDagrun

获取补数据工作流Dagrun列表。

1

敏捷版

ListNodeDownStream

查询节点下游,创建补数据工作流时可以作为数据参考。

2

敏捷版

ListNodes

查询调度节点列表。

1

敏捷版

PausePhysicalNode

暂停物理节点调度,接口调用成功后,会暂停任务的调度,下游任务将无法调起,暂时仅支持离线代码任务及集成任务。

2

敏捷版

ResumePhysicalNode

恢复物理节点调度。

2

敏捷版

CreateNodeSupplement

通用补数据接口,支持列表模式补数据和海量模式补数据。

说明
  • 会生成补数据实例运行,影响相关表数据产出。

  • 会进行任务运行,造成计算的费用以及存储的费用。

2

敏捷版

GetDevObjectDependency

查询开发态对象上游依赖。

2

敏捷版

GetPhysicalNodeByOutputName

根据输出名查询物理节点,仅支持离线代码节点及集成任务节点。

1

敏捷版

告警信息

GetAlertEvent

获取告警事件详情。

1

敏捷版

ListAlertEvents

根据条件查询多个告警事件。

1

敏捷版

ListAlertNotifications

根据条件查询多个推送记录。

1

敏捷版

数据权限

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

权限管理

CheckResourcePermission

校验用户是否有操作指定资源的权限。

2

敏捷版

GrantResourcePermission

根据资源授权用户。

说明

API仅支持超级管理员和资源所有者(项目管理员、数据源管理员)发起调用,目前支持表、数据源。

2

敏捷版

RevokeResourcePermission

回收用户资源权限。

说明

API仅支持超级管理员和资源所有者(项目管理员、数据源管理员)发起调用,目前支持表、数据源。

2

敏捷版

数据资产

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

资产

GetTableLineageByTaskId

查询表血缘信息。

2

敏捷版

GetTableColumnLineageByTaskId

查询表字段血缘信息。

2

敏捷版

数据服务

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

数据服务

RevokeDataServiceApi

回收API授权。

3

基础版

PublishDataServiceApi

发布数据服务API到生产环境。

3

基础版

ListDataServicePublishedApis

分页查询已发布的API列表。

2

基础版

ListDataServiceMyAppPermissions

查询当前用户有权限的应用。

1

基础版

ListDataServiceMyApiPermissions

获取我管理的API权限列表。

1

基础版

ListDataServiceAuthorizedApps

查询当前用户有权限的应用列表。

1

基础版

ListDataServiceApiImpacts

分页查询数据服务API异常调用影响。

2

基础版

ListDataServiceApiCalls

分页查询数据服务调用日志。

2

基础版

ListDataServiceApiCallStatistics

运维分析:API调用统计信息。

3

基础版

GrantDataServiceApi

API授权。

3

基础版

GetDataServiceProjectAddableUsers

获取可添加到项目成员的用户列表。

1

基础版

GetDataServiceMyProjects

获取当前用户作为负责人的项目列表。

1

基础版

GetDataServiceAuthorizedProjects

查询有权限的项目列表。

1

基础版

GetDataServiceAuthorizedAppsByGroupId

根据APP分组ID查询账号有权限的应用列表。

1

基础版

GetDataServiceAppsByGroupId

查询分组下应用列表。

1

基础版

GetDataServiceAppGroups

查询数据服务项目的应用分组列表。

1

基础版

GetDataServiceAppAuthorizedUsers

获取应用有权限的用户列表。

1

基础版

GetDataServiceApiGroups

查询数据服务API分组列表。

1

基础版

GetDataServiceApiErrorImpact

获取API异常影响汇总。

2

基础版

GetDataServiceApiDocument

获取API文档。

2

基础版

GetDataServiceApiCallTrend

运维监控:API访问趋势分析。

1

基础版

GetDataServiceApiCallSummary

运维监控:获取API调用汇总统计。

1

基础版

ApplyDataServiceApp

申请数据服务应用权限。

2

基础版

ApplyDataServiceApi

申请数据服务API权限。

2

基础版

AddDataServiceProjectMember

添加数据服务项目用户并设置角色。

2

基础版

CreateDataServiceApi

创建新的数据服务API并提交。

2

基础版

ListApiByApp

根据APP查询API列表。

1

基础版

ListAuthorizedDataServiceApiDetails

查询应用已申请的API的具体的字段列表。

1

基础版

平台管理

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

用户与授权

TransferOwnershipForAllObject

一键转交负责人

3

敏捷版

RetryTransferOwnership

重新转交运行失败的转交任务

3

敏捷版

GetTransferInfo

根据转交任务ID查询转交任务的进度

2

敏捷版

AddTenantMembers

批量添加用户至租户。

说明

API仅支持超级管理员和系统管理员调用。

3

敏捷版

AddTenantMembersBySourceUser

通过原始用户添加租户成员。

2

敏捷版

AddUserGroupMember

添加用户组成员。

2

敏捷版

ListResourcePermissionOperationLog

分页获取权限操作日志。

3

敏捷版

ListResourcePermissions

分页获取权限授权记录。

3

敏捷版

GetProjectProduceUser

获得项目生产账号。

说明

仅支持超级管理员发起调用。

1

敏捷版

CreateUserGroup

新建用户组。

3

基础版

DeleteUserGroup

删除用户组。

3

基础版

GetUserBySourceId

通过原始用户ID获取用户详情。

1

敏捷版

GetUserGroup

获取用户组详情。

1

基础版

GetUsers

根据UserID批量获取用户信息。

1

敏捷版

ListAddableRoles

获取可配置到租户成员的全局角色。

说明

仅限内置的全局角色,不支持自定义全局角色。

1

敏捷版

ListAddableUsers

查询租户可添加用户。

说明

仅支持超级管理员和系统管理员发起调用。

1

敏捷版

ListTenantMembers

查询租户成员列表。

1

敏捷版

ListUserGroups

用户组列表分页查询。

1

基础版

ListUserGroupMembers

用户组成员分页查询。

1

基础版

RemoveTenantMember

移除租户成员。

说明

支持超级管理员和系统管理员发起调用。

2

敏捷版

RemoveUserGroupMember

移除用户组成员。

2

基础版

UpdateTenantMember

编辑租户成员。

说明

仅支持超级管理员和系统管理员发起调用。

2

敏捷版

UpdateUserGroup

编辑用户组。

3

基础版

UpdateUserGroupSwitch

修改用户组的启用状态。

3

基础版

GetMyTenants

获取当前用户归属租户

1

敏捷版

GetMyRoles

获取用户角色列表。

1

敏捷版

行级权限

DeleteRowPermission

删除行级权限。

3

敏捷版

GetAccountByRowPermissionId

根据行级权限ID获取某一行级权限下的所有授权账号。

3

敏捷版

ListRowPermission

分页查询行级权限。

3

敏捷版

ListRowPermissionByUserId

分页查询指定用户行级权限。

3

敏捷版

UpdateRowPermission

更新行级权限。

3

敏捷版

CreateRowPermission

创建行级权限。

3

敏捷版

计算源

CheckComputeSourceConnectivity

计算源连通性校验。

3

敏捷版

CheckComputeSourceConnectivityById

通过计算源ID校验已存在计算源连通性。

3

敏捷版

ListComputeSources

查询计算源列表。

2

敏捷版

UpdateComputeSource

编辑计算源:业务板块管理员、项目管理员有权限操作。

3

敏捷版

GetComputeSource

通过计算源ID获取计算源详情。

2

敏捷版

DeleteComputeSource

删除计算源。

3

敏捷版

CreateComputeSource

新建计算源。

说明

支持业务板块管理员和项目管理员新建。

3

敏捷版

GetSparkLocalClientInfo

获取计算源对应集群的Spark客户信息。

2

敏捷版

数据源

GetDataSourceDependencies

查询数据源变更影响的集成任务及数据库SQL任务

3

敏捷版

CheckDataSourceConnectivity

校验数据源连通性。

3

敏捷版

CheckDataSourceConnectivityById

根据数据源ID校验连通性。

3

敏捷版

CreateDataSource

新建数据源。

说明

支持租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员新建。

3

敏捷版

DeleteDataSource

删除数据源。

说明

支持租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员删除。

3

敏捷版

UpdateDataSourceBasicInfo

编辑数据源基础信息。

说明

支持租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员编辑。

3

敏捷版

UpdateDataSourceConfig

编辑数据源链接配置项。

说明

支持租户管理员、数据管理员、业务板块管理员、项目管理员、运营管理员编辑。

3

敏捷版

ListDataSourceWithConfig

数据源分页查询,查询结果包含数据源配置项。

2

敏捷版

项目

CheckProjectHasDependency

校验项目是否被任务等数据依赖。

3

敏捷版

GetProject

通过项目ID获取项目详情。

1

敏捷版

GetProjectByName

通过项目名获取项目详情。

1

敏捷版

AddProjectMember

新增项目成员。

说明

支持项目管理员新增项目成员。

2

敏捷版

GetProjectWhiteLists

获取项目白名单。

1

敏捷版

ListProjectMembers

查询项目成员列表

1

敏捷版

ListProjects

获取项目列表。

1

敏捷版

RemoveProjectMember

删除项目成员。

说明

支持项目管理员删除。

2

敏捷版

ReplaceProjectWhiteLists

更新项目白名单。

3

敏捷版

UpdateProjectMember

编辑项目成员。

2

敏捷版

UpdateTenantComputeEngine

修改租户计算设置。

3

敏捷版