API限流等级及版本要求

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

调用限制

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

数据研发

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

即席查询

CreateAdHocFile

创建即席查询文件。

3

敏捷版

CreateDirectory

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

2

敏捷版

DeleteAdHocFile

删除即席查询文件。

3

敏捷版

DeleteDirectory

删除菜单树文件目录。

3

敏捷版

ListFiles

查询文件列表。

1

敏捷版

UpdateAdHocFile

修改即席查询文件。

2

敏捷版

UpdateFileDirectory

移动菜单树文件位置。

2

敏捷版

UpdateFileName

更新文件名。

2

敏捷版

GetAdHocFile

查询即席查询文件。

1

敏捷版

运维中心

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

实例运维

FixData

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

2

敏捷版

GetInstanceDownStream

获取实例下游实例列表。

1

敏捷版

GetInstanceUpDownStream

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

2

敏捷版

OperateInstance

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

2

敏捷版

GetSupplementDagrunInstance

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

1

敏捷版

ListInstances

获取实例列表。根据指定的查询条件获取实例的分页列表,实例类型包含周期实例手动实例。

1

敏捷版

任务运维

GetNodeUpDownStream

获取节点上下游。

2

敏捷版

ExecuteManualNode

运行手工任务。

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

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

2

敏捷版

GetOperationSubmitStatus

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

1

敏捷版

GetPhysicalInstanceLog

获取实例执行日志。

1

敏捷版

GetPhysicalNode

查询物理调度节点。

1

敏捷版

GetPhysicalNodeContent

查询调度节点代码内容。

1

敏捷版

GetPhysicalNodeOperationLog

查询节点的操作日志。

1

敏捷版

GetSupplementDagrun

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

1

敏捷版

ListNodeDownStream

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

2

敏捷版

ListNodes

查询调度节点列表。

1

敏捷版

PausePhysicalNode

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

2

敏捷版

ResumePhysicalNode

恢复物理节点调度。

2

敏捷版

CreateNodeSupplement

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

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

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

2

敏捷版

GetDevObjectDependency

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

2

敏捷版

GetPhysicalNodeByOutputName

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

1

敏捷版

数据权限

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

权限管理

CheckResourcePermission

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

2

敏捷版

GrantResourcePermission

根据资源授权用户。

说明

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

2

敏捷版

RevokeResourcePermission

根据资源回收用户权限。

说明

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

2

敏捷版

平台管理

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

成员管理

AddTenantMembers

批量添加用户至租户。

说明

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

2

敏捷版

AddTenantMembersBySourceUser

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

2

敏捷版

AddUserGroupMember

添加用户组成员。

2

敏捷版

CreateUserGroup

新建用户组。

2

基础版

DeleteUserGroup

删除用户组。

2

基础版

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

编辑用户组。

2

基础版

UpdateUserGroupSwitch

修改用户组的启用状态。

2

基础版

计算源

DeleteComputeSource

删除计算源。

3

敏捷版

数据源

CheckDataSourceConnectivity

校验数据源连通性。

3

敏捷版

CheckDataSourceConnectivityById

校验数据源ID连通性。

3

敏捷版

CreateDataSource

新建数据源。

说明

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

3

敏捷版

DeleteDataSource

删除数据源。

说明

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

3

敏捷版

UpdateDataSourceBasicInfo

编辑数据源基础信息。

说明

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

3

敏捷版

UpdateDataSourceConfig

编辑数据源链接配置项。

说明

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

3

敏捷版

项目

GetProjectProduceUser

获得项目生产账号。

说明

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

1

敏捷版