全量API介面分類參考列表-巨量資料開發治理平台 DataWorks-阿里雲 - DataWorks

API標準及多語言預置SDK

本產品（dataworks-public/2020-05-18）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

租戶

API	標題	API概述
AddProjectMemberToRole	添加工作空間使用者至角色	該介面用於添加DataWorks工作空間使用者至角色。使用該介面前，您需要先添加目標帳號為DataWorks工作空間的成員。
RemoveProjectMemberFromRole	將工作空間內使用者從角色中移除	該介面用於將DataWorks工作空間內的使用者從DataWorks角色中移除。
ListProjectIds	查詢指定帳號下DataWorks工作空間ID列表	該介面用於查詢指定阿里雲帳號（包括阿里雲主帳號或RAM使用者）在目標地區下擁有角色許可權的DataWorks工作空間的ID列表。
ChangeResourceManagerResourceGroup	修改資源歸屬資源群組	該介面用於修改資源歸屬資源群組。
ListMeasureData	查詢計量資料	該介面用於查詢使用者所在租戶下最近30天電話警示、簡訊警示計量資料。

中繼資料

API	標題	API概述
GetMetaDBInfo	擷取引擎執行個體的基本中繼資料資訊	該介面用於擷取引擎執行個體的基本中繼資料資訊。
GetMetaDBTableList	擷取引擎執行個體下的表	該介面用於擷取引擎執行個體中的表。
CheckMetaTable	檢查表是否存在	該介面用於檢查表是否存在。
CheckMetaPartition	檢查分區是否存在	該介面用於檢查分區是否存在。
SearchMetaTables	根據條件搜尋表	該介面用於根據條件搜尋表。
GetMetaTableBasicInfo	擷取表的基礎資訊	該介面用於擷取表的基礎資訊。
GetMetaTableColumn	擷取表的欄位資訊	該介面用於擷取表的欄位資訊。
GetMetaTablePartition	擷取表的分區列表	該介面用於擷取表的分區列表。
GetMetaTableOutput	擷取表的產出資訊	該介面用於擷取表的產出資訊。
GetMetaTableChangeLog	擷取表的變更日誌	該介面用於擷取表的變更日誌。
GetMetaTableIntroWiki	擷取表的使用說明	該介面用於擷取表的使用說明。
CreateMetaCategory	建立類目	該介面用於建立類目。
DeleteMetaCategory	刪除類目	該介面用於刪除類目。
UpdateMetaCategory	更新類目	該介面用於更新類目。
GetMetaCategory	查詢類目樹	該介面用於查詢類目樹。
GetMetaTableListByCategory	查詢指定類目下的表	該介面用於查詢指定類目下的表。
AddToMetaCategory	添加表至指定的類目	該介面用於添加表至指定的類目。
DeleteFromMetaCategory	從指定的類目中移除表	該介面用於從指定的類目中移除表。
UpdateMetaTable	更新表的Meta資訊	該介面用於更新表的Meta資訊。
UpdateMetaTableIntroWiki	更新表的說明資訊	該介面用於更新表的說明資訊，當資料不存在時增加資訊。
ListMetaDB	查詢資料庫列表	該介面用於查詢資料庫列表。
UpdateTableModelInfo	修改表模型資訊	修改表的主題、層級和物理分類等資訊。
CreateTableTheme	建立主題	調用CreateTableTheme建立主題。不建議使用該API，後續將有新API上線覆蓋此功能。
DeleteTableTheme	刪除主題	調用DeleteTableTheme刪除主題。不建議使用該API，後續將有新API上線覆蓋此功能。
UpdateTableTheme	更新主題	調用UpdateTableTheme更新主題。不建議使用該API，後續將有新API上線覆蓋此功能。
ListTableTheme	查詢主題列表	調用ListTableTheme查詢主題列表。不建議使用該API，後續將有新API上線覆蓋此功能。
GetMetaTableThemeLevel	擷取表的主題和層級資訊	擷取表的主題和層級資訊。
CreateTableLevel	建立層級	調用CreateTableLevel建立層級。不建議使用該API，後續將有新API上線覆蓋此功能。
UpdateTableLevel	更新層級	調用UpdateTableLevel更新層級。不建議使用該API，後續將有新API上線覆蓋此功能。
DeleteTableLevel	刪除層級	調用DeleteTableLevel刪除層級。不建議使用該API，後續將有新API上線覆蓋此功能。
ListTableLevel	查詢層級列表	調用ListTableLevel查詢層級列表。不建議使用該API，後續將有新API上線覆蓋此功能。
ListMetaCollectionEntities	查詢集合中的實體	該介面用於查詢集合中的實體。
GetMetaCollectionDetail	查詢集合詳情資訊	該介面用於查詢集合的詳細資料。
DeleteMetaCollectionEntity	刪除集合中的實體	該介面用於刪除集合中的實體。
AddMetaCollectionEntity	添加實體到集合中	該介面用於添加實體到集合中。
ListLineage	查詢實體血緣	查詢實體的上下遊血緣關係。
DeleteLineageRelation	刪除血緣關係	刪除實體間血緣關係。僅限於刪除使用者註冊的自訂血緣關係。
RegisterLineageRelation	註冊血緣關係	註冊實體關聯，支援使用者註冊自訂的實體關聯。
GetMetaTableLineage	擷取表的血緣關係	調用GetMetaTableLineage擷取表的血緣關係。
GetMetaColumnLineage	擷取欄位的血緣關係	調用GetMetaColumnLineage擷取欄位的血緣關係。

