OpenAPI限流等级及版本要求

更新时间:
复制 MD 格式

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

使用限制

  • RAM角色不支持调用OpenAPI。

  • 为保障应用的稳定性,Dataphin将OpenAPI分为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级

敏捷版

StopAdHocTask

终止即席查询任务。

2级

敏捷版

GetAdHocTaskResult

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

2级

敏捷版

ExecuteAdHocTask

执行即席查询任务。

2级

敏捷版

GetAdHocTaskLog

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

1级

敏捷版

ExecuteDDL

执行DDL,根据指定的数据源标识及DDL语句在数据源上执行建表。

/

敏捷版

非结构化数据

CreateWorkFlowByJson

使用JSON脚本模式创建非结构化工作流任务。

1级

基础版

CreateDataset

创建数据集。

1级

基础版

DeleteDataset

删除数据集。

1级

基础版

GetDataset

获取数据集。

3级

基础版

ListDatasets

数据集列表查询。

3级

基础版

UpdateDataset

更新数据集信息。

1级

基础版

GetLlmModelProviders

查询所有大模型服务供应商和可用模型列表。

/

基础版

GetLlmModelProviderByName

根据名称查询特定的大模型服务供应商和可用模型。

/

基础版

运行记录

ListOperationRecord

分页查询运行记录。

2级

敏捷版

GetOperationRecordRunCod

获取运行记录运行代码。

2级

敏捷版

GetOperationRecordById

根据ID获取单条运行记录。

2级

敏捷版

GetOperationRecordDetail

获取运行记录详情,包括日志和结果。

1级

敏捷版

离线集成

CreatePipeline

创建集成管道/非结构化工作流任务。

3级

敏捷版

CreatePipelineByAsync

异步创建集成管道/非机构化工作流任务。

3级

敏捷版

OfflinePipeline

下线管道任务。

3级

敏捷版

OfflinePipelineByAsync

异步下线管道任务。

3级

敏捷版

GetPipelineAsyncResult

查询管道异步执行结果。

1级

敏捷版

GetPipelineById

根据管道ID查询管道任务。

1级

敏捷版

UpdatePipeline

更新管道任务。

3级

敏捷版

UpdatePipelineByAsync

异步更新集成管道任务。

3级

敏捷版

离线计算任务

GetOperationRecordRunCode

查询运行记录运行代码。

/

敏捷版

CreatePipelineNode

创建数据集成任务。

说明

从V5.3.1版本开始不建议使用,请使用CreatePipeline。

3级

基础版

ListPipelines

查询任务列表,支持查询离线集成和非结构化工作流(数据归集/离线工作流/实时工作流),支持按目录、关键字、任务类型、提交状态、调度类型、负责人、标签、创建人等多维过滤,结果分页返回。

/

敏捷版

CreateBatchTask

创建离线计算任务。

3级

敏捷版

DeleteBatchTask

删除离线计算任务。

3级

敏捷版

GetBatchTaskInfo

查询离线计算任务详情。

1级

敏捷版

SubmitPipelineById

根据OAQueryId提交集成管道任务。

/

敏捷版

GetBatchTaskVersions

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

2级

敏捷版

GetBatchTaskUdfLineages

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

2级

敏捷版

GetBatchTaskInfoByVersion

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

2级

敏捷版

OfflineBatchTask

下线离线计算任务。

3级

敏捷版

ParseBatchTaskDependency

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

说明

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

3级

敏捷版

UpdateBatchTaskUdfLineages

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

3级

敏捷版

SubmitBatchTask

提交离线计算任务。

3级

敏捷版

UpdateBatchTask

更新离线计算任务。

3级

敏捷版

离线计算任务模板

ListBatchTemplates

分页查询离线计算任务模板列表。

3级

敏捷版

GetBatchTemplateVersions

获取模板版本列表。

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级

敏捷版

ListApprovalTasksByUser

按当前用户与审批任务的关系分页查询审批任务列表。

/

敏捷版

ListNodes

查询调度节点列表。

1级

敏捷版

PausePhysicalNode

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

2级

敏捷版

ResumePhysicalNode

恢复物理节点调度。

2级

敏捷版

CreateNodeSupplement

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

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

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

2级

