DataWorks為您提供了涵蓋租戶、中繼資料、資料開發、營運中心、Data Integration等多個功能模組的OpenAPI介面，不同API的QPS限制、每日調用次數上限和支援使用的DataWorks服務版本存在差異。您可參考本文瞭解各OpenAPI支援的DataWorks版本及地區、計費方式和調用限制。
版本與地區要求
版本要求：
可用地區：
華東1（杭州）、華東2（上海）、華南1（深圳）、華北2（北京）、華北3（張家口）、北京政務雲、華東2（上海）金融雲、西南1（成都）、中國（香港）、亞太地區東南1（新加坡）、印尼（雅加達）、美國（矽谷）、美國（維吉尼亞）、德國（法蘭克福）、英國（倫敦）、日本（東京）、馬來西亞（吉隆坡） 。
調用限制
為規範DataWorks OpenAPI的調用，保障系統穩定性，將OpenAPI分為1級、2級和3級，詳情請參見OpenAPI列表。不同版本和不同分級的OpenAPI分別有相應的QPS限制和每日調用次數限制，具體如下。
查看OpenAPI免費額度、調用次數、調用明細等詳情請參見查看OpenAPI使用方式。
版本 | QPS限制 | 每日調用次數上限 |
基礎版 | 1級、2級、3級API總QPS≤5 | 每日API總調用次數≤100次 |
標準版 | 每日API總調用次數≤1000次 | |
專業版 | 每日API總調用次數≤10000次 | |
企業版 |
|
|
API QPS和調用次數的統計口徑：每個主帳號及其子帳號在每個地區的累計值。
當超過QPS或每日調用次數限制後，將會出現調用失敗，請合理控制調用並發和次數。
API調用成功和調用失敗的次數都會計入每日調用限制次數中。
免費額度與計費方式
OpenAPI採用版本結合隨用隨付的商業化方式，計費標準如下。
版本 | 免費調用額度 | 超出免費調用額度後隨用隨付 |
基礎版 | 3100次/月 | 有調用限制，不支援額外隨用隨付。 |
標準版 | 31000次/月 | |
專業版 | 310000次/月 | |
企業版 | 1000000次/月 | 0.05美元/萬次 |
每個自然月會給與每個主帳號（包含子帳號）在每個地區的OpenAPI一定的免費調用額度，不同版本的DataWorks每月可用的免費額度不一樣。
受不同版本DataWorks日調用次數限制（詳情見調用限制），基礎版、標準版、專業版的每月實際可調用量可能無法超過免費調用額度，且不支援隨用隨付。
DataWorks企業版免費額度用盡後，支援根據隨用隨付的價格進行收費，實際計費價格以最終賬單顯示的價格為準。
只有當API調用成功後，才會消耗免費調用額度並且在超過免費調用額度後隨用隨付，API調用失敗的話不會消耗免費調用額度且不計量計費。
OpenAPI列表
DataWorks OpenAPI包括租戶、中繼資料、資料開發、Data Integration、資料建模、營運中心、資料品質、資料服務、資料保護傘、遷移助手及資訊安全中心。
租戶
API名稱 | API描述 | API層級 | 最低版本要求 （本版本及以上版本支援） |
調用ListCalcEngines查看計算引擎列表。 | 2級 |
| |
調用CreateDataSource介面，建立DataWorks資料來源。 | 2級 | ||
調用ListDataSources介面，查詢DataWorks資料來源列表。 | 3級 | ||
調用UpdateDataSource介面，更新資料來源。 | 2級 | ||
調用DeleteDataSource介面，刪除一個資料來源。 | 2級 | ||
調用ListResourceGroups查看資源群組列表。 | 1級 | ||
調用GetProject查詢一個DataWorks工作空間的資訊。 | 1級 | ||
調用AddProjectMemberToRole，添加DataWorks工作空間使用者至角色。使用者需要先添加至DataWorks工作空間內。 | 2級 | ||
調用CreateProjectMember，添加一個使用者至DataWorks工作空間。 | 2級 | ||
調用DeleteProjectMember，從DataWorks工作空間移除使用者。 | 2級 | ||
調用ListProjectRoles擷取工作空間所有角色的列表。 | 1級 | ||
調用RemoveProjectMemberFromRole，將DataWorks工作空間內的使用者從DataWorks角色中移除。 | 2級 | ||
調用ListProjectMembers查詢DataWorks工作空間中已存在成員的列表。 | 1級 | ||
調用ListProjects，分頁列出使用者所在租戶下的DataWorks工作空間列表。 | 1級 | ||
調用ListProjectIds，使用目標阿里雲帳號（包括阿里雲主帳號或RAM使用者）的ID擷取其擁有角色許可權的DataWorks工作空間的ID列表。 | 1級 | ||
調用DeleteProject介面，刪除DataWorks工作空間。 | 3級 | ||
調用CreateProject介面，建立 DataWorks 工作空間。 | 3級 | ||
調用UpdateProject介面，更新DataWorks工作空間。 | 3級 | ||
調用ChangeResourceManagerResourceGroup介面，修改資源歸屬資源群組。 | 3級 |
中繼資料
API名稱 | API描述 | API層級 | 最低版本要求 （本版本及以上版本支援） |
調用GetMetaDBInfo擷取引擎執行個體的基本中繼資料資訊。 | 1級 |
| |
調用GetMetaDBTableList擷取引擎執行個體下的表。 | 1級 |
| |
調用CheckMetaTable檢查表是否存在。 | 1級 |
| |
調用CheckMetaPartition檢查分區是否存在。 | 1級 |
| |
調用SearchMetaTables根據條件搜尋表。 | 1級 |
| |
調用GetMetaTableBasicInfo擷取表的基礎資訊。 | 1級 |
| |
調用GetMetaTableColumn擷取表的欄位資訊。 | 1級 |
| |
調用GetMetaTablePartition擷取表的分區列表。 | 1級 |
| |
調用GetMetaTableOutput擷取表的產出資訊。 | 1級 |
| |
調用GetMetaTableChangeLog擷取表的變更日誌。 | 1級 |
| |
調用GetMetaTableIntroWiki擷取表的使用說明。 | 1級 |
| |
調用CreateMetaCategory建立類目。 | 2級 |
| |
調用DeleteMetaCategory刪除類目。 | 2級 |
| |
調用UpdateMetaCategory更新類目。 | 2級 |
| |
調用GetMetaCategory查詢類目樹。 | 1級 |
| |
調用GetMetaTableListByCategory查詢指定類目下的表。 | 1級 |
| |
調用AddToMetaCategory添加表至指定的類目。 | 2級 |
| |
調用DeleteFromMetaCategory從指定的類目中移除表。 | 2級 |
| |
調用UpdateMetaTable更新表的Meta資訊。 | 2級 |
| |
調用UpdateMetaTableIntroWiki更新表的說明資訊，當資料不存在時增加資訊。 | 2級 |
| |
調用ListMetaDB查詢資料庫列表。 | 1級 |
| |
調用UpdateTableModelInfo修改表的主題、層級和物理分類等資訊。 | 2級 |
| |
調用CreateTableTheme建立主題。 | 2級 |
| |
調用DeleteTableTheme刪除主題。 | 2級 |
| |
調用UpdateTableTheme更新主題。 | 2級 |
| |
調用ListTableTheme查詢主題列表。 | 1級 |
| |
調用CreateTableLevel建立層級。 | 2級 |
| |
調用DeleteTableLevel刪除層級。 | 2級 |
| |
調用UpdateTableLevel更新層級。 | 2級 |
| |
調用ListTableLevel查詢層級列表。 | 1級 |
| |
調用GetMetaTableThemeLevel擷取表的主題和層級關係。 | 1級 |
| |
調用UpdateMetaCollection更新集合對象。 | 2級 |
| |
調用ListMetaCollections查詢集合資訊。 | 2級 |
| |
調用ListMetaCollectionEntities查詢集合中的實體。 | 2級 |
| |
調用DeleteMetaCollection刪除集合。 | 2級 |
| |
調用GetMetaCollectionDetail查詢集合詳情資訊。 | 2級 |
| |
調用DeleteMetaCollectionEntity刪除集合中的實體。 | 2級 |
| |
調用AddMetaCollectionEntity添加實體到集合中。 | 2級 |
| |
調用CreateMetaCollection建立集合對象。 | 2級 |
| |
調用GetMetaTableProducingTasks查詢表的產出工作清單。 | 1級 |
| |
調用ListLineage查詢實體的上下遊血緣關係。 | 2級 |
| |
調用DeleteLineageRelation刪除實體間血緣關係。 | 2級 |
| |
調用RegisterLineageRelation將自有實體間的血緣關係註冊到DataWorks 平台上，與已有血緣關係相結合形成全鏈路血緣。 | 2級 |
|
資料開發
API名稱 | API描述 | API層級 | 最低版本要求 （本版本及以上版本支援） |
調用CreateFile，在資料開發中建立一個檔案。 | 3級 |
| |
調用CreateUdfFile，在資料開發中建立函數類型檔案。 | 2級 |
| |
調用CreateBusiness建立商務程序。 | 2級 |
| |
調用DeleteBusiness刪除商務程序。 | 3級 |
| |
調用CreateFolder建立檔案夾。 | 2級 |
| |
調用UpdateBusiness更新商務程序。 | 2級 |
| |
調用ListFiles查詢檔案清單。 | 1級 |
| |
調用EstablishRelationTableToBusiness，匯入表至商務程序。相當於在資料開發頁面按右鍵商務程序，選擇匯入表的操作。 | 2級 |
| |
調用SubmitFile，提交檔案至調度系統的開發環境，產生對應的任務。 | 3級 |
| |
調用ListBusiness查詢商務程序的列表。 | 1級 |
| |
調用GetFileVersion擷取檔案的版本詳情。 | 1級 |
| |
調用DeleteFolder刪除資料開發頁面的檔案夾。 | 3級 |
| |
調用DeleteFile刪除資料開發中的檔案。 | 3級 |
| |
調用GetDeployment擷取發布包的詳情。 | 1級 |
| |
調用UpdateFile更新檔案。 | 2級 |
| |
調用GetFolder擷取檔案夾的詳情。 | 1級 |
| |
調用ListFileVersions查詢檔案的版本列表。 | 1級 |
| |
調用GetFile擷取檔案的詳情。 | 1級 |
| |
調用ListFolders查詢檔案夾的列表。 | 1級 |
| |
調用DeployFile部署檔案，發布檔案至生產環境。 | 3級 |
| |
調用UpdateUdfFile更新函數的檔案資訊。 | 2級 |
| |
調用GetBusiness查詢商務程序的詳情。 | 1級 |
| |
調用UpdateFolder更新檔案夾的資訊。 | 2級 |
| |
調用ListDeployments，查詢發布包列表資訊。該功能與DataWorks控制台任務發佈頁面的發布包列表功能對應。 | 1級 |
| |
用於在資料開發過程中觸發擴充點時，通過調用UpdateIDEEventResult介面，將擴充程式對擴充點事件的檢查結果返回給DataWorks的資料開發系統。 | 2級 |
| |
調用GetIDEEventDetail，根據DataWorks開放訊息的訊息ID，查詢觸發擴充點事件時的擴充點資料快照。 | 1級 |
| |
調用CreateResourceFile，在資料開發中建立或上傳一個資源檔，此API功能與IDE介面中建立資源功能保持一致。 | 3級 |
|
Data Integration
API名稱 | API描述 | API層級 | 最低版本要求 （本版本及以上版本支援） |
調用CreateDISyncTask建立Data Integration同步任務。 | 3級 |
| |
調用DeleteDISyncTask介面，刪除Data Integration同步任務。當前僅支援使用該介面刪除即時資料同步任務。 | 3級 |
| |
調用UpdateDISyncTask更新Data Integration同步任務。 | 3級 |
| |
調用TestNetworkConnection介面，測試目標資料來源與所使用資源群組的網路連通性。 | 3級 |
| |
調用GetDataSourceMeta擷取目標資料來源的Meta資訊。 | 3級 |
| |
調用ListDIProjectConfig查看當前工作空間中Data Integration同步解決方案任務預設的全域配置。 | 3級 |
| |
調用UpdateDIProjectConfig修改當前工作空間中Data Integration同步解決方案任務預設的全域配置。 | 3級 |
| |
調用GetDISyncTask擷取Data Integration即時同步任務和同步解決方案的詳情。 | 3級 |
| |
調用DeployDISyncTask發布即時同步任務和同步解決方案任務。 | 3級 |
| |
調用GetDISyncInstanceInfo擷取即時同步任務和同步解決方案任務的運行狀態。 | 3級 |
| |
調用StartDISyncInstance介面，啟動即時同步任務和解決方案同步任務。 | 3級 |
| |
調用StopDISyncInstance介面，停止即時同步任務。 | 3級 |
| |
調用TerminateDISyncInstance下線Data Integration即時同步任務。 | 3級 |
| |
調用GenerateDISyncTaskConfigForCreating介面，非同步產生建立Data Integration同步任務的非同步線程ID。 | 3級 |
| |
調用GenerateDISyncTaskConfigForUpdating介面，非同步產生更新Data Integration同步任務的非同步線程ID。 | 3級 |
| |
調用QueryDISyncTaskConfigProcessResult介面，通過非同步線程ID，擷取非同步產生或更新Data Integration同步任務需要的參數。 | 3級 |
| |
調用CreateDIJob建立Data Integration新版任務。 | 3級 |
| |
調用DeleteDIJob刪除Data Integration新版任務。 | 3級 |
| |
調用GetDIJob查看Data Integration新版任務。 | 3級 |
| |
調用ListDIJobs查詢Data Integration新版工作清單。 | 3級 |
| |
調用StartDIJob啟動Data Integration新版任務。 | 3級 |
| |
調用StopDIJob停止Data Integration新版任務。 | 3級 |
| |
調用UpdateDIJob更新Data Integration新版任務。 | 3級 |
| |
調用CreateDIAlarmRule建立Data Integration新版任務警示規則。 | 3級 |
| |
調用GetDIAlarmRule查詢Data Integration新版任務警示規則。 | 3級 |
| |
調用 ListDIAlarmRules查詢Data Integration新版任務警示規則列表。 | 3級 |
| |
調用UpdateDIAlarmRule更新Data Integration新版任務警示規則。 | 3級 |
|
Data Integration使用API建立Data Integration任務，詳情請參見通過OpenAPI建立、修改、刪除離線同步任務。
營運中心
API名稱 | API描述 | API層級 | 最低版本要求 （本版本及以上版本支援） |
調用ListAlertMessages擷取警示資訊的列表。 | 1級 |
| |
調用GetBaselineConfig擷取配置詳情。 | 1級 |
| |
調用ListNodesByBaseline擷取基準中的節點。 | 1級 |
| |
調用ListBaselineConfigs擷取基準列表。 | 1級 |
| |
調用GetBaselineKeyPath擷取基準執行個體的關鍵路徑。 | 1級 |
| |
調用GetBaselineStatus擷取基準執行個體的詳情。 | 1級 |
| |
調用ListBaselineStatuses擷取基準執行個體列表。 | 1級 |
| |
調用DeleteRemind刪除自訂監控警示規則。 | 2級 |
| |
調用UpdateRemind更新自訂警示規則。 | 3級 |
| |
調用CreateRemind建立自訂警示規則。 | 3級 |
| |
調用GetRemind擷取自訂監控警示規則的詳情。 | 1級 |
| |
調用ListReminds擷取或搜尋自訂監控規則列表。 | 1級 |
| |
調用ListTopics擷取或搜尋事件列表。 | 1級 |
| |
調用GetTopic擷取事件的詳情。 | 1級 |
| |
調用GetTopicInfluence擷取事件影響的基準執行個體列表。 | 1級 |
| |
調用GetNode擷取節點的詳情。 | 1級 |
| |
調用ListNodeInputOrOutput查詢當前節點的上下遊節點資訊。該API只能查詢上遊或下遊的一層節點資訊。 | 1級 |
| |
調用ListNodes擷取節點的列表。 | 1級 |
| |
調用GetNodeCode擷取節點的代碼。 | 1級 |
| |
調用GetInstance擷取執行個體的詳情。 | 1級 |
| |
調用ListInstances擷取執行個體的列表。 | 1級 |
| |
調用GetInstanceLog擷取執行個體的日誌。 | 1級 |
| |
調用StopInstance終止執行個體。 | 2級 |
| |
調用RestartInstance重啟執行個體。 | 2級 |
| |
調用SetSuccessInstance，重設失敗狀態的執行個體為成功。 | 2級 |
| |
調用SuspendInstance暫停執行個體。 | 2級 |
| |
調用ResumeInstance恢複暫停狀態的執行個體。 | 2級 |
| |
調用RunCycleDagNodes建立補資料工作流程。 | 2級 |
| |
調用RunSmokeTest建立煙霧測試 (Smoke Test)工作流程。 | 2級 |
| |
調用ListSuccessInstanceAmount，擷取業務日期當天產生的周期執行個體任務，在業務日期的不同整點時刻，運行成功的執行個體數量統計趨勢。 | 3級 |
| |
調用ListInstanceAmount擷取指定時間段周期執行個體數量的趨勢。 | 1級 |
| |
調用TopTenElapsedTimeInstance擷取執行個體運行時間長度排行。 | 1級 |
| |
調用TopTenErrorTimesInstance擷取近一個月節點的出錯排行。 | 1級 |
| |
調用GetFileTypeStatistic擷取節點任務類型的分布情況。 | 1級 |
| |
調用GetInstanceStatusCount擷取執行個體任務不同運行狀態的數量統計。 | 1級 |
| |
調用ListFileType查詢任務節點的類型資訊，包括類型Code和類型名稱。 | 1級 |
| |
調用RunManualDagNodes觸發手動商務程序執行。手動商務程序必須已經在介面提交發布，營運中心能夠找到對應的手動商務程序，才能使用該介面。 | 2級 |
| |
調用ListManualDagInstances擷取手動執行的協調流程執行個體的資訊。 | 1級 |
| |
調用GetDag，根據DagId擷取Dag詳情。 | 1級 |
| |
根據OpSeq擷取單次補資料的所有Dag詳情。 | 1級 |
| |
調用ListNodesByOutput根據節點的輸出結果精確查詢目標節點。 | 1級 |
| |
調用RunTriggerNode運行一個觸發式節點。 | 2級 |
| |
調用GetNodeParents擷取節點上遊列表。 | 2級 |
| |
調用GetNodeChildren擷取節點下遊列表。 | 2級 |
| |
調用UpdateNodeRunMode凍結或解凍目標節點。 | 2級 |
| |
調用UpdateNodeOwner修改目標節點的負責人。 | 2級 |
| |
所屬擴充程式的營運中心回調API，當營運中心的流程被擴充程式卡住後，調用UpdateWorkbenchEventResult返回擴充程式的處理結果。 | 2級 |
| |
調用ListShiftPersonnels擷取值班表的值班人員列表。 | 1級 |
| |
調用ListShiftSchedules擷取營運中心值班表列表。 | 1級 |
| |
調用ListInstanceHistory，擷取所有執行個體記錄，任務重跑一次就會產生一條記錄。 | 1級 |
| |
調用ListInnerNodes擷取內部節點詳情，例如查詢組合節點、迴圈節點等節點類型的內部節點，不支援PAI節點的內部節點查詢。 | 1級 |
| |
調用OfflineNode下線節點。 | 3級 |
| |
調用CreateBaseline建立基準。 | 3級 |
| |
調用UpdateBaseline修改基準配置。 | 3級 |
| |
調用GetBaseline根據基準ID擷取基準配置。 | 1級 |
| |
調用ListBaselines擷取基準配置列表。 | 1級 |
| |
調用DeleteBaseline根據基準ID刪除基準配置。 | 2級 |
|
資料品質
API名稱 | API描述 | API層級 | 最低版本要求 （本版本及以上版本支援） |
調用UpdateQualityFollower更新訂閱關係。 | 2級 |
| |
調用UpdateQualityRule更新規則。 | 2級 | ||
調用GetQualityRule擷取規則的資訊。 | 1級 | ||
調用ListQualityRules根據分區運算式擷取規則列表。 | 3級 | ||
調用CreateQualityRule建立品質監控規則。 | 3級 | ||
調用DeleteQualityFollower刪除分區運算式的訂閱人。 | 2級 | ||
調用DeleteQualityRule刪除規則。 | 2級 | ||
調用GetQualityFollower擷取分區運算式的訂閱人。 | 1級 | ||
調用CreateQualityFollower建立分區運算式的訂閱人。 | 3級 | ||
調用DeleteQualityEntity刪除分區運算式。 | 2級 | ||
調用GetQualityEntity擷取分區運算式。 | 1級 | ||
調用CreateQualityEntity建立資料品質的分區運算式。 | 2級 | ||
調用CreateQualityRelativeNode建立分區運算式關聯。 | 3級 | ||
調用DeleteQualityRelativeNode刪除調度關聯。 | 2級 | ||
調用ListQualityResultsByEntity，根據分區運算式查詢校正歷史結果。 | 1級 | ||
調用ListQualityResultsByRule，根據規則查詢校正結果。 | 1級 |
資料服務
API名稱 | API描述 | API層級 | 最低版本要求 （本版本及以上版本支援） |
調用CreateDataServiceApi建立資料服務API。 | 3級 |
| |
調用PublishDataServiceApi發布資料服務API。 | 3級 | ||
調用DeleteDataServiceApi刪除資料服務API。 | 3級 | ||
調用ListDataServiceApis擷取資料服務API開發中的資訊列表。 | 1級 | ||
調用GetDataServiceApi查詢資料服務API開發態的詳情。 | 1級 | ||
調用UpdateDataServiceApi更新資料服務API開發態的資訊。 | 3級 | ||
調用GetDataServicePublishedApi查詢資料服務API的發布態資訊。 | 1級 | ||
調用ListDataServicePublishedApis擷取資料服務API的發布態資訊列表。 | 1級 | ||
調用ListDataServiceApiAuthorities擷取授權給他人的API列表。 | 1級 | ||
調用ListDataServiceAuthorizedApis擷取獲得授權的API資訊列表。 | 1級 | ||
調用AbolishDataServiceApi下線資料服務API。 | 3級 | ||
調用GetDataServiceApplication查詢資料服務App的詳情。 | 1級 | ||
調用ListDataServiceApplications擷取資料服務應用的基礎資訊列表。 | 1級 | ||
調用CreateDataServiceFolder建立資料服務檔案夾。 | 2級 | ||
調用GetDataServiceFolder查詢資料服務檔案夾。 | 1級 | ||
調用ListDataServiceFolders查詢資料服務資料夾清單。 | 1級 | ||
調用CreateDataServiceGroup建立資料服務商務程序。 | 2級 | ||
調用GetDataServiceGroup查詢資料服務商務程序。 | 1級 | ||
調用ListDataServiceGroups查詢資料服務商務程序列表。 | 1級 | ||
調用CreateDataServiceApiAuthority新增資料服務API授權。 | 1級 | ||
調用DeleteDataServiceApiAuthority取消資料服務API授權。 | 1級 |
資料分析
API名稱 | API描述 | API層級 | 最低版本要求 （本版本及以上版本支援） |
調用UmountDirectory將指定內容從資料分析左側導航目錄中移除。 | 2級 |
| |
調用MountDirectory將指定內容掛載到資料分析左側導航目錄。 | 2級 |
|
資料保護傘
API名稱 | API描述 | API層級 | 最低版本要求 （本版本及以上版本支援） |
調用GetOpSensitiveData，擷取租戶下所有DataWorks工作空間指定日期的敏感性資料訪問記錄。 | 1級 |
| |
調用DesensitizeData輸入待脫敏資料，返回脫敏後的結果資料。 | 1級 |
| |
調用GetOpRiskData，擷取租戶下所有DataWorks工作空間指定日期中有風險的敏感性資料訪問記錄。 | 1級 |
| |
調用GetSensitiveData，擷取租戶下所有DataWorks工作空間的最新敏感性資料識別結果。 | 1級 |
| |
調用ScanSensitiveData識別輸入資料中是否存在敏感性資料。 | 1級 |
| |
調用DsgQuerySensResult介面，擷取資料保護傘的敏感性資料識別結果。 | 1級 |
| |
調用QueryDefaultTemplate介面查詢資料保護傘定義的預設分類分級模板。 | 1級 |
| |
調用DsgStopSensIdentify介面，停止資料保護傘定義的敏感性資料識別任務。 | 1級 |
| |
調用QuerySensClassification介面，查詢資料保護傘分類分級中的分類節點。 | 1級 |
| |
調用QuerySensLevel介面，查詢在資料保護傘定義的敏感性資料等級。 | 1級 |
| |
調用QueryRecognizeRulesType介面，查詢資料保護傘定義的敏感欄位內建識別規則類型。 | 1級 |
| |
調用DsgRunSensIdentify介面啟動一個資料保護傘的敏感性資料識別任務。 | 1級 |
| |
調用DeleteRecognizeRule介面，刪除在資料保護傘定義的分類分級準則。 | 1級 |
| |
調用QuerySensNodeInfo介面查詢資料保護傘的分類分級識別規則。 | 1級 |
| |
調用AddRecognizeRule介面新增資料保護傘分類分級定義的敏感欄位。 | 1級 |
| |
調用EditRecognizeRule介面編輯資料保護傘分類分級定義的敏感欄位。 | 1級 |
| |
調用QueryRecognizeDataByRuleType介面擷取資料保護傘的敏感欄位識別方式列表。 | 1級 |
| |
調用QueryRecognizeRuleDetail介面查詢資料保護傘的指定敏感欄位詳情。 | 1級 |
| |
調用DsgUserGroupGetOdpsRoleGroups介面，查詢該租戶在資料保護傘建立或修改使用者組時，使用者群組成員可選擇的MaxCompute角色列表。 | 1級 |
| |
調用DsgDesensPlanAddOrUpdate介面建立或編輯資料脫敏規則。 | 1級 |
| |
調用DsgPlatformQueryProjectsAndSchemaFromMeta介面，查詢當前租戶下不同類型的引擎執行個體列表。 | 1級 |
| |
調用DsgUserGroupDelete介面，刪除資料保護傘配置的使用者組。 | 1級 |
| |
調用DsgWhiteListDeleteList介面，刪除資料保護傘中配置的脫敏白名單。 | 1級 |
| |
調用DsgScenedDeleteScene介面，刪除資料保護傘中已建立的二級脫敏情境。 | 1級 |
| |
調用DsgDesensPlanDelete介面，刪除資料保護傘中已建立的脫敏規則。 | 1級 |
| |
調用DsgDesensPlanUpdateStatus介面，修改脫敏規則的生效狀態。 | 1級 |
| |
調用DsgWhiteListQueryList介面，查詢資料保護傘中配置的脫敏白名單。 | 1級 |
| |
調用DsgSceneAddOrUpdateScene介面，新增或編輯二級脫敏情境。 | 1級 |
| |
調用DsgSceneQuerySceneListByName介面，擷取脫敏情境列表。 | 1級 |
| |
調用DsgUserGroupAddOrUpdate介面，新增或編輯資料保護傘中的使用者組。 | 1級 |
| |
調用DsgUserGroupQueryList介面，查詢資料保護傘的使用者組列表。 | 1級 |
| |
調用DsgUserGroupQueryUserList介面，查詢當前租戶下的使用者或角色列表。 | 1級 |
| |
調用DsgDesensPlanQueryList介面，查詢資料保護傘的脫敏規則列表。 | 1級 |
| |
調用DsgWhiteListAddOrUpdate介面，新增或編輯脫敏白名單。 | 1級 |
| |
調用DsgQueryDefaultTemplates介面，查詢可選擇的敏感類型模版列表及該模版支援的脫敏規則。您可參考該介面的返回參數配置脫敏規則。 | 1級 |
|
遷移助手
API名稱 | API描述 | API層級 | 最低版本要求 （本版本及以上版本支援） |
調用CreateImportMigration建立匯入任務，匯入任務包含資料來源資訊、任務、表等對象的DataWorks匯入匯出包。 | 2級 |
| |
調用GetMigrationProcess擷取匯入匯出任務的進度狀態。 | 1級 | ||
調用StartMigration啟動執行匯入匯出任務。 | 2級 | ||
調用CreateExportMigration，建立一個DataWorks的匯出任務。該API僅建立匯出任務，不會啟動執行匯出任務。 | 2級 | ||
調用GetMigrationSummary，擷取匯入匯出任務的資訊。 | 2級 | ||
調用ListMigrations，擷取匯入匯出任務的列表。 | 2級 |
資訊安全中心
API名稱 | API描述 | API層級 | 最低版本要求 （本版本及以上版本支援） |
調用CreatePermissionApplyOrder建立一個許可權申請單。 | 2級 |
| |
調用GetPermissionApplyOrderDetail查詢一個許可權申請單的詳細資料。 | 2級 | ||
調用ListPermissionApplyOrders查詢許可權申請單列表。 | 3級 | ||
調用ApprovePermissionApplyOrder審批一個許可權申請單。 | 2級 | ||
調用RevokeColumnPermission，撤銷使用者的表欄位許可權。 | 2級 | ||
調用RevokeTablePermission，撤銷使用者的表許可權。 | 2級 |
開放平台
API名稱 | API描述 | API層級 | 最低版本要求 |
調用ListExtensions拉取開放平台的擴充程式列表。 | 1級 |
| |
調用GetExtension擷取某個擴充程式詳情。 | 1級 | ||
調用GetOptionValueForProject擷取擴充程式選項配置在專案空間下的配置。 | 1級 | ||
調用ListEnabledExtensionsForProject來擷取專案空間下已經開啟的擴充程式列表，包含系統擴充程式和自訂擴充程式。 | 1級 | ||
調用CallbackExtension用於在DataWorks平台使用過程中觸發擴充點時，通過調用CallbackExtension介面，將擴充程式對擴充點事件的檢查結果返回給DataWorks平台。 | 1級 |
相關參數擷取方式
查看個人資訊（AccessKey、UID）
在頁面，單擊目標使用者，進入使用者詳情頁查看使用者的詳細資料（例如，UID）。
在使用者詳情頁面的地區，擷取個人AccessKey資訊。
查看當前工作空間所在地區（RegionId）
查看工作空間ID（ProjectId）
工作空間ID為每個工作空間所擁有的唯一標識。您可通過如下步驟擷取：
進入管理中心頁面。
登入DataWorks控制台，切換至目標地區後，單擊左側導覽列的管理中心，在下拉框中選擇對應工作空間後單擊進入管理中心。
在左側導覽列單擊工作空間，在地區擷取工作空間ID。
查看租戶ID（tenantId）
每個阿里雲主帳號都擁有自己的租戶ID，用來與其他阿里雲主帳號進行區分。同一阿里雲主帳號下各RAM使用者（即子帳號）均屬於該租戶，即同帳號的主帳號與子帳號租戶ID相同。租戶ID可通過如下步驟擷取：
在資料開發（DataStudio）頁面，單擊右上方當前登入使用者名稱稱，單擊，擷取租戶ID。
常見問題
調用OpenAPI報錯：The request for this resource has exceeded your daily available limit.
調用API時產生報錯，您還可以在對應API文檔查看錯誤碼的描述資訊，也可以進入錯誤中心查看錯誤碼詳情。