資料整合

API	標題	API概述
CreateDISyncTask	建立Data Integration同步任務	調用CreateDISyncTask建立Data Integration同步任務。
DeleteDISyncTask	刪除Data Integration同步任務	調用DeleteDISyncTask介面，刪除Data Integration同步任務。當前僅支援使用該介面刪除即時資料同步任務。
UpdateDISyncTask	更新同步任務	更新Data Integration同步任務。
TestNetworkConnection	測試資料來源網路連通性	測試目標資料來源與所使用資源群組的網路連通性。
GetDataSourceMeta	擷取目標資料來源的Meta資訊	調用GetDataSourceMeta擷取目標資料來源的Meta資訊。
ListDIProjectConfig	查看Data Integration專案預設配置	查看當前工作空間中Data Integration同步解決方案任務預設的全域配置。
UpdateDIProjectConfig	修改同步解決方案任務的全域配置	修改當前工作空間中Data Integration同步解決方案任務預設的全域配置。
GetDISyncTask	查詢資料同步任務	擷取Data Integration即時同步任務和同步解決方案的詳情。
DeployDISyncTask	部署發布同步任務	該介面用於發布即時同步任務。
GetDISyncInstanceInfo	擷取同步任務執行個體資訊	擷取即時同步任務和同步解決方案任務的運行狀態。
TerminateDISyncInstance	終止同步任務	下線Data Integration即時同步任務。
GenerateDISyncTaskConfigForCreating	非同步產生同時任務的JSON	非同步產生同時任務的JSON。
GenerateDISyncTaskConfigForUpdating	非同步產生更新同步任務配置	非同步產生更新同步任務的JSON。
StartDISyncInstance	啟動即時同步任務和解決方案同步任務	調用StartDISyncInstance介面，啟動即時同步任務和解決方案同步任務。
StopDISyncInstance	停止即時同步任務	調用StopDISyncInstance介面，停止即時同步任務。
QueryDISyncTaskConfigProcessResult	查詢非同步任務結果	查詢非同步任務結果。
GetDIAlarmRule	查詢Data Integration新版任務警示規則	查詢Data Integration新版任務警示規則，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。

資料建模

API	標題	API概述
QueryPublicModelEngine	查詢資料建模引擎的資訊	使用FML語句查詢資料建模引擎的資訊。

維運中心

