OpenAPI列表_智能数据建设与治理 Dataphin(Dataphin)-阿里云帮助中心

OpenAPI能够提供灵活多样的功能，是所有模块都要提供的标准能力，需购买对应功能模块的OpenAPI后方可使用。本文为您介绍OpenAPI支持的功能。

运维

通过该API模块，用户可以构建个性化的运维工具，通过API可以完成节点及实例的相关操作，同时可以获取Dataphin的告警事件及告警消息。

说明

目前开放的API主要针对离线脚本任务和管道集成任务。规范建模相关的任务运维的API暂未开放。

API	API说明
实例运维
GetInstanceDownstream	根据起始的实例查询该实例的下游。
GetPhysicalInstanceLog	获取实例执行的日志，如果实例重跑了多次，则会有多条日志。
GetScriptInstance	查询脚本的实例信息，包括实例状态，运行时间等信息。
InstanceFixData	重跑下游（修复链路数据），支持强制重跑下游影响范围：会产生计算成本。会影响数据产出。
ListNormalInstance	根据节点ID、环境（开发/生产）获取节点实例的列表，包括周期实例、手动实例。
OperateBatchInstance	批量运维实例，支持物理实例和逻辑表实例（从版本295-2开始支持）。重跑/重跑下游会进行数据重刷：影响历史数据。重跑/重跑下游会造成计算的费用以及存储的费用。暂停危险操作，可能造成实例无法调度，请谨慎操作。实例支持的运维操作有： RERUN重跑，会重刷节点当前业务日期的数据。 PAUSE暂停，实例暂停后，如果下游未运行，则下游也会连带被挂起不能调度。 RESUME恢复调度，与暂停为相反操作，恢复后，当满足调度条件时实例会被调度运行。 TERMINATE终止调度，实例终止调度后，不会被调度运行，如果下游未运行，则下游也会连带被挂起调度。 SET_SUCCESS置为成功，会影响下游调度，主要用于用户手动刷数据后强制更新实例调度状态，使下游可以被调度运行。重跑下游操作请使用InstanceFixData。
OperateInstance	(推荐使用新接口OperateBatchInstanceRequest) 对实例进行运维操作，可操作的命令包含： RERUN重跑，只有成功或失败的实例才可重跑，重跑后数据会被重新发送，且会产生资源使用费用。 PAUSE暂停，实例暂停后，如果下游未运行，则下游也会连带被挂起调度。 RESUME恢复调度，暂停状态的实例才可恢复，与暂停是相反操作，恢复后，当满足调度条件时实例会被调度运行。 TERMINATE终止调度，实例终止调度后，不会被调度运行，如果下游未运行，则下游也会连带被挂起调度。 SET_SUCCESS置为成功，会影响下游调度，主要用于用户手动刷数据后强制更新实例调度状态，使下游可以被调度运行。 RERUN_DOWNSTREAM重跑下游，会重刷实例及选中下游实例当前业务日期的数据。其中重跑及重跑下游会产生运行任务的额外费用。
任务运维
ListSupplementDagrun	根据查询条件列出补数据工作流下的每一个业务日期对应的DagRun信息。
ListSupplementInstance	列出补数据工作流下具体一个业务日期的所有节点的实例。
QueryInstanceUpDownStream	查询实例的上下游，支持逻辑表和代码任务（从版本295-2开始支持）。
NodeSupplementCommand	补数据请求参数。
CreateNodeSupplement	通用补数据接口（从版本295-2开始支持）。会生成补数据实例运行：影响相关产出表数据。会进行任务运行：造成计算的费用以及存储的费用。
CreatePhysicalNodeSupplement	创建物理节点补数据（物理节点），推荐使用CreateNodeSupplement。会进行数据回刷：影响历史数据。会进行节点的数据回刷，造成计算的费用以及存储的费用。
GetPhysicalNode	查询物理调度节点。
GetPhysicalNodeByOutput	根据输出名查询物理节点。仅支持离线代码节点及集成任务节点。
GetPhysicalNodeContent	查询调度节点代码内容。
GetPhysicalNodeOperationLog	查询节点的操作日志。
ListDevDependency	查询开发态任务配置的上游依赖。
ListNodes	查询调度节点列表。
PausePhysicalNode	暂停物理节点调度（危险操作），会暂停任务的调度，下游任务将无法调动，暂时仅支持离线代码任务及集成任务。
QueryDagFromPhysicalNode	查询节点上下游（从物理节点出发）。
QueryNodeUpDownStream	通用查询上下游接口（从版本295-2开始支持）。
QueryOperationSubmitStatus	海量模式补数据之后，查询补数据提交的状态（从版本295-2开始支持）。
ResumePhysicalNode	恢复物理节点调度，暂时仅支持离线代码任务及集成任务。
RunManualNode	运行手工节点（从版本295-2开始支持）。会生成手工调度节点：影响相关表。会进行任务运行，造成计算的费用以及存储费用。
RunTriggerNode	运行触发式节点。
SearchSupplementDownStream	查询补数据下游（从版本295-2开始支持）。支持多节点。支持逻辑表字段。
GetJobInfo	查询实时作业的信息。
SyncEngineJobGraph	支持弹内dlab平台把影子链路任务参数，同步到Dataphin任务中。说明该API只有弹内dlab能发起调用。
告警消息
GetAlertEvent	获取告警事件详情。
QueryAlertEvents	根据条件查询多个告警事件。
QueryAlertNotifications	根据条件查询多个推送记录。