敏捷版

GetDevObjectDependency

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

2级

敏捷版

UpdateNodeOpsOwner

批量修改运维负责人。(仅限离线任务:计算任务/集成任务/逻辑表,不支持实时任务)。

/

敏捷版

ExecuteTriggerNode

运行触发式节点。

/

敏捷版

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级

敏捷版

UpdateDataAssetsGovernObjectStatus

根据治理项ID,批量修改问题清单对象的状态。

/

敏捷版

UpsertQualityArchiveTable

新建或者修改监控对象的异常归档表。

/

敏捷版

UpdateAssetAttributes

更新资产属性值。

/

敏捷版

SubmitAssetsOffShelve

提交资产下架。

/

敏捷版

AddRegisterLineage

新增注册血缘。

2级

敏捷版

GetAssetTypeAttributeCodes

查询资产属性定义。

/

敏捷版

GetAssetAttributes

查询资产属性值。

/

敏捷版

ListAssetTopics

查询已发布的资产上架专题列表。

/

敏捷版

ListAssetDirectories

查询指定资产专题下的已发布目录列表。

/

敏捷版

GetDataAssetsGovernObject

根据治理项ID,获取指定问题清单对象的详情。

/

敏捷版

ListQualityArchiveTables

查询指定监控对象下的异常归档表列表。

/

敏捷版

ListGovernObjects

根据治理类型和筛选条件查看问题清单列表。

/

敏捷版

DeleteRegisterLineage

删除注册血缘。

2级

敏捷版

SubmitAssetsOnShelve

提交资产上架。

/

敏捷版

CreateBizMetric

新建业务指标。

3级

敏捷版

UpdateBizMetric

更新业务指标。

3级

敏捷版

DeleteBizMetric

删除业务指标。

3级

敏捷版

GetBizMetricByName

查询业务指标详情。

2级

敏捷版

ListCatalogAssets

查询资产目录列表(精准匹配+模糊搜索)。

2级

敏捷版

GetCatalogAssetDetails

查询资产目录中资产详情信息。

2级

敏捷版

GetTableLineages

查询资产表血缘信息。

/

敏捷版

GetBelongAssetMapping

根据归属资产GUID查询映射关系。

/

敏捷版

GetAssetMappingRelations

根据资产对象GUID查询映射关系。

/

敏捷版

ListTables

分页查询资产表元数据。

/

敏捷版

GetTableColumnLineages

查询资产表字段血缘信息。

/

敏捷版

GetTableColumns

查询资产清单中Dataphin表的字段,支持表类型:维度逻辑表、事实逻辑表、汇总逻辑表、标签逻辑表、逻辑表视图、物理表、物理视图、物化视图表。

/

智能版

数据标准

UpdateStandardWordRoot

更新数据标准词根。

/

基础版

CreateStandardWordRoot

创建数据标准词根。

/

基础版

CreateStandardTemplate

创建数据标准模板。

/

基础版

CreateStandardSet

创建标准集。

/

基础版

CreateStandardRelations

创建标准关联关系。

/

基础版

CreateStandardMapping

创建标准映射关系, 包括有效映射和无效映射。

/

基础版

CreateStandardLookupTable

创建数据标准码表。

/

基础版

CreateStandard

创建标准。

/

基础版

ListStandards

分页查询标准列表。

/

基础版

GetStandardWordRoot

获取数据标准词根详情。

/

基础版

GetStandardTemplate

获取数据标准模板详情。

/

基础版

GetStandardStatistics

查询目录下按照标准类型统计标准数目。

/

基础版

GetStandardSet

获取标准集详情。

/

基础版

GetStandardLookupTable

获取数据标准码表详情。

/

基础版

GetStandard

获取标准详情。

/

基础版

UpdateStandardTemplate

更新数据标准模板。

/

基础版

UpdateStandardSet

更新标准集。

/

基础版

UpdateStandardMappingToInvalid

将标准映射关系置为无效映射。

/

基础版

UpdateStandardLookupTable

更新数据标准码表。

/

基础版

UpdateStandard

更新标准。

/

基础版

OfflineStandard

下线标准。

/

基础版

PublishStandard

发布标准。

/

基础版

DeleteStandardWordRoot