API	標題	API概述
GetAlertMessage	查詢警示資訊	調用GetAlertMessage介面，通過擷取的AlertId查詢警示資訊。
ListAlertMessages	擷取警示資訊的列表	調用ListAlertMessages擷取警示資訊的列表。
GetBaselineConfig	擷取配置詳情	調用GetBaselineConfig擷取配置詳情。
ListNodesByBaseline	擷取基準中的節點	擷取基準中的節點（不包含這些節點的上遊節點）。
ListBaselineConfigs	擷取基準列表	調用ListBaselineConfigs擷取基準列表。
GetBaselineKeyPath	擷取基準執行個體的關鍵路徑	調用GetBaselineKeyPath擷取基準執行個體的關鍵路徑。
GetBaselineStatus	擷取基準執行個體的詳情	調用GetBaselineStatus擷取基準執行個體的詳情。
ListBaselineStatuses	擷取基準執行個體列表	調用ListBaselineStatuses擷取基準執行個體列表。
DeleteRemind	刪除自訂監控警示規則	調用DeleteRemind刪除自訂監控警示規則。
UpdateRemind	更新自訂警示規則	調用UpdateRemind更新自訂監控規則。
CreateRemind	建立自訂警示規則	調用CreateRemind建立自訂警示規則。
GetRemind	擷取自訂監控警示規則詳情	調用GetRemind介面，擷取自訂監控警示規則的詳情。
ListReminds	擷取自訂監控規則列表	擷取或搜尋自訂監控規則列表。
GetTopicInfluence	擷取事件影響的基準執行個體列表	調用GetTopicInfluence擷取事件影響的基準執行個體列表。
ListNodeInputOrOutput	查詢節點輸入輸出資訊	查詢當前節點的輸入輸出資訊。
GetNodeCode	擷取節點的代碼	調用GetNodeCode擷取節點的代碼。
GetInstanceLog	擷取執行個體的日誌	調用GetInstanceLog擷取執行個體的日誌。
SetSuccessInstance	重設失敗狀態的執行個體為成功	調用SetSuccessInstance，重設失敗狀態的執行個體為成功。
SuspendInstance	暫停執行個體	調用SuspendInstance暫停執行個體。
RunCycleDagNodes	建立補資料工作流程	調用RunCycleDagNodes建立補資料工作流程。
RunSmokeTest	運行煙霧測試 (Smoke Test)	建立煙霧測試 (Smoke Test)工作流程。
ListSuccessInstanceAmount	擷取運行成功的執行個體數量	擷取業務日期當天產生的周期執行個體任務，在業務日期的不同整點時刻，運行成功的執行個體數量統計趨勢。
ListInstanceAmount	擷取指定時間段周期執行個體數量趨勢	擷取指定時間段周期執行個體數量的趨勢。
TopTenElapsedTimeInstance	擷取昨天耗時最長的任務排行	擷取執行個體運行時間長度排行。
TopTenErrorTimesInstance	擷取近一個月節點的出錯排行	擷取近一個月節點的出錯排行。
GetFileTypeStatistic	擷取節點任務類型分布情況	擷取節點任務類型的分布情況。
GetInstanceStatusStatistic	擷取執行個體運行狀態統計資料	用GetInstanceStatusCount擷取執行個體任務不同運行狀態的數量統計。
ListFileType	查詢任務節點類型	查詢任務節點的類型資訊，包括類型Code和類型名稱。
RunManualDagNodes	執行手動商務程序	手動商務程序必須已在環境介面提交發布，之後營運中心才會顯示對應手動商務程序，您才可以使用該介面，觸發手動商務程序運行。
ListManualDagInstances	擷取手動執行的協調流程執行個體的資訊	擷取手動執行的協調流程執行個體的資訊。
GetDag	根據DagId擷取Dag詳情	支援查詢手動商務程序、手動任務、補資料的Dag詳情資訊，不支援查詢日常調度Dag詳情。
ListDags	擷取單次補資料的所有Dag詳情	根據OpSeq（補資料唯一標識）擷取單次補資料的所有Dag詳情。
ListNodesByOutput	根據節點的輸出結果精確查詢目標節點	根據節點的輸出結果精確查詢目標節點。
RunTriggerNode	運行一個觸發式節點	調用RunTriggerNode運行一個觸發式節點。
GetNodeParents	擷取節點上遊列表	調用GetNodeParents擷取節點上遊列表。
GetNodeChildren	擷取節點下遊列表	調用GetNodeChildren擷取節點下遊列表。
UpdateNodeRunMode	凍結或解凍目標節點	調用UpdateNodeRunMode凍結或解凍目標節點。
UpdateNodeOwner	修改目標節點負責人	修改目標節點的負責人。
UpdateWorkbenchEventResult	更新擴充程式的處理結果	所屬擴充程式的營運中心回調API，當營運中心的流程被擴充程式卡住後,調用UpdateWorkbenchEventResult返回擴充程式的處理結果。
ListShiftPersonnels	擷取值班表的值班人員列表	擷取值班表的值班人員列表。
ListShiftSchedules	擷取營運中心值班表列表	擷取營運中心值班表列表。
ListInstanceHistory	擷取所有執行個體記錄	調用ListInstanceHistory，擷取所有執行個體記錄，任務重跑一次就會產生一條記錄。
ListInnerNodes	擷取內部節點列表	調用ListInnerNodes擷取內部節點詳情，例如查詢組合節點、迴圈節點等節點類型的內部節點，不支援PAI節點的內部節點查詢。
OfflineNode	下線節點	調用OfflineNode下線節點。
GetBaseline	擷取基準配置	根據基準ID擷取基準配置。
DeleteBaseline	刪除基準配置	根據基準ID刪除基準配置，只有基準上遊沒有任何節點的情況下才允許刪除。可通過調用UpdateBaseline介面修改基準上遊節點。
ListBaselines	擷取基準列表	該介面用於擷取基準列表。
CreateBaseline	建立基準	該介面用於建立基準。
UpdateBaseline	修改基準配置	該介面用於更新基準。

資料品質

API	標題	API概述
UpdateQualityFollower	更新訂閱關係	調用UpdateQualityFollower更新訂閱關係。
UpdateQualityRule	更新規則	調用UpdateQualityRule更新校正規則的資訊。
DeleteQualityFollower	刪除分區運算式的訂閱人	調用DeleteQualityFollower刪除分區運算式的訂閱人。
GetQualityFollower	擷取分區運算式的訂閱人	調用GetQualityFollower擷取分區運算式的訂閱人。
CreateQualityFollower	建立分區運算式的訂閱人	調用CreateQualityFollower建立分區運算式的訂閱人。
DeleteQualityEntity	刪除分區運算式	調用DeleteQualityEntity刪除分區運算式。
GetQualityEntity	擷取分區運算式	調用GetQualityEntity擷取分區運算式。
CreateQualityEntity	建立資料品質的分區運算式	調用CreateQualityEntity建立資料品質的分區運算式。
CreateQualityRelativeNode	建立分區運算式關聯	調用CreateQualityRelativeNode建立分區運算式關聯。
DeleteQualityRelativeNode	刪除調度關聯	調用DeleteQualityRelativeNode刪除調度關聯。
ListQualityResultsByEntity	根據分區運算式查詢校正歷史結果	調用ListQualityResultsByEntity，根據分區運算式查詢歷史校正結果。
ListQualityResultsByRule	校正資料來源品質	根據校正規則校正資料來源的品質，並查詢校正結果。