研发

通过该API模块，用户可将Dataphin研发平台的部分能力集成到其他系统中。该API模块主要提供了离线脚本任务和管道集成任务的查询、创建、修改和删除的能力，也提供了上传和管理资源、创建及管理UDF的能力。基于这些能力，用户可以定制化的开发数据集成的工具，以及轻度的自助取数和即席查询的能力。

说明

OpenAPI不提供规范建模的能力。

API	API说明
数据架构
CreateBusinessEntity	创建业务实体，包括业务对象和业务活动。
DeleteBusinessEntity	删除业务实体，支持批量删除统一类型的业务实体，删除时需指定业务实体类型，支持的业务实体类型：业务对象、业务活动。
DescribeBusinessEntity	查询业务实体的详情，包括业务对象和业务活动。
DescribeBusinessEntityByVersion	查询业务实体的版本详情，包括业务对象和业务活动。
ListBusinessEntities	以平铺的方式分页查询业务实体列表。可以根据数据板块ID及名称、主题域ID及名称、业务实体细分类型、负责人ID、实例化状态、业务实体状态以及业务实体名称进行模糊搜索；若不设置搜索条件，将在租户范围下查询业务实体列表。
OfflineBusinessEntity	下线业务实体，支持批量下线同一类型的业务实体，下线时指定业务实体类型，支持的业务实体类型：业务对象、业务活动。
SubmitBusinessEntity	上线业务实体，支持批量上线同一类型的业务实体，上线时指定业务实体类型，支持的业务实体类型：业务对象、业务活动。
UpdateBusinessEntity	更新业务实体，包括业务对象和业务活动。
CreateBizUnit	创建数据板块。
CreateDataDomain	创建主题域。
DeleteBizUnit	删除数据板块，如果数据板块下已关联项目、主题域、业务限定、原子指标、派生指标、事实逻辑表、维度逻辑表、汇总表等，则不可删除。
DeleteDataDomain	删除主题域，如果主题域有下级主题域或业务实体等对象则不可删除。
DescribeBizUnit	根据数据板块ID获取板块信息。
DescribeDataDomain	查看主题域信息。
ListBizUnits	获取当前租户下的所有数据板块。
ListDataDomains	获取主题域列表，可根据数据板块ID、上级主题域ID、主题域名称、编码、描述进行搜索。
UpdateBizUnit	更新数据板块。
UpdateDataDomain	更新主题域。
公共定义
UpdateGlobalVariable	编辑全局变量。目前支持普通变量、账号密码全局变量编辑。
即席查询文件
CreateAdHocFile	创建即席查询文件。
CreateAdHocFileNew	创建即席查询文件。
CreateFolder	创建菜单树目录，支持计算任务、数据集成、同步任务等功能。
DeleteAdHocFile	删除即席查询文件。
DeleteFolder	删除菜单树目录。
GetAdHocFile	查询即席查询文件。
ListFiles	查询菜单树目录文件。
MoveFile	移动菜单树文件位置。
RenameFile	重命名菜单树文件。
UpdateAdHocFile	更新即席查询文件。
UpdateAdHocFileNew	更新即席查询文件。
建模研发公共
QueryObjectVersionListById	获取建模研发对象的版本信息列表，目前支持查原子指标、业务限定、派生指标的版本信息列表。
业务限定
ListBizCondition	分页查询业务限定列表信息，若不设置搜索条件，将默认查询指定项目下的业务限定。
QueryBizConditionById	获取业务限定数据信息。
QueryBizConditionVerDetailById	获取业务限定版本的详情。
QueryHomoBizConditionById	获取同源业务限定数据信息，同源指来源于同一个逻辑表的业务限定。一个业务限定可配置三个不同时效的计算逻辑，因此可能来源于三个不同时效的逻辑表。
指标
GetLogicalDefinitionSubTree	获取建模研发规范定义对象的导航树结构，包含原子指标、业务限定、派生指标的导航树结构。
ListAtomicIndex	分页查询原子指标列表信息，若不设置搜索条件，将默认查询指定项目下的所有原生原子指标、衍生原子指标。
ListDerivedIndex	分页查询派生指标列表，若不设置搜索条件，将默认查询指定项目下所有的派生指标、衍生指标和注册上挂指标。
QueryAtomicIndexById	获取原子指标数据信息。
QueryAtomicIndexVerDetailById	获取原子指标版本详情。
QueryDerivedIndexById	获取派生指标数据信息。
QueryDerivedIndexVerDetailById	查询派生指标版本详情。
QueryHomoAtomicIndexById	获取同源原子指标数据信息，同源指来源于同一个逻辑表的原子指标，一个原子指标可配置三个不同时效的计算逻辑，因此可来源于三个不同时效的逻辑表。
逻辑表
GetLogicalModelSubTree	获取逻辑表对象的导航树结构。
QueryDimTableById	查询维度逻辑表详情。
QueryFactTableById	查询事实逻辑表详情。
QueryGranularityBySummaryId	查询汇总逻辑表统计粒度相关的维度信息。
离线代码任务
CancelTask	终止任务（从版本3.5.3开始支持），该接口幂等，如果该任务已被关闭，则正常返回。
CloseJdbcConnection	关闭JDBC链接（从版本3.5.3开始支持）。
CreateBatchTaskFile	创建离线计算任务。
CreateJdbcConnection	创建JDBC链接（从版本3.5.3开始支持）。
DeleteBatchTaskFile	删除离线计算任务之前需先下线任务。
ExecSqlByJdbc	通过JDBC方式执行SQL（从版本3.5.1开始支持）。
ExecTask	执行即席查询任务。
FetchSqlResult	获取SQL执行结果（从版本3.5.3开始支持）。待任务执行成功后，可通过该接口查询任务的执行结果。如果任务还未执行结束或者执行失败，该接口返回数据为空。
GetBatchTaskFile	查询离线计算任务详情。
GetBatchTaskFileByVersion	查询离线计算任务版本详情。
GetLineages	查询任务的自定义血缘信息。
KillTask	终止即席查询任务。
ListBatchTaskFileVersions	查询离线计算任务的历史版本。
OfflineBatchTaskFile	下线离线计算任务。
ParseDependency	解析离线计算任务的逻辑表依赖。注意解析结果上游依赖信息中可能包含自依赖节点（上游节点ID和解析代码的任务节点ID相同），需要用户自己进行处理。
QuerySqlTaskStatus	获取SQL任务状态（从版本3.5.1开始支持）。
QueryTaskLog	获取即席查询的任务运行日志。
QueryTaskResult	获取即席查询的任务运行结果。
SaveLineages	任务保存自定义血缘。
SubmitBatchTaskFile	提交离线计算任务。
SubmitBatchTaskFileV2	提交离线计算任务。可替代SubmitBatchTaskFile接口的使用。SubmitBatchTaskFileV2接口与SubmitBatchTaskFile接口的区别： SubmitBatchTaskFileV2接口在任务提交成功后，会同时返回待发布对象ID。
UpdateBatchTaskFile	更新离线计算任务。
管道
PipelineAsyncExeResult	异步执行状态及结果。
FileInfo	管道存放的文件信息。
HopCommand	管道边的配置。
NodeRelationInternal	调度依赖配置。
PipelineCommand	管道配置。
PipelineObject	管道对象。
PipelineSettings	任务通道配置。
PipelineTreeNodeBriefDTO	简要管道目录树信息。
QueryPipelineDirectoryTreeCommand	查询管道目录树。
ScheduleCommand	管道调度配置。
StepCommand	管道的步骤配置。
AsyncCreatePipeline	异步一键式创建管道。
CreatePipeline	创建管道任务。
GetAsyncExeResult	查询异步执行状态及结果。
GetPipeline	查询管道任务详情。
GetPipelineByVersion	查看管道任务版本详情。
ListAsyncExeResult	批量查询异步执行状态及结果。
ListPipeline	批量查询管道任务。
ListPipelineDirectoryTree	批量查询集成目录列表。
OfflineAndDeletePipeline	下线管道，可删除管道，删除后无法找回。
OfflinePipeline	下线管道任务。
SubmitPipeline	提交管道任务。
UpdatePipeline	更新管道任务。
组件（接口）
ADB for MySQl 2.0	输出组件。
ADB for MySQl 3.0	输入与输出组件。
ADB for PostgreSQL	输入与输出组件。
Column	请使用内置的Builder进行构造。
ColumnCalculation	字段计算组件。
ColumnFilter	过滤组件。
ColumnMapping	请使用内置的Builder进行构造。
ColumnSelection	字段选择组件。
ConditedDistribution	条件分发组件。
IBM DB2	输入与输出组件。
HBase	输入与输出组件。
Hive	输入与输出组件。
LogicTable	逻辑表输入组件。
MaxCompute	输入与输出组件。
MySQL	输入与输出组件。
OSS	输入与输出组件。
OceanBase	输入与输出组件。
Oracle	输入与输出组件。
PolarDB	输入与输出组件。
PolarDB-X【原DRDS】	输入与输出组件。
PostgreSQL	输入与输出组件。
SpeedLimit	限速组件。
SQL Server	输入与输出组件。
Tera Data	输入与输出组件。
Vertica	输入与输出组件。
发布
GetLatestSubmitDetail	获取最新的待发布记录详情，获取的是数据处理、管道对象、资产分离的某一任务的待发布记录详情。说明该API只适用于DEV-PROD模式项目。
ListObjectsToPublish	待发布记录列表，数据处理、管道对象、资产分离的任务的待发布记录列表。说明该API只适用于DEV-PROD模式项目。
ListPublishingHistory	发布记录列表，数据处理、管道对象、资产分离的任务的发布记录列表。说明该API只适用于DEV-PROD模式项目。
PublishObject	发布对象，数据处理、管道对象、资产分离的任务的发布接口，从待发布列表ListObjectsToPublish（待发布记录列表）中获取待发布ID。说明该API仅适用于DEV-PROD模式项目。该API内部实现为异步调用发布，只有返回数据中的校验状态为通过的数据（即`SubmitPublishResult.status=true`），才会进入异步发布流程，每次发布结束之后会生成发布记录，发布的结果需要从ListPublishingHistory（发布记录列表）中获取。该API仅支持项目开发者（PROJECT_DEVELOPER）和项目运营者（PROJECT_OPS）发布调用。
资源
CreateResource	创建资源。说明资源文件上传依赖GetResourceStorageCredential接口，如果使用环境不满足文件上传要求，需要通过Dataphin平台上传并创建资源。
DeleteResource	删除资源。
GetGlobalResourceStorageCredential	获取上传资源文件的存储配置。说明该接口支持获取文件上传凭证，之后需要使用凭证完成文件上传。支持OSS、Ceph对象存储。
GetResource	获取资源详情。
GetResourceByVersion	查询开发环境（Basic项目为生产环境）资源版本详情。
GetResourceStorageCredential	获取上传资源文件的存储配置，用于调用OSS SDK上传文件。说明该接口支持获取文件上传凭证，之后需要使用凭证完成文件上传。支持OSS、Ceph对象存储。
UpdateResource	更新资源。
函数
CreateUdf	创建自定义函数。
DeleteUdf	删除自定义函数。
GetUdf	查询自定义函数详情。
GetUdfByVersion	查询自定义函数版本详情。
UpdateUdf	更新自定义函数。