删除数据标准词根。

/

基础版

DeleteStandardValidMapping

删除有效映射关系。

/

基础版

DeleteStandardSet

删除标准集。

/

基础版

DeleteStandardRelations

批量删除标准关联关系。

/

基础版

DeleteStandardLookupTable

删除数据标准码表。

/

基础版

DeleteStandardInValidMapping

删除无效映射关系。

/

基础版

DeleteStandard

删除标准。

/

基础版

数据质量

AssignQualityRuleOfAllRuleScopeSchedules

指定质量规则和调度设置进行绑定。

/

基础版

GetQualityArchiveTableProgress

根据进度ID查询新建或修改异常归档表异步任务的执行进度与结果。

/

基础版

ListQualityWatches

分页查询质量监控对象。

/

基础版

ListQualityWatchTasks

分页查询质量监控任务。

/

基础版

ListQualityTemplates

分页查询质量模板。

/

基础版

ListQualityRules

分页查询质量规则。

/

基础版

ListQualityRuleTasks

分页查询质量规则任务。

/

基础版

GetQualityWatchTaskLog

获取监控任务对象的日志内容。

/

基础版

GetQualityWatchTask

获取监控任务对象。

/

基础版

GetQualityWatchByObjectId

通过监控对象原始ID获取监控对象记录,例如:数据源、表、指标等的ID。

/

基础版

GetQualityWatch

获取质量监控对象。

/

基础版

GetQualityTemplate

获取质量模板对象。

/

基础版

GetQualitySchedulesByWatchId

通过监控对象ID获取调度设置列表。

/

基础版

GetQualitySchedule

获取质量调度对象。

/

基础版

GetQualityRuleTaskLog

获取质量任务对象日志内容。

/

基础版

GetQualityRuleTask

获取质量任务对象详情。

/

基础版

GetQualityRule

获取质量规则对象。

/

基础版

GetQualityAlertOfAllRuleScopeByWatchId

通过监控对象ID获取告警设置。

/

基础版

UpsertQualityWatchAlert

新建或者修改监控对象告警设置。

/

基础版

UpsertQualityWatch

新建或更改质量监控对象, 支持添加多种类型的质量监控对象,包括:Dataphin表,全域表,数据源,指标,实时元表。

/

基础版

UpsertQualityTemplate

新建或者修改质量模板。

/

基础版

UpsertQualitySchedule

新建或者修改调度设置。

/

基础版

UpsertQualityRule

新建或者修改质量规则。

/

基础版

UpdateQualityWatchSwitch

批量开启或关闭质量监控对象。

/

基础版

UpdateQualityRuleSwitch

批量开启或关闭质量规则。

/

基础版

SubmitQualityWatchTasks

批量提交监控对象校验任务。

/

基础版

SubmitQualityRuleTasks

批量提交规则任务,支持试跑。

/

基础版

RemoveQualityRuleSchedules

批量删除质量规则和调度的绑定关系。

/

基础版

DeleteQualityWatches

批量删除质量监控对象。

/

基础版

DeleteQualityTemplates

批量删除质量模板对象。

/

基础版

DeleteQualitySchedules

批量删除质量调度对象。

/

基础版

DeleteQualityRules

批量删除质量规则对象。

/

基础版

UpdateSecurityLevel

更新数据分级。

/

基础版

UpdateSecurityIdentifyResultStatus

更新安全识别结果的生效状态。

/

基础版

UpdateSecurityClassifyCatalog

更新数据分类目录。

/

基础版

UpdateSecurityClassify

更新数据分类。

/

基础版

CreateSecurityLevel

新建数据分级。

/

基础版

CreateSecurityIdentifyResult

新建安全识别结果。

/

基础版

CreateSecurityClassifyCatalog

新建数据分类目录。

/

基础版

CreateSecurityClassify

新建数据分类。

/

基础版

ListSecurityClassify

分页查询数据分类列表。

/

基础版

ListSecurityIdentifyResults

分页查询安全识别结果。

/

基础版

ListSecurityIdentifyRecords

分页查询安全识别结果的识别记录。

/

基础版

GetSecuritySecretKey

通过密钥名称获取密钥值。

/

基础版

GetSecurityLevel