資料服務

API	標題	API概述
DeleteDataServiceApi	刪除資料服務API	調用DeleteDataServiceApi刪除資料服務API。
ListDataServiceApis	擷取資料服務API開發中的資訊列表	調用ListDataServiceApis擷取資料服務API開發中的資訊列表。
GetDataServiceApi	查詢資料服務API開發態的詳情	調用GetDataServiceApi查詢資料服務API開發態的詳情。
UpdateDataServiceApi	更新資料服務API開發態的資訊	調用UpdateDataServiceApi更新資料服務API開發態的資訊。
GetDataServicePublishedApi	查詢資料服務API的發布態資訊	調用GetDataServicePublishedApi查詢資料服務API的發布態資訊。
ListDataServiceApiAuthorities	擷取授權給他人的API列表	調用ListDataServiceApiAuthorities擷取授權給他人的API列表。
ListDataServiceAuthorizedApis	擷取獲得授權的API資訊列表	調用ListDataServiceAuthorizedApis擷取獲得授權的API資訊列表。
AbolishDataServiceApi	下線資料服務API	調用AbolishDataServiceApi下線資料服務API。
GetDataServiceApplication	查詢資料服務App的詳情	調用GetDataServiceApplication查詢資料服務App的詳情。
ListDataServiceApplications	擷取資料服務應用的基礎資訊列表	調用ListDataServiceApplications擷取資料服務應用的基礎資訊列表。
CreateDataServiceFolder	建立資料服務檔案夾	調用CreateDataServiceFolder建立資料服務檔案夾。
GetDataServiceFolder	查詢資料服務檔案夾	調用GetDataServiceFolder查詢資料服務檔案夾。
ListDataServiceFolders	查詢資料服務資料夾清單	調用ListDataServiceFolders查詢資料服務資料夾清單。
CreateDataServiceGroup	建立資料服務商務程序	調用CreateDataServiceGroup建立資料服務商務程序。
GetDataServiceGroup	查詢資料服務商務程序	調用GetDataServiceGroup查詢資料服務商務程序。
ListDataServiceGroups	查詢資料服務商務程序列表	調用ListDataServiceGroups查詢資料服務商務程序列表。
CreateDataServiceApiAuthority	新增資料服務API授權	調用CreateDataServiceApiAuthority新增資料服務API授權。
DeleteDataServiceApiAuthority	取消資料服務API授權	調用DeleteDataServiceApiAuthority取消資料服務API授權。
ListDataServiceApiTest	列出資料服務API測試記錄	列出資料服務API測試記錄，只能查詢最近一個月資料。
TestDataServiceApi	測試資料服務API	測試API，非同步測試，需要GetDataServiceApiTest介面擷取測試結果。
GetDataServiceApiTest	擷取API測試結果	擷取API測試結果。
SubmitDataServiceApi	提交資料服務API	SubmitDataServiceApi用於提交資料服務API。
SaveDataServiceApiTestResult	儲存API測試結果	該介面用於儲存API測試的結果。

資料保護傘