标签工厂

通过该API模块，用户可以查询Dataphin的标签群组信息。

API	API说明
BindGroupToApp	绑定群组到应用。
CreateGroupByImport	导入群组。
CreateGroupPageQuery	创建群组分页查询。说明该API只有超级管理员（SuperAdmin）和系统管理员能调用。
DeleteGroup	删除群组。
DeleteGroupPage	删除群组分页服务。
DeleteGroupVersion	删除群组版本。
EditGroupPageQuery	群组分页查询编辑。
GetComputeSourceFileStorageCredentials	获取计算源文件配置文件上传凭证，可用于上传配置文件。
GetGroupPageApiCode	获取群组分页查询调用服务调用代码。
GetOnlineClusterById	根据群组ID获取群组详情。
GetOnlineFeatureById	根据标签ID获取标签详情。
ListOnlineFeatures	获取已上架标签列表。
ListApplyFeaturesInProject	获取当前项目内已申请的标签列表。
ListApps	获取应用列表。（3.14.1新增）
ListFeaturesInProject	获取当前项目内开发的标签列表。
ListGroupPageSubscription	获取已发布的群组分页查询服务列表。
ListGroupsInApp	应用中查询已申请群组列表。（3.14.1新增）
ListOnlineClusters	获取已上架群组列表。
ListTagsInApp	应用中查询已申请标签列表。（3.14.1新增）
ListingGroup	上架群组市场。
OfflineGroup	下线群组。
OfflineGroupPage	下线群组分页服务。
OnlineGroupPageQuery	发布的群组分页查询。说明该API只有超级管理员（SuperAdmin）和系统管理员能够调用。
PublishAndOnlineGroup	发布并上架群组版本。
PublishGroup	发布群组版本。
QueryGroupStatus	获取群组状态。
QueryGroupVersionStatus	获取群组版本状态。
QuerySubscriptionStatus	获取群组离线服务状态。
RevokeGroup	撤回群组。
SaveGroup	第一次创建群组。
SaveGroupVersion	新建群组版本。
SubmitGroupVersion	提交群组版本。
SupplementGroupData	对群组补数据。
SupplementGroupPageData	群组分页查询服务补数据。
UnlistingGroup	下架群组（免审批）。