获取数据分级详情。

/

基础版

GetSecurityIdentifyResult

获取识别结果详情。

/

基础版

GetSecurityClassify

获取数据分类详情。

/

基础版

DeleteSecurityLevel

删除数据分级。

/

基础版

DeleteSecurityIdentifyResults

批量删除安全识别结果。

/

基础版

DeleteSecurityClassifyCatalog

删除数据分类目录。

/

基础版

DeleteSecurityClassify

删除数据分类。

/

基础版

数据服务

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

数据服务

API管理

CreateDataServiceApi

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

2级

敏捷版

PublishDataServiceApi

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

3级

敏捷版

ListDataServicePublishedApis

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

2级

敏捷版

GetDataServiceApiGroups

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

1级

敏捷版

GetDataServiceApiDocument

获取API文档。

2级

敏捷版

ListApiByApp

根据APP查询API列表。

1级

敏捷版

ListAuthorizedDataServiceApiDetails

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

1级

敏捷版

API授权

GrantDataServiceApi

API授权。

3级

敏捷版

RevokeDataServiceApi

回收API授权。

3级

敏捷版

ApplyDataServiceApi

申请数据服务API权限。

2级

敏捷版

ListDataServiceMyApiPermissions

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

1级

敏捷版

应用管理

ListDataServiceApps

查询租户下所有的应用列表。

1级

敏捷版

GetDataServiceApp

查询应用详情。

1级

敏捷版

CreateDataServiceApp

创建数据服务应用。

3级

敏捷版

UpdateDataServiceApp

更新数据服务应用。

3级

敏捷版

DeleteDataServiceApp

删除数据服务应用。

3级

敏捷版

ResetDataServiceAppSecret

重置数据服务应用密钥。

3级

敏捷版

ApplyDataServiceApp

申请数据服务应用权限。

2级

敏捷版

GetDataServiceAppsByGroupId

查询分组下应用列表。

1级

敏捷版

应用分组

GetDataServiceAppGroups

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

1级

敏捷版

CreateDataServiceAppGroup

创建应用分组。

3级

敏捷版

UpdateDataServiceAppGroup

更新应用分组。

3级

敏捷版

DeleteDataServiceAppGroup

删除应用分组。

3级

敏捷版

GetDataServiceAuthorizedAppsByGroupId

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

1级

敏捷版

应用成员

GetDataServiceAppMembers

查询应用成员列表。

2级

敏捷版

AddDataServiceAppMember

新增应用成员。

3级

敏捷版

UpdateDataServiceAppMember

更新应用成员。

3级

敏捷版

RemoveDataServiceAppMember

删除应用成员。

3级

敏捷版

GetDataServiceAppAuthorizedUsers

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

1级

敏捷版

项目管理

GetDataServiceMyProjects

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

1级

敏捷版

GetDataServiceAuthorizedProjects

查询有权限的项目列表。

1级

敏捷版

GetDataServiceProjectAddableUsers

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

1级

敏捷版

AddDataServiceProjectMember

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

2级

敏捷版

权限查询

ListDataServiceMyAppPermissions

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

1级

敏捷版

ListDataServiceAuthorizedApps

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

1级

敏捷版

运维监控

GetDataServiceApiCallTrend

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

1级

敏捷版

GetDataServiceApiCallSummary

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

1级

敏捷版

ListDataServiceApiCallStatistics

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

3级

敏捷版

ListDataServiceApiCalls

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

2级

敏捷版

ListDataServiceApiImpacts

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

2级

敏捷版

GetDataServiceApiErrorImpact

获取API异常影响汇总。

2级

敏捷版

平台管理

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

用户与授权

TransferOwnershipForAllObject

一键转交负责人。

3级

敏捷版

RetryTransferOwnership

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

3级

敏捷版

GetTransferInfo

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

2级

敏捷版

SyncDepartment

同步部门信息。

/

敏捷版

SyncDepartmentUser

同步部门成员信息。

/

敏捷版

AddTenantMembers

批量添加用户至租户。

说明

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

3级

敏捷版

AddTenantMembersBySourceUser

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

2级

敏捷版

AddUserGroupMember

添加用户组成员。

2级

敏捷版