API	標題	API概述
DsgUpdateDesensStatusList	更新去敏感化開關狀態	更新去敏感化開關狀態
DsgQueryDesensStatusList	查詢脫敏開關	查詢脫敏開關狀態
GetOpSensitiveData	擷取敏感性資料訪問記錄	擷取租戶下所有DataWorks工作空間指定日期的敏感性資料訪問記錄。
DesensitizeData	資料脫敏	輸入待脫敏資料，返回脫敏後的結果資料。
GetOpRiskData	擷取有風險的敏感性資料訪問記錄	擷取租戶下所有DataWorks工作空間指定日期中有風險的敏感性資料訪問記錄。
GetSensitiveData	擷取敏感性資料	調用GetSensitiveData，擷取租戶下所有DataWorks工作空間的最新敏感性資料識別結果。
ScanSensitiveData	掃描敏感性資料	調用ScanSensitiveData識別輸入資料中是否存在敏感性資料。
DsgQuerySensResult	擷取敏感性資料識別結果	該介面用於擷取資料保護傘的敏感性資料識別結果。
QueryDefaultTemplate	查詢預設分類分級模板	調用QueryDefaultTemplate介面查詢資料保護傘定義的預設分類分級模板。
DsgStopSensIdentify	停止分類分級敏感性資料識別任務	調用DsgStopSensIdentify介面，停止資料保護傘定義的分類分級敏感性資料識別任務。
QuerySensClassification	查詢分類分級中的分類節點	調用QuerySensClassification介面，查詢資料保護傘分類分級中的分類節點。
QuerySensLevel	查詢敏感性資料等級	調用QuerySensLevel介面，查詢在資料保護傘定義的敏感性資料等級。
QueryRecognizeRulesType	查詢敏感欄位內建識別規則類型	調用QueryRecognizeRulesType介面，查詢資料保護傘定義的敏感欄位內建識別規則類型。
DsgRunSensIdentify	啟動敏感性資料識別任務	調用DsgRunSensIdentify介面啟動一個資料保護傘的敏感性資料識別任務。
DeleteRecognizeRule	刪除分類分級準則	調用DeleteRecognizeRule介面，刪除在資料保護傘定義的分類分級準則。
QuerySensNodeInfo	查詢分類分級識別規則	調用QuerySensNodeInfo介面查詢資料保護傘的分類分級識別規則。
AddRecognizeRule	新增分類分級定義的敏感欄位	調用AddRecognizeRule介面新增資料保護傘分類分級定義的敏感欄位。
EditRecognizeRule	編輯分類分級定義的敏感欄位	調用EditRecognizeRule介面編輯資料保護傘分類分級定義的敏感欄位。
QueryRecognizeDataByRuleType	擷取敏感欄位識別方式列表	調用QueryRecognizeDataByRuleType介面擷取資料保護傘的敏感欄位識別方式列表。
QueryRecognizeRuleDetail	查詢指定敏感欄位詳情	調用QueryRecognizeRuleDetail介面查詢資料保護傘的指定敏感欄位詳情。
DsgUserGroupGetOdpsRoleGroups	查詢可選擇的MaxCompute角色列表	調用DsgUserGroupGetOdpsRoleGroups介面，查詢該租戶在資料保護傘建立或修改使用者組時，使用者群組成員可選擇的MaxCompute角色列表。
DsgDesensPlanAddOrUpdate	建立或編輯資料脫敏規則	調用DsgDesensPlanAddOrUpdate介面建立或編輯資料脫敏規則。
DsgPlatformQueryProjectsAndSchemaFromMeta	查詢當前租戶下的引擎執行個體列表	調用DsgPlatformQueryProjectsAndSchemaFromMeta介面，查詢當前租戶下不同類型的引擎執行個體列表。
DsgUserGroupDelete	刪除資料保護傘配置的使用者組	調用DsgUserGroupDelete介面，刪除資料保護傘配置的使用者組。
DsgWhiteListDeleteList	刪除脫敏白名單	調用DsgWhiteListDeleteList介面，刪除資料保護傘中配置的脫敏白名單。
DsgScenedDeleteScene	刪除二級脫敏情境	調用DsgScenedDeleteScene介面，刪除資料保護傘中已建立的二級脫敏情境。
DsgDesensPlanDelete	刪除脫敏規則	調用DsgDesensPlanDelete介面，刪除資料保護傘中已建立的脫敏規則。
DsgDesensPlanUpdateStatus	修改脫敏規則的生效狀態	調用DsgDesensPlanUpdateStatus介面，修改脫敏規則的生效狀態。
DsgWhiteListQueryList	查詢脫敏白名單	調用DsgWhiteListQueryList介面，查詢資料保護傘中配置的脫敏白名單。
DsgSceneAddOrUpdateScene	新增或編輯二級脫敏情境	調用DsgSceneAddOrUpdateScene介面，新增或編輯二級脫敏情境。
DsgSceneQuerySceneListByName	擷取脫敏情境列表	調用DsgSceneQuerySceneListByName介面，擷取脫敏情境列表。
DsgUserGroupAddOrUpdate	新增或編輯資料保護傘中的使用者組	調用DsgUserGroupAddOrUpdate介面，新增或編輯資料保護傘中的使用者組。
DsgUserGroupQueryList	查詢資料保護傘的使用者組列表	調用DsgUserGroupQueryList介面，查詢資料保護傘的使用者組列表。
DsgUserGroupQueryUserList	查詢當前租戶下的使用者或角色列表	調用DsgUserGroupQueryUserList介面，查詢當前租戶下的使用者或角色列表。
DsgDesensPlanQueryList	脫敏規則列表	調用DsgDesensPlanQueryList介面，查詢資料保護傘的脫敏規則列表。
DsgWhiteListAddOrUpdate	新增或編輯脫敏白名單	調用DsgWhiteListAddOrUpdate介面，新增或編輯脫敏白名單。
DsgQueryDefaultTemplates	查詢可選擇的敏感類型模版列表及詳情	調用DsgQueryDefaultTemplates介面，查詢可選擇的敏感類型模版列表及該模版支援的脫敏規則。您可參考該介面的返回參數配置脫敏規則。

遷移助手

API	標題	API概述
CreateImportMigration	建立匯入遷移	調用CreateImportMigration建立匯入任務，匯入任務包含資料來源資訊、任務、表等對象的DataWorks匯入匯出包。
GetMigrationProcess	擷取遷移過程	調用GetMigrationProcess擷取匯入匯出任務的進度狀態。
StartMigration	開始遷移	調用StartMigration啟動執行匯入匯出任務。
CreateExportMigration	建立匯出任務	使用CreateExportMigration，建立DataWorks匯出任務且僅建立匯出任務。
GetMigrationSummary	擷取匯入匯出任務的資訊	調用GetMigrationSummary，擷取匯入匯出任務的資訊。
ListMigrations	擷取遷移工作清單	擷取匯入匯出遷移工作清單。

