OpenAPI能夠提供靈活多樣的功能,是所有模塊都要提供的標準能力,需購買對應功能模塊的OpenAPI后方可使用。本文為您介紹OpenAPI支持的功能。
運維
通過該API模塊,用戶可以構建個性化的運維工具,通過API可以完成節點及實例的相關操作,同時可以獲取Dataphin的告警事件及告警消息。
目前開放的API主要針對離線腳本任務和管道集成任務。規范建模相關的任務運維的API暫未開放。
API | API說明 |
實例運維 | |
GetInstanceDownstream | 根據起始的實例查詢該實例的下游。 |
GetPhysicalInstanceLog | 獲取實例執行的日志,如果實例重跑了多次,則會有多條日志。 |
GetScriptInstance | 查詢腳本的實例信息,包括實例狀態,運行時間等信息。 |
InstanceFixData | 重跑下游(修復鏈路數據),支持強制重跑下游影響范圍:
|
ListNormalInstance | 根據節點ID、環境(開發/生產)獲取節點實例的列表,包括周期實例、手動實例。 |
OperateBatchInstance |
實例支持的運維操作有:
重跑下游操作請使用InstanceFixData。 |
OperateInstance | (推薦使用新接口OperateBatchInstanceRequest) 對實例進行運維操作,可操作的命令包含:
其中重跑及重跑下游會產生運行任務的額外費用。 |
任務運維 | |
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開始支持)。
|
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 | 更新主題域。 |
即席查詢文件 | |
CreateAdHocFile | 創建即席查詢文件。 |
CreateFolder | 創建菜單樹目錄,支持計算任務、數據集成、同步任務等功能。 |
DeleteAdHocFile | 刪除即席查詢文件。 |
DeleteFolder | 刪除菜單樹目錄。 |
GetAdHocFile | 查詢即席查詢文件。 |
ListFiles | 查詢菜單樹目錄文件。 |
MoveFile | 移動菜單樹文件位置。 |
RenameFile | 重命名菜單樹文件。 |
UpdateAdHocFile | 更新即席查詢文件。 |
建模研發公共 | |
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.3開始支持)。 |
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。 說明
|
資源 | |
CreateResource | 創建資源。 說明 資源文件上傳依賴GetResourceStorageCredential接口,如果使用環境不滿足文件上傳要求,需要通過Dataphin平臺上傳并創建資源。 |
DeleteResource | 刪除資源。 |
GetGlobalResourceStorageCredential | 獲取上傳資源文件的存儲配置。 說明
|
GetResource | 獲取資源詳情。 |
GetResourceByVersion | 查詢資源版本詳情。 |
GetResourceStorageCredential | 獲取上傳資源文件的存儲配置,用于調用OSS SDK上傳文件。 說明
|
UpdateResource | 更新資源。 |
函數 | |
CreateUdf | 創建自定義函數。 |
DeleteUdf | 刪除自定義函數。 |
GetUdf | 查詢自定義函數詳情。 |
GetUdfByVersion | 查詢自定義函數版本詳情。 |
UpdateUdf | 更新自定義函數。 |
標簽工廠
通過該API模塊,用戶可以查詢Dataphin的標簽群組信息。
API | API說明 |
BindGroupToApp | 綁定群組到應用。 |
CreateGroupPageQuery | 創建群組分頁查詢。 說明 該API只有超級管理員(SuperAdmin)和系統管理員能調用。 |
DeleteGroup | 刪除群組。 |
DeleteGroupVersion | 刪除群組版本。 |
GetOnlineClusterById | 根據群組ID獲取群組詳情。 |
GetOnlineFeatureById | 根據標簽ID獲取標簽詳情。 |
ListOnlineFeatures | 獲取已上架標簽列表。 |
ListApplyFeaturesInProject | 獲取當前項目內已申請的標簽列表。 |
ListApps | 獲取應用列表。(3.14.1新增) |
ListFeaturesInProject | 獲取當前項目內開發的標簽列表。 |
ListGroupsInApp | 應用中查詢已申請群組列表。(3.14.1新增) |
ListOnlineClusters | 獲取已上架群組列表。 |
應用中查詢已申請標簽列表。(3.14.1新增) | |
ListingGroup | 上架群組市場。 |
OfflineGroup | 下線群組。 |
OnlineGroupPageQuery | 發布的群組分頁查詢。 說明 該API只有超級管理員(SuperAdmin)和系統管理員能夠調用。 |
PublishAndOnlineGroup | 發布并上架群組版本。 |
PublishGroup | 發布群組版本。 |
QueryGroupStatus | 獲取群組狀態。 |
QueryGroupVersionStatus | 獲取群組版本狀態。 |
QuerySubscriptionStatus | 獲取群組離線服務狀態。 |
RevokeGroup | 撤回群組。 |
SaveGroup | 第一次創建群組。 |
SaveGroupVersion | 新建群組版本。 |
SubmitGroupVersion | 提交群組版本。 |
SupplementGroupData | 對群組補數據。 |
UnlistingGroup | 下架群組(免審批)。 |
資產
通過該API模塊,用戶可以查詢Dataphin的資產元數據信息。包括查詢物理表與邏輯表的字段及分區,以及查詢表的血緣。
API | API說明 |
元數據 | |
GetTableColumnLineage | 查詢字段血緣信息。 |
GetTableLineage | 查詢表血緣信息。 |
ListCatalogTableColumns | 查詢資產表的列。 |
ListLogicTableColumns | 查詢邏輯表的列。 |
ListRealtimeTableColumns | 查詢實時元表的列。 |
ListTableColumns | 查詢物理表的列。 |
ListTablePartitions | 查詢物理分區數據。 |
ListTables | 查詢表元數據。 |
QueryLogicTable | 查詢邏輯表詳情。 |
QueryRealtimeTable | 查詢實時元表詳情。 |
QueryTable | 查詢物理表接口。 |
QueryTableLineage | [已過時]-查詢字段血緣關系(暫不支持實時表)。 建議使用新的接口:GetTableColumnLineage。 |
RegisterAssetMetaData | 注冊新的資產類型的元數據。 |
ReportAsset | 上報資產到Dataphin。 |
SearchCatalogTable | 查詢資產表元數據。 |
數據標準 | |
CreateLookupTable | 創建碼表。 |
CreateStandard | 創建標準。 |
CreateStandardRelations | 創建標準關聯關系。 |
CreateStandardSet | 創建標準集。 |
CreateStandardTemplate | 創建標準模板。 |
CreateWordRoot | 創建詞根。 |
DeleteStandardRelations | 刪除標準關聯關系。 |
FuzzySearchStandard | 根據符合查詢條件分頁查詢滿足條件的標準。 |
GetStandardStatisticsOfType | 查詢目錄下按照標準類型統計的標準數目。 |
QueryLookupTable | 查詢碼表。 |
QueryMappingRelationByAsset | 根據資產對象查詢映射關系。 |
QueryMappingRelationByBelongAsset | 根據歸屬資產查詢映射關系。 |
QueryStandard | 根據標準ID查詢指定版本、指定狀態的數據標準。 |
QueryStandardSet | 根據標準集ID查詢標準集。 |
QueryStandardTemplate | 根據標準模板ID查詢標準模板。 |
QueryWordRoot | 查詢詞根。 |
SubmitStandard | 發布標準。 |
UpdateLookupTable | 更新碼表。 |
UpdateStandard | 更新標準。 |
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的 |
SubmitQualityRuleTasks | 批量提交規則任務,支持試跑。 |
SubmitQualityWatchTasks | 批量提交監控對象校驗任務。 |
數據安全 | |
AddSecurityLabel | 新建安全識別結果,能夠選擇覆蓋模式時也能修改線上的安全識別結果。 說明 該API僅支持安全管理員或該表所在的項目管理員能夠發起調用。 |
GetSecretKeyByName | 根據密鑰名稱查詢密鑰詳情。 |
GetSecurityClassifyDetail | 根據分類ID查詢數據分類詳情 。 |
GetSecurityLabelById | 通過識別結果ID獲取識別結果對象。 |
GetSecurityLevelDetail | 根據分級ID查詢數據分級詳情。 |
PagedQuerySecurityIdentifyRecordsOfField | 分頁查詢安全識別結果的識別詳情。 |
PagedQuerySecurityLabels | 分頁查詢安全識別結果。 |
RemoveSecurityLabels | 批量刪除安全識別結果。 說明 該API僅支持安全管理員或該表所在的項目管理員能夠發起調用。 |
UpdateSecurityLabelsEnableStatus | 批量更新安全識別結果的生效狀態。 說明 該API僅支持安全管理員或該表所在的項目管理員能夠發起調用。 |
UpdateSecurityLabelsIdentifyRule | 批量更新安全識別結果綁定的識別規則。 說明 該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項目的項目成員。 說明
|
GetProject | 根據項目ID和環境信息獲取項目信息。 |
GetProjectByName | 根據項目名稱獲取項目信息,查詢開發環境項目時需要在項目名稱后添加 |
ListProjectByProjectType | 根據項目類別篩選項目。 |
ListProjectMembers | 根據項目ID和環境信息,獲取項目成員列表。 |
ListProjects | 根據項目類別篩選項目。 |
QueryProjectWhiteList | 根據項目ID查詢項目白名單。 |
UpdateProjectMembers | 更新項目成員,支持更新項目Basic和DEV_PROD項目的項目成員。 |
數據源 | |
CheckDataSourceConnectivity | 檢查數據源連通性。 |
CheckExistDataSourceConnectivity | 檢查已創建的數據源連通性。 |
CreateDataSource | 創建數據源,支持單獨創建生產環境數據源,同時創建開發、生產數據源,為生產環境數據源創建開發環境數據源三種模式。 |
DeleteDevProdModeDataSource | 刪除數據源,支持只刪除開發環境中的數據源,或者同時刪除開發、生產數據源,Dataphin系統目前不允許開發環境數據源單獨存在。 |
SearchDataSourceConfig | 搜索數據源,結果分頁返回,返回數據源結構為開發、生產成對組合。 |
UpdateDataSourceBasicInfo | 更新數據源的基本信息,如名稱、描述。 |
UpdateDataSourceConfiguration | 更新數據源配置信息,如鏈接URL、用戶名、密碼等。 |
計算源 | |
CheckComputeSourceConnectivity | 檢查計算源配置的連通性。 |
CheckComputeSourceConnectivityById | 根據項目ID檢查項目連通性。 |
CreateComputeSource | 創建計算源。 |
DeleteComputeSource | 刪除計算源。 |
GetComputeSource | 根據計算源ID獲取計算源信息。 |
GetComputeSourceFileCredentials | 獲取計算源文件配置文件上傳憑證,可用于上傳配置文件。 |
QueryComputeSource | 計算源批量查詢。 |
SetTenantComputeEngine | 設置租戶計算引擎。 |
UpdateComputeSourceRequest | 更新計算源。 |
用戶與授權 | |
AddUser | 給租戶添加用戶。 說明 該API僅支持超級管理員(SuperAdmin)發起調用。 |
BatchAddTenantMember | 批量添加用戶至租戶。 說明 該API僅支持超級管理員(SuperAdmin)和系統管理員調用。 |
BatchGetUsers | 根據 |
BatchSyncUsers | 同步租戶成員信息。 說明 該API只有超級管理員(SuperAdmin)和系統管理員調用。 |
CheckResourcePermission | 判斷個人賬號、生產賬號是否有操作某一資源的權限。 說明 該API只有超級管理員(SuperAdmin)和系統管理員調用。 |
CreateUserGroup | 新建用戶組。 |
DeleteUserGroup | 刪除用戶組。 |
GetDataSourceUserList | 根據數據源ID查詢擁有權限的用戶。 |
GetOpsTenant | 獲取運維租戶信息。 說明 該API僅支持超級管理員(SuperAdmin)發起調用。 |
GetProjectProduceUser | 獲得項目生產賬號。 說明 該API僅支持超級管理員(SuperAdmin)發起調用。 |
GetRoleListByUserId | 獲取某個用戶所擁有的角色列表。 |
GetUserGroup | 獲取用戶組詳情。 |
GetUserInfoBySourceId | 根據外部賬號ID查詢對應的Dataphin的用戶信息。 |
GrantByResource | 根據資源授權用戶。 說明 該API僅支持超級管理員(SuperAdmin)和資源所有者(項目管理員、數據源管理員)發起調用,目前支持表、數據源。 |
GrantPermissionToDataSource | 授予數據源多個用戶多個行為權限(建議使用新API,GrantByResource)。 |
GrantRole | 授予用戶某個角色,該接口已作廢,設置租戶級別角色使用UpdateTenantMembers接口。 說明 該API僅支持超管(SuperAdmin)和項目管理員發起調用。 |
IsProductAdmin | 判斷當前用戶是否是某個產品的超級管理員。 |
ListAddableRoles | 成員可配置用戶角色。 |
ListAssetPermissionAudit | 分頁獲取權限操作審計列表信息。 |
ListPermissionOperationAudit | 分頁獲取權限操作審計列表信息。 |
ListDepts | 租戶部門列表 。 |
ListUserGroup | 分頁獲取用戶組信息。 |
ListUserGroupMember | 分頁獲取用戶組成員信息。 |
ListUsers | 分頁獲取用戶信息。 |
MineTenants | 我的租戶列表信息。 |
QueryPagedAddableUsers | 查詢租戶可添加用戶。 說明 該API僅支持超級管理員(SuperAdmin)和系統管理員調用。 |
QueryPagedDept | 分頁查詢一級部門信息。 |
QueryPagedMembers | 成員列表分頁查詢。 |
RemoveUser | 給租戶刪除用戶。 說明 該API僅支持超級管理員和系統管理員發起調用。 |
RevokeByResource | 根據資源回收用戶權限。 說明 該API僅支持超級管理員(SuperAdmin)和資源所有者(項目管理員、數據源管理員)發起調用,目前支持表、數據源。 |
RevokePermissionFromDataSource | 用戶數據源權限移除(建議使用新API,RevokeByResource)。 說明 該API僅支持超級管理員(SuperAdmin)發起調用。 |
UpdateTenantMembers | 更新租戶成員信息。 說明 該API僅支持超級管理員(SuperAdmin)和系統管理員調用。 |
UpdateUserGroup | 更新用戶組成員列表信息。 |
UpdateUserGroupSwitch | 修改用戶組的啟用狀態。 |
AddUserToUserGroup | 添加用戶到用戶組。 |
RemoveUserFromUserGroup | 從用戶組中刪除用戶。 |
UpdateTenantMembersStatus | 啟停用某一用戶。 |
ListTenantRolesByUserId | 獲取某一用戶的租戶角色(全局角色)。 |
ListTenantRoles | 獲取當前租戶下所有的租戶角色(全局角色)。 |