ListResourcePermissionOperationLog

分页获取权限操作日志。

3级

敏捷版

ListResourcePermissions

分页获取权限授权记录。

3级

敏捷版

GetProjectProduceUser

获得项目生产账号。

说明

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

1级

敏捷版

CreateUserGroup

新建用户组。

3级

基础版

GetUserByAccessKey

根据请求签名所用的AccessKey/SecretKey获取当前用户信息。

/

基础版

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级

敏捷版

GetRowPermissionByTableGuids

根据表GUID获取行级权限。

3级

敏捷版

GetServerVersion

获取Dataphin服务端版本。

/

敏捷版

计算源

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级

敏捷版

GetCheckConnectivityJobs

查询数据源连通性测试历史记录。

3级

敏捷版

项目

CreateDevProdProject

创建Dev-Prod(双环境)项目。

/

敏捷版

CreateBasicProject

创建Basic(单环境)项目。

/

敏捷版

CheckProjectHasDependency

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

3级

敏捷版

GetProject

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

1级

敏捷版

GetProjectByName

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

1级

敏捷版

AddProjectMember

新增项目成员。

说明

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

2级

敏捷版

GetProjectWhiteLists

获取项目白名单。

1级

敏捷版

UpdateDevProdProject

编辑Dev-Prod(双环境)项目。

/

敏捷版

UpdateBasicProject

编辑Basic(单环境)项目。项目名不可修改,需传入当前项目名。

/

敏捷版

ListProjectMembers

查询项目成员列表

1级

敏捷版

ListProjects

获取项目列表。

1级

敏捷版

DeleteProject

删除项目(Basic/Dev-Prod项目均适用)。

/

敏捷版

RemoveProjectMember

删除项目成员。

说明

支持项目管理员删除。

2级

敏捷版

ReplaceProjectWhiteLists

更新项目白名单。

3级

敏捷版

UpdateProjectMember

编辑项目成员。

2级

敏捷版

UpdateTenantComputeEngine

修改租户计算设置。

3级

敏捷版

集群

UploadDataSourceFile

创建数据源和计算源时,如果需要上传文件,请先调用此接口上传文件获取FileId。

/

敏捷版

CreateComputeCluster

创建集群。

/

敏捷版

GetComputeCluster

查询集群详情。

/

敏捷版

UpdateComputeCluster

修改集群。

/

敏捷版

DeleteComputeCluster

删除集群。

/

敏捷版

ListComputeClusters

查询集群列表。

/

敏捷版

知识图谱

分组

OpenAPI名称

API说明

API限流等级

最低版本要求

知识图谱

ExportKgSchema

知识图谱元数据定义导出。

3级

基础版

ImportKgSchema

知识图谱模型定义导入。

1级

基础版

PublishKgSchema

发布图谱模型。

1级

基础版

GetKgSchemaPublishResult

获取图谱模型发布结果。

3级

基础版

CreateKgEntity

创建知识图谱实体记录。

1级

基础版

UpdateKgEntity

编辑知识图谱实体记录。

1级

基础版

DeleteKgEntity

删除实体记录。

1级

基础版

GetKgEntity

获取知识图谱实体记录详情。

3级

基础版

ListKgEntity

分页查询知识图谱实体记录。

3级

基础版

BatchCreateKgEntity

批量创建知识图谱实体记录。

1级

基础版

ExecKgGremlin

执行自定义Cypher查询。

/

基础版

GetKgAuthorizedWorkspaces

获取有授权知识图谱的工作空间列表。

/

基础版

SearchKgBySemantic

通过语义检索获取知识图谱实体或关系记录。

/

基础版

CreateKgRelation

创建知识图谱关系记录。

1级

基础版

UpdateKgRelation

编辑知识图谱关系记录。

1级

基础版

DeleteKgRelation

删除关系记录。

1级

基础版

GetKgRelation

获取知识图谱关系记录详情。

3级

基础版

ListKgRelation

分页查询知识图谱关系记录。

3级

基础版

BatchCreateKgRelation

批量创建知识图谱关系记录。

1级

基础版

ExecKgCypher

执行自定义Cypher查询。

2级

基础版

GetKgNeighbor

获取图谱模型邻居节点。

3级

基础版