安全中心

API	標題	API概述
CreatePermissionApplyOrder	建立權限申請單。	建立一個權限申請單。注意：2020版OpenAPI將擇期下線，請盡快遷移至2024版OpenAPI —— ApplyResourceAccessPermission。
GetPermissionApplyOrderDetail	查詢權限申請單的詳細資訊	查詢一個權限申請單的詳細資訊。注意：2020版OpenAPI將擇期下線，請儘快遷移至2024版OpenAPI —— GetApplicationContents/GetProcessInstance。
ListPermissionApplyOrders	查詢權限申請單列表	查詢權限申請單列表。注意：2020版OpenAPI將擇期下線，請儘快遷移至2024版OpenAPI —— ListMyApplications/ListPendingApprovals/ListMyRelatedApprovals。
ApprovePermissionApplyOrder	審批權限申請單	審批一個權限申請單。注意：2020版OpenAPI將擇期下線，請盡快遷移至2024版OpenAPI —— ApproveProcessInstance。

開放平台

API	標題	API概述
ListExtensions	擷取擴充程式列表	拉取開放平台的擴充程式列表。
GetExtension	擷取擴充程式詳情	擷取某個擴充程式詳情。
GetOptionValueForProject	擷取擴充程式選項配置在專案空間下的配置	擷取擴充程式選項配置在專案空間下的配置。
ListEnabledExtensionsForProject	擷取已經開啟的擴充程式列表	調用ListEnabledExtensionsForProject來擷取專案空間下已經開啟的擴充程式列表，包含系統擴充程式和自訂擴充程式。
CallbackExtension	返回擴充程式對擴充點事件的檢查結果	用於在DataWorks平台使用過程中觸發擴充點時，通過調用CallbackExtension介面，將擴充程式對擴充點事件的檢查結果返回給DataWorks平台。
ListCheckProcesses	查詢擴充事件的檢查列表	查詢擴充事件的檢查列表。

其他

API	標題	API概述
UpdateTableAddColumn	更新表的欄位資訊	更新MaxCompute表的欄位資訊。
GetMetaTableFullInfo	取得表的完整資訊（包括欄位資訊）	取得表的完整資訊（包括欄位資訊）。
GetDDLJobStatus	取得建立資料表、更新資料表和刪除資料表的任務狀態	呼叫GetDDLJobStatus取得建立資料表、更新資料表和刪除資料表的任務狀態。
DeleteTable	刪除 MaxCompute 表	刪除MaxCompute表。
CreateTable	建立一個MaxCompute資料表	建立一個MaxCompute的資料表。
CheckFileDeployment	檢查檔案部署	當您在DataWorks資料開發頁面建立的檔案提交成功後，檔案將進入發佈檢查狀態，DataWorks會將檔案發佈檢查事件傳回給您，您需要根據事件內容判斷該檔案是否可以繼續進行發佈驗證。此時，可以通過將待發佈檔案的檢查結果傳回至DataWorks。
ListRefDISyncTasks	查看目標資料來源所關聯的資料整合同步任務	查看目標資料來源所關聯的資料整合同步任務。
ExportDataSources	匯出資料來源清單	匯出資料來源清單。
ImportDataSources	批次匯入本機資料來源	批次匯入本機資料來源至目標DataWorks工作空間。
UpdateClusterConfigs	更新叢集的配置資訊	更新叢集在某個工作空間下分模組的配置資訊，目前支援更新 SPARK 參數。
ListClusterConfigs	列出叢集的配置資訊	列出叢集在某個工作空間下分模組的配置資訊，目前支援列出 SPARK 參數。

已棄用 API