资产

通过该API模块，用户可以查询Dataphin的资产元数据信息。包括查询物理表与逻辑表的字段及分区，以及查询表的血缘。

API	API说明
元数据
GetTableColumnLineage	查询字段血缘信息。
GetTableLineage	查询表血缘信息。
ListCatalogTableColumns	查询资产表的列。
ListLogicTableColumns	查询逻辑表的列。
ListRealtimeTableColumns	查询实时元表的列。
ListTableColumns	查询物理表的列。
ListTablePartitions	查询物理分区数据。
ListTables	查询表元数据。
QueryLogicTable	查询逻辑表详情。
QueryRealtimeTable	查询实时元表详情。
QueryTable	查询物理表接口。
QueryTableLineage	[已过时]-查询字段血缘关系（暂不支持实时表）。建议使用新的接口：GetTableColumnLineage。
RegisterAssetMetaData	注册新的资产类型的元数据。
ReportAsset	上报资产到Dataphin。
数据标准
CancelInvalidMappingRelation	取消无效映射关系。说明当前方法是后台异步执行的，执行结果需要通过查询无效映射的接口进行确认, 或者在页面上查看操作历史和结果详情。
CancelValidMappingRelation	解除有效映射关系。说明当前方法是后台异步执行的，执行结果需要通过查询无效映射的接口进行确认，或者在页面上查看操作历史和结果详情。
ChangeValidMappingRelationToInvalid	将有效映射关系置为无效映射关系。说明当前方法是后台异步执行的，执行结果需要通过查询无效映射的接口进行确认，或者在页面上查看操作历史和结果详情。
CreateLookupTable	创建码表。
CreateMappingRelations	创建映射关系（包括有效映射和无效映射）。
CreateStandard	创建标准。
CreateStandardRelations	创建标准关联关系。
CreateStandardSet	创建标准集。
CreateStandardTemplate	创建标准模板。
CreateWordRoot	创建词根。
DeleteLookupTable	删除码表。
DeleteStandardRelations	删除标准关联关系。
DeleteStandardSet	删除标准集。
DeleteWordRoot	删除词根。
FuzzySearchStandard	根据符合查询条件分页查询满足条件的标准。
DeleteStandard	删除标准。
GetStandardStatisticsOfType	查询目录下按照标准类型统计的标准数目。
QueryLookupTable	查询码表。
QueryMappingRelationByAsset	根据资产对象查询映射关系。
QueryMappingRelationByBelongAsset	根据归属资产查询映射关系。
QueryStandard	根据标准ID查询指定版本、指定状态的数据标准。
QueryStandardSet	根据标准集ID查询标准集。
QueryStandardTemplate	根据标准模板ID查询标准模板。
QueryWordRoot	查询词根。
SubmitStandard	发布标准。
UnpublishStandard	将发布的标准下线。
UpdateLookupTable	更新码表。
UpdateStandard	更新标准。
UpdateStandardSet	更新标准集。
UpdateStandardTemplate	更新标准模板。
UpdateWordRoot	更新词根。
数据质量
AssignQualityRuleSchedules	将规则和调度设置进行绑定。
GetQualityAlert	通过监控对象ID获取告警设置。
GetQualityRule	通过ID获取质量规则对象。
GetQualityRuleTask	通过ID获取质量任务对象。
GetQualityRuleTaskLog	通过ID获取质量任务对象的日志内容。
GetQualitySchedule	通过ID获取质量调度对象。
GetQualityTemplate	通过ID获取质量模板对象。
GetQualityWatch	通过ID获取质量监控对象。
GetQualityWatchByObjectId	通过监控对象原始ID获取监控对象记录，例如：数据源、表、指标等的ID。
GetQualityWatchTask	通过ID获取监控任务对象。
GetQualityWatchTaskLog	通过ID获取监控任务对象的日志内容。
ListQualitySchedules	通过监控对象ID获取调度设置列表。
OpenCloseQualityRules	批量开启/关闭质量规则。
OpenCloseQualityWatches	批量开启关闭质量监控对象。
PagedQueryQualityRuleTasks	分页查询质量规则任务。
PagedQueryQualityRules	分页查询质量规则。
PagedQueryQualityTemplates	分页查询质量模板。
PagedQueryQualityWatchTasks	分页查询质量监控对象任务。
PagedQueryQualityWatches	分页查询质量监控对象。
RemoveQualityRuleSchedules	批量删除质量规则和调度的绑定关系。
RemoveQualityRules	批量删除质量规则对象。
RemoveQualitySchedules	批量删除质量调度对象。
RemoveQualityTemplates	批量删除质量模板对象。
RemoveQualityWatches	批量删除质量监控对象。
SaveQualityAlert	新建或修改监控对象告警设置。
SaveQualityRule	新建或修改质量规则。
SaveQualitySchedule	新建或修改调度设置。
SaveQualityTemplate	新建或修改质量模板。
SaveQualityWatch	添加质量监控对象支持添加多种类型的质量监控对象，包括：Dataphin表全域、表、数据源、指标、实时元表。说明添加Dataphin表和实时元表时，需要table和datasource两个参数必传，datasource的`dataSourceId`设置为1添加全域表时，datasource和table必传；添加数据源时，datasource必传；添加指标时，index必传。
SubmitQualityRuleTasks	批量提交规则任务，支持试跑。
SubmitQualityWatchTasks	批量提交监控对象校验任务。
数据安全
AddSecurityLabel	新建安全识别结果，能够选择覆盖模式，也能修改线上的安全识别结果。说明该API仅支持安全管理员或该表所在项目的管理员能够发起调用。
CreateClassifyCatalog	新建数据分类目录。拥有数据分类-管理权限的角色可以新建任意目录；一级目录的管理员仅可在该一级目录下新建目录。
CreateSecurityClassify	新建安全分类。
CreateSecurityLevel	新建安全分级。
GetSecretKeyByName	根据密钥名称查询密钥详情。
GetSecurityClassifyDetail	根据分类ID查询数据分类详情。
GetSecurityLabelById	通过识别结果ID获取识别结果对象。
GetSecurityLevelDetail	根据分级ID查询数据分级详情。
PagedQuerySecurityIdentifyRecordsOfField	分页查询安全识别结果的识别详情。
PagedQuerySecurityLabels	分页查询安全识别结果。
RemoveClassifyCatalog	删除数据分类目录。拥有数据分类-管理权限的自定义角色可以删除任意目录；一级目录的管理员仅可删除该一级目录及其子目录。
RemoveSecurityClassify	删除安全分类。
RemoveSecurityLabels	批量删除安全识别结果。说明该API仅支持安全管理员或该表所在的项目管理员能够发起调用。
RemoveSecurityLevel	删除安全分级。
UpdateClassifyCatalog	更新数据分类目录。拥有数据分类-管理权限的自定义角色可修改任意目录；一级目录的管理员仅可修改该一级目录及其子目录；涉及移动操作时，操作人需同时具备来源一级目录和目标一级目录的管理员权限。
UpdateSecurityClassify	更新安全分类。
UpdateSecurityLabelsEnableStatus	批量更新安全识别结果的生效状态。说明该API仅支持安全管理员或该表所在的项目管理员能够发起调用。
UpdateSecurityLabelsIdentifyRule	批量更新安全识别结果绑定的识别规则。说明该API仅支持安全管理员或该表所在的项目管理员能够发起调用。
UpdateSecurityLevel	更新安全分级。
数据服务
CreateDataServiceApi	创建新的数据服务API并提交。
PublishDataServiceApi	发布指定的API的版本到线上环境。
QueryApiDocumentRequest	API文档。
QueryApiLogPage	运维-服务调用日志查询-API调用日志查询。
QueryApiServiceGroup	查询API服务分组列表。
QueryApiServicePage	分页查询发布的API。
QueryErrorImpact	API常影响分析。
QueryIndicators	运维监控调用汇总统计。
QueryVisitTrend	运维监控访问趋势分析。
ApplyApi	API权限申请。
QueryApiAuthPage	查询当前用户有权限的API列表。
QueryApiGroup	查询当前项目的API分组列表。
QueryGroupApi	查询分组下的API列表。
QueryPrivateApp	查询账号有权限的应用列表。
ApplyApp	申请应用权限。
QueryAppAuthPage	查询当前用户有权限的应用列表。
QueryAppGroup	查询当前项目的应用分组列表。
QueryGroupApp	查询分组下应用列表。
ApplyDataSource	Dataphin数据源权限申请。
QueryDataSourceAppGroup	查询Dataphin数据源分组列表。
QueryDataSourceAuthPage	根据项目查询已申请权限的Dataphin数据源分页列表。
QueryDataSourceGroup	查询当前租户项目的分组。
QueryGroupDataSource	列出Dataphin数据源分组下的Dataphin数据源列表。
QueryLogicalTable	查询指定Dataphin数据源下的逻辑表。
QueryPhysicalTable	查询指定Dataphin数据源下的物理表。
QueryTableColumn	查询表Dataphin数据源的表字段。
AuthorizeApi	API授权。
QueryMyApiPage	API权限列表。
RecycleApi	API权限回收。
AuthorizeApp	应用授权。
GrantAppToUser	查询应用负责人。
ListAppAuthUser	应用有权限的用户列表。
QueryMyAppPage	查询自己有权限的应用。
RecycleApp	应用权限回收。
AuthorizeDataSource	申请Dataphin数据源应用授权。
QueryMyDataSourcePage	查询我有权限的数据源列表。
RecycleDataSource	Dataphin数据源权限回收。
ListManagerProject	当前登录用户作为负责人的项目下拉列表。
ListDataphinDsPermissions	判断当前账号的租户是否有数据服务（Dataphin）权限。
QueryDataSourceDocument	根据数据源ID查询数据源详情（Dataphin数据源文档）。
QueryDataSourceServicePage	查询Dataphin数据源的分页列表。
QueryApiImpactDetail	API影响分析列表。
QueryApiMonitor	查询API运维统计信息。
CreateProjectUser	添加项目用户并设置角色。
ListDataphinUser	查询当前租户项目的用户列表。
ListPrivilegedProject	查询有权限的项目列表。
QueryProjectPage	分页查询项目。
pageInfo	无。
ParseSql	翻译SQL。
SqlLegalityVerify	SQL校验与鉴权。