API	標題	API概述
ListEntitiesByTags	根據標籤列出實體	根據標籤列出實體，目前只支援 maxcompute-table 類型的實體。
RemoveEntityTags	移除實體的標籤	移除實體的標籤，目前只支援 maxcompute-table 類型的實體。
SetEntityTags	設定實體的標籤	設定實體的標籤，目前僅支援 maxcompute-table 類型的實體。
ListEntityTags	列出實體的標籤	列出實體的標籤，目前只支援 maxcompute-table 類型的實體。
SetDataSourceShare	分享目標資料來源	分享目標資料來源至指定DataWorks工作空間或指定使用者。
CreateDagComplement	建立補資料工作流程	調用CreateDagComplement建立補資料工作流程。
CreateDagTest	建立冒煙測試工作流	呼叫 CreateDagTest 建立冒煙測試工作流。
CreateManualDag	觸發手動商務程序執行	手動商務程序必須已經在介面提交發布，營運中心能夠找到對應的手動商務程序，才能使用該介面。
GetProjectDetail	查詢工作空間資訊	查詢一個DataWorks工作空間的資訊。
ListNodeIO	查詢上下游節點資訊	查詢上下游節點的資訊，只能查詢一層。
GetInstanceStatusCount	取得執行個體不同狀態的數量統計	呼叫 GetInstanceStatusCount 取得執行個體不同狀態的數量統計。
ListProgramTypeCount	獲取節點任務類型的分佈	調用ListProgramTypeCount獲取節點任務類型的分佈。
GetManualDagInstances	取得手動業務流程執行執行個體的資訊	呼叫 GetManualDagInstances，取得手動執行的業務流程執行個體的資訊。
SearchNodesByOutput	根據輸出精確查詢節點	呼叫SearchNodesByOutput，根據輸出精確查詢節點。
GetNodeTypeListInfo	查詢節點類型資訊	查詢節點類型資訊，包括類型Code和類型名稱。
GetNodeOnBaseline	擷取基準上的節點	調用GetNodeOnBaseline擷取基準上的節點。
GetSuccessInstanceTrend	取得當天任務分時段的統計趨勢	呼叫GetSuccessInstanceTrend取得當天任務分時段的統計趨勢。
GetInstanceCountTrend	獲取週期執行個體數量的趨勢	呼叫GetInstanceCountTrend獲取週期執行個體數量的趨勢。
GetInstanceConsumeTimeRank	擷取執行個體運行時間長度排行	調用GetInstanceConsumeTimeRank擷取執行個體運行時間長度排行。
GetInstanceErrorRank	擷取近一個月節點的出錯排行	調用GetInstanceErrorRank擷取近一個月節點的出錯排行。

Others