平台管理

通过平台管理相关的API，用户可以查询当前购买的产品的功能特性，创建及管理数据源、查询项目信息、管理项目成员，管理Dataphin的成员，以及给用户授权和回收数据源权限。

API	API说明
购买特性
ListFeatures	获取当前租户可用的特性列表。
项目管理
AddProjectMembers	添加项目成员API，支持添加项目Basic和DEV_PROD项目的项目成员。
DeleteProjectMembers	删除项目成员，支持删除项目Basic和DEV_PROD项目的项目成员。说明传入的`UserId`如果不是项目成员，API返回异常。仅支持项目管理员操作。
GetProject	根据项目ID和环境信息获取项目信息。
GetProjectByName	根据项目名称获取项目信息，查询开发环境项目时需要在项目名称后添加`_dev`后缀。
ListProjectByProjectType	根据项目类别筛选项目。
ListProjectMembers	根据项目ID和环境信息，获取项目成员列表。
ListProjects	根据项目类别筛选项目。
QueryProjectWhiteList	根据项目ID查询项目白名单。
UpdateProjectMembers	更新项目成员，支持更新项目Basic和DEV_PROD项目的项目成员。
数据源
CheckDataSourceConnectivity	检查数据源连通性。
CheckExistDataSourceConnectivity	检查已创建的数据源连通性。
CreateDataSource	创建数据源，支持单独创建生产环境数据源，同时创建开发、生产数据源，以及为生产环境数据源创建开发环境数据源三种模式。
DeleteDevProdModeDataSource	删除数据源，支持只删除开发环境中的数据源，或者同时删除开发、生产数据源，Dataphin系统目前不允许开发环境数据源单独存在。
ListDataSourceDependency	搜索数据源依赖，接口返回结果为list。
SearchDataSourceConfig	搜索数据源，结果分页返回，返回数据源结构为开发、生产成对组合。
UpdateDataSourceBasicInfo	更新数据源的基本信息，如名称、描述。
UpdateDataSourceConfiguration	更新数据源配置信息，如链接URL、用户名、密码等。
行级权限
ListRowPermission	分页获取当前租户下的所有行级权限信息（支持传GUID搜索表关联的行级权限）。
ListAccountByRowPermissionId	根据行级权限ID获取某一行级权限下的所有授权账号。
CreateRowPermission	新建行级权限。
DeleteRowPermission	根据行级权限ID删除行级权限。
UpdateRowPermissionBasicInfo	更新行级权限的基本信息。
AddControlRule	增加行级权限的管控规则。
UpdateControlRule	更新行级权限的管控规则。
DeleteControlRule	删除行级权限的管控规则。
AddAssociatedTable	新增行级权限的相关表。
DeleteAssociatedTable	删除行级权限的相关表。
ListRowPermissionByUserId	查询指定用户有权限的行级权限。
计算源
CheckComputeSourceConnectivity	检查计算源配置的连通性。
CheckComputeSourceConnectivityById	根据项目ID检查项目连通性。
CreateComputeSource	创建计算源。
DeleteComputeSource	删除计算源。
GetComputeSource	根据计算源ID获取计算源信息。
GetComputeSourceFileCredentials	获取计算源文件配置文件上传凭证，可用于上传配置文件。
QueryComputeSource	计算源批量查询。
SetTenantComputeEngine	设置租户计算引擎。
UpdateComputeSourceRequest	更新计算源。
用户与授权
AddUser	给租户添加用户。说明该API仅支持超级管理员（SuperAdmin）发起调用。
BatchAddTenantMember	批量添加用户至租户。说明该API仅支持超级管理员（SuperAdmin）和系统管理员调用。
BatchGetUsers	根据`UserId`批量获取用户信息。
BatchSyncUsers	同步租户成员信息。说明该API只有超级管理员（SuperAdmin）和系统管理员调用。
CheckResourcePermission	判断个人账号、生产账号是否有操作某一资源的权限。说明该API只有超级管理员（SuperAdmin）和系统管理员调用。
CreateUserGroup	新建用户组。
DeleteUserGroup	删除用户组。
GetDataSourceUserList	根据数据源ID查询拥有权限的用户。
GetOpsTenant	获取运维租户信息。说明该API仅支持超级管理员（SuperAdmin）发起调用。
GetPermissionChangeObjects	获取权限变化对象详情。
GetProjectProduceUser	获得项目生产账号。说明该API仅支持超级管理员（SuperAdmin）发起调用。
GetRoleListByUserId	获取某个用户所拥有的角色列表。
GetUserGroup	获取用户组详情。
GetUserInfoBySourceId	根据外部账号ID查询对应的Dataphin的用户信息。
GrantByResource	根据资源授权用户。说明该API仅支持超级管理员（SuperAdmin）和资源所有者（项目管理员、数据源管理员）发起调用，目前支持表、数据源。
GrantPermissionToDataSource	授予数据源多个用户多个行为权限（建议使用新API，GrantByResource）。
GrantRole	授予用户某个角色，该接口已作废，设置租户级别角色使用UpdateTenantMembers接口。说明该API仅支持超管（SuperAdmin）和项目管理员发起调用。
IsProductAdmin	判断当前用户是否是某个产品的超级管理员。
ListAddableRoles	成员可配置用户角色。
ListAssetPermissionAudit	分页获取权限操作审计列表信息。
ListPermissionChangeLog	游标获取权限变化记录。
ListPermissionOperationAudit	分页获取权限操作审计列表信息。
ListDepts	租户部门列表。
ListUserGroup	分页获取用户组信息。
ListUserGroupMember	分页获取用户组成员信息。
ListUsers	分页获取用户信息。
MineTenants	我的租户列表信息。
QueryPagedAddableUsers	查询租户可添加用户。说明该API仅支持超级管理员（SuperAdmin）和系统管理员调用。
QueryPagedDept	分页查询一级部门信息。
QueryPagedMembers	成员列表分页查询。
RemoveUser	给租户删除用户。说明该API仅支持超级管理员和系统管理员发起调用。
RevokeByResource	根据资源回收用户权限。说明该API仅支持超级管理员（SuperAdmin）和资源所有者（项目管理员、数据源管理员）发起调用，目前支持表、数据源。
RevokePermissionFromDataSource	用户数据源权限移除（建议使用新API，RevokeByResource）。说明该API仅支持超级管理员（SuperAdmin）发起调用。
UpdateTenantMemberStatus	更新租户成员启停状态。
UpdateTenantMembers	更新租户成员信息。说明该API仅支持超级管理员（SuperAdmin）和系统管理员调用。
UpdateUserGroup	更新用户组成员列表信息。
UpdateUserGroupSwitch	修改用户组的启用状态。
AddUserToUserGroup	添加用户到用户组。
RemoveUserFromUserGroup	从用户组中删除用户。
UpdateTenantMembersStatus	启停用某一用户。
ListTenantRolesByUserId	根据userid获取租户级别角色。
ListTenantRoles	获取当前租户下所有的租户角色（全局角色）。
Python三方包
ListPythonModule	Python三方包分页查询。