API	標題	API概述
CreateBusiness	建立商務程序	調用CreateBusiness，建立資料開發（DataStudio）的商務程序。
CreateConnection	建立一個資料來源	呼叫 CreateConnection 建立一個資料來源。
CreateDIAlarmRule	建立Data Integration新版任務警示規則	建立Data Integration新版任務警示規則，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。
CreateDIJob	建立Data Integration新版任務	建立Data Integration新版任務，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。
CreateDataServiceApi	建立資料服務API	調用CreateDataServiceApi建立資料服務API。
CreateDataSource	建立資料來源	該介面用於建立DataWorks資料來源。
CreateFile	在資料開發中建立一個檔案	調用CreateFile，在資料開發中建立一個檔案。目前不支援調用該介面建立Data Integration節點任務。
CreateFolder	建立檔案夾	調用CreateFolder建立檔案夾。
CreateMetaCollection	建立集合對象	建立集合對象。
CreateProject	建立DataWorks工作空間	該介面用於建立一個DataWorks工作空間。
CreateProjectMember	添加一個使用者至工作空間	該介面用於添加一個使用者至DataWorks工作空間。
CreateQualityRule	建立品質監控規則	調用CreateQualityRule建立品質監控規則。
CreateResourceFile	建立資源檔	調用CreateResourceFile介面，在資料開發中建立或上傳一個資源檔，此API功能與IDE介面中建立資源功能保持一致。
CreateUdfFile	在資料開發中建立函數類型檔案	調用CreateUdfFile，在資料開發中建立函數類型檔案。
DeleteBusiness	刪除商務程序	調用DeleteBusiness刪除商務程序。
DeleteConnection	刪除一個資料來源	呼叫 DeleteConnection 刪除一個資料來源。
DeleteDIAlarmRule	刪除Data Integration新版任務警示規則	刪除Data Integration新版任務警示規則，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。
DeleteDIJob	刪除Data Integration新版任務	刪除Data Integration新版任務，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。
DeleteDataSource	刪除資料來源	該介面用於刪除資料來源。
DeleteFile	刪除資料開發中的檔案	調用DeleteFile刪除資料開發中的檔案。如果檔案已經提交過，那麼DeleteFile API會同時觸發一個非同步在調度系統刪除的流程，需要用DeleteFile API返回的DeploymentId繼續調用GetDeployment輪詢被觸發的非同步刪除流程的狀態。
DeleteFolder	刪除資料開發頁面的檔案夾	調用DeleteFolder刪除資料開發頁面的檔案夾。
DeleteMetaCollection	刪除集合	刪除集合。
DeleteProjectMember	從DataWorks工作空間移除使用者	該介面用於從DataWorks工作空間移除使用者。
DeleteQualityRule	刪除規則	調用DeleteQualityRule刪除規則。
DeployFile	部署檔案	發布檔案至生產環境。
EstablishRelationTableToBusiness	匯入表至商務程序	相當於在資料開發頁面按右鍵商務程序，選擇匯入表的操作。
GetBusiness	查詢商務程序的詳情	調用GetBusiness查詢商務程序的詳情。
GetDIJob	查看Data Integration新版任務	查看Data Integration新版任務，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。
GetDeployment	擷取發布包的詳情	調用GetDeployment擷取發布包的詳情。
GetFile	擷取檔案的詳情	該介面用於擷取檔案的詳情。
GetFileVersion	擷取檔案的版本詳情	調用GetFileVersion擷取檔案的版本詳情。
GetFolder	擷取檔案夾的詳情	調用GetFolder擷取檔案夾的詳情。
GetIDEEventDetail	查詢觸發擴充點事件時的資料快照	根據DataWorks開放訊息的訊息ID，查詢觸發擴充點事件時的擴充點資料快照。
GetInstance	擷取執行個體的詳情	調用GetInstance介面，擷取執行個體的詳細資料。
GetNode	擷取節點詳情	擷取節點的詳情。
GetProject	查詢工作空間詳細資料	該介面用於查詢一個DataWorks工作空間的詳細資料。
GetQualityRule	擷取規則的資訊	調用GetQualityRule擷取校正規則的資訊。
GetTopic	擷取事件的詳情	調用GetTopic擷取事件的詳情。
ListBusiness	查詢商務程序的列表	調用ListBusiness查詢商務程序的列表。
ListCalcEngines	ListCalcEngines	Queries a list of compute engines that are associated with a DataWorks workspace.
ListClusters	列出叢集資訊	列出註冊到 DataWorks 的叢集資訊，目前支援 EMR 叢集、CDH 叢集。
ListConnections	查詢資料來源列表	調用ListConnections查詢資料來源列表。
ListDIAlarmRules	查詢Data Integration新版任務警示規則列表	查詢Data Integration新版任務警示規則列表，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。
ListDIJobs	查詢Data Integration新版工作清單	查詢Data Integration新版工作清單，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。
ListDataServicePublishedApis	擷取資料服務API的發布態資訊列表	調用ListDataServicePublishedApis擷取資料服務API的發布態資訊列表。
ListDataSources	查詢資料來源列表	該介面用於查詢DataWorks的資料來源列表。
ListDeployments	查詢發布包列表資訊	查詢發布包列表資訊。該功能與DataWorks控制台任務發佈頁面的發布包列表功能對應。
ListFileVersions	查詢檔案的版本列表	調用ListFileVersions查詢檔案的版本列表。
ListFiles	查詢檔案清單	調用ListFiles查詢檔案清單。
ListFolders	查詢檔案夾的列表	調用ListFolders查詢檔案夾的列表。
ListInstances	擷取執行個體的列表	調用ListInstances擷取執行個體的列表。
ListMetaCollections	查詢集合資訊	查詢集合資訊。集合的概念包括資料地圖頁面上的專輯、專輯中的子類目等。通過本介面可以指定集合類型查詢集合資訊。
ListNodes	擷取節點的列表	調用ListNodes擷取節點的列表。
ListProjectMembers	查詢工作空間成員列表	該介面用於查詢DataWorks工作空間中已存在成員的列表。
ListProjectRoles	擷取工作空間所有角色的列表	該介面用於擷取工作空間所有角色的列表。
ListProjects	查詢工作空間列表	該介面用於查詢使用者所在租戶下的DataWorks工作空間列表。
ListQualityRules	根據分區運算式擷取規則列表	調用ListQualityRules根據分區運算式擷取校正規則列表。
ListResourceGroups	查看資源群組列表	該介面用於查看指定類型的資源群組列表。
ListTables	擷取表列表	分頁擷取租戶下面的資料來源類型粒度的表名稱。
ListTopics	擷取或搜尋事件列表	調用ListTopics擷取或搜尋事件列表。
PublishDataServiceApi	發布資料服務API	調用PublishDataServiceApi發布資料服務API。
RestartInstance	重啟執行個體	調用RestartInstance重啟執行個體。
ResumeInstance	恢複暫停狀態的執行個體	調用ResumeInstance恢複暫停狀態的執行個體。
RevokeTablePermission	撤銷使用者的表許可權	撤銷使用者的表許可權。
StartDIJob	啟動Data Integration新版任務	啟動Data Integration新版任務，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。
StopDIJob	停止Data Integration新版任務	停止Data Integration新版任務，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。
StopInstance	終止執行個體	調用StopInstance終止執行個體。
SubmitFile	提交檔案至調度系統開發環境	提交檔案至調度系統的開發環境，產生對應的任務。
UpdateBusiness	更新商務程序	調用UpdateBusiness更新商務程序。
UpdateConnection	更新一個資料來源	呼叫UpdateConnection更新一個資料來源。
UpdateDIAlarmRule	更新Data Integration新版任務警示規則	更新Data Integration新版任務警示規則，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。
UpdateDIJob	更新Data Integration新版任務	更新Data Integration新版任務，當前支援的任務類型包括：MySQL到Hologres整庫即時解決方案。
UpdateDataSource	更新資料來源	該介面用於更新資料來源。
UpdateFile	更新已有的檔案節點	調用UpdateFile更新已建立的檔案。
UpdateFolder	更新檔案夾的資訊	調用UpdateFolder更新檔案夾的資訊。
UpdateIDEEventResult	更新擴充點事件的檢查結果	用於在資料開發過程中觸發擴充點時，通過將擴充程式對擴充點事件的檢查結果返回給資料開發系統。
UpdateMetaCollection	更新集合對象	該介面用於更新集合對象的名稱和注釋。
UpdateTable	更新MaxCompute表	呼叫UpdateTable更新MaxCompute表。
UpdateUdfFile	更新函數的檔案資訊	調用UpdateUdfFile更新函數的檔案資訊。