API 概覽

API標準及多語言預置SDK

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

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

自訂簽名情境

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

帳號與安全準備

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

中繼資料

API	標題	API概述
目錄	目錄
UpdateCatalog	更新目錄	更新資料目錄內容。
庫	庫
UpdateDatabase	更新資料庫資訊	更新資料湖中資料庫的詳細資料。
表	表
CreateTable	新增資料表	新增資料湖的資料表。
DeleteTable	刪除資料表	根據名稱刪除資料湖的資料表。
DeleteTableColumnStatistics	刪除資料表統計資訊	回收資料湖中資料表的欄位統計資訊。
DeleteTableVersion	刪除資料表指定版本	刪除資料湖中資料表指定版本。
UpdateTableColumnStatistics	更新資料表統計資訊	建立或者更新資料表的欄位統計資訊。
GetTableColumnStatistics	擷取資料表欄位的統計資訊	擷取資料湖中資料表指定欄位的統計資訊。
GetTableVersion	擷取資料表指定版本	擷取資料湖中資料表的一個指定版本。
ListTableNames	擷取資料表名稱列表	僅用於查詢資料湖資料表的名稱列表。
ListTableVersions	擷取資料表版本列表	分頁查詢資料湖中資料表指定版本的列表。
GetTableProfile	擷取表資料概況	擷取表資料概況的詳細資料。
RenameTable	更新資料表的名稱	僅用於更新資料湖中資料表的名稱。
BatchGetTables	批量擷取資料表詳情	批量擷取資料湖中資料表的詳細資料。
BatchCreateTables	批量新增資料表	批量新增資料湖的資料表。
BatchDeleteTables	大量刪除資料表	根據名稱大量刪除資料湖的資料表。
BatchDeleteTableVersions	大量刪除資料表版本	大量刪除資料湖資料表指定版本。
BatchUpdateTables	批次更新資料表資訊	批次更新資料湖中資料表詳細資訊。
分區	分區
CreatePartition	新增資料表的分區	為資料湖的資料表，新增一個分區。
DeletePartition	刪除資料表分區	刪除資料湖中資料表的指定分區。
DeletePartitionColumnStatistics	刪除資料表分區統計資訊	回收資料湖中資料表分區的欄位統計資訊。
UpdatePartitionColumnStatistics	更新資料表分區統計資訊	建立或者更新資料表分區的欄位統計資訊。
GetPartitionColumnStatistics	擷取資料分區欄位的統計資訊	擷取資料湖中資料分區指定欄位的統計資訊。
ListPartitionNames	擷取資料表分區名稱列表	擷取資料湖中資料表分區名稱列表，通常用於多級分區。
ListPartitionsByFilter	按條件取得資料表分區列表	取得資料湖中資料表分區列表，按Filter條件查詢。
BatchCreatePartitions	批量新增資料表的分區	為資料湖的資料表，批量新增多個分區。
BatchDeletePartitions	批次刪除資料表分區	批次刪除資料湖中資料表的指定分區。
BatchGetPartitionColumnStatistics	批量擷取資料分區統計資訊	批量擷取資料湖中資料表分區的欄位統計資訊。
BatchGetPartitions	批量擷取資料庫分區	批量擷取資料湖中資料庫分區詳情。
BatchUpdatePartitions	批次更新資料表的分區	為資料湖的資料表，批次更新多個分區。
RenamePartition	更新資料表分區名	更新資料湖中資料表的分區名稱。
函數	函數
ListFunctionNames	擷取資料庫的函數名稱列表	分頁查詢，擷取資料庫的函數名稱列表。
鎖	鎖
CreateLock	建立中繼資料鎖	建立一個指定的中繼資料鎖。
GetLock	查詢中繼資料鎖	查詢指定的中繼資料鎖。
AbortLock	中止中繼資料鎖	中止指定的中繼資料鎖。
RefreshLock	重新整理中繼資料鎖	重新整理指定的中繼資料鎖。
UnLock	解鎖指定的中繼資料鎖	解開指定的中繼資料鎖。
中繼資料遷移	中繼資料遷移
StopMigrationWorkflow	停止遷移工作流程	停止中繼資料遷移任務。
RunMigrationWorkflow	執行遷移工作流程	運行中繼資料遷移任務。
GetAsyncTaskStatus	擷取非同步任務狀態	用於中繼資料相關非同步API中，檢查非同步執行任務的狀態。

權限

API	標題	API概述
GrantRolesToUser	將多個角色授予給單個使用者	將多個角色授予給單個使用者。
BatchGrantPermissions	批量對User/資料湖角色授予資源的操作許可權	批量對User/資料湖角色授予資源的操作許可權。
RevokeRolesFromUser	將多個角色從單個User中移除	將多個角色從單個User中移除。
RevokePermissions	取消User/資料湖角色授與權限	取消對User/資料湖角色授予資源的操作許可權。
BatchRevokePermissions	批量取消對User/資料湖角色授與權限	批量取消對User/資料湖角色授予資源的操作許可權。
UpdateRoleUsers	更新角色中的使用者	更新角色中的user，該user包含ram user/ram role。
UpdatePermissions	對User/資料湖角色的許可權進行更新	對User/資料湖角色的許可權進行更新。
UpdateCatalogSettings	更新資料湖Catalog的配置	更新資料湖Catalog的配置，需admin角色以上角色。
ListRoleUsers	擷取單個角色的User列表	擷取單個角色的User列表。
ListUserRoles	擷取單個User的資料湖角色列表	擷取單個User的資料湖角色列表。
ListPermissions	擷取許可權列表	擷取許可權列表。
CheckPermissions	對User許可權進行校正	對使用者權限進行校正。
GetCatalogSettings	擷取資料湖Catalog的配置	擷取資料湖Catalog的配置，需admin角色以上角色。

資料探索

API	標題	API概述
GetQueryResult	擷取查詢結果	擷取資料探索查詢結果。
SubmitQuery	提交查詢	提交SQL查詢任務。
CancelQuery	取消查詢	取消查詢任務。

通用服務

API	標題	API概述
GetRegionStatus	擷取資料湖構建服務開通狀態	擷取資料湖構建指定地區的服務開通狀態。
GetServiceStatus	擷取某個使用者的服務開通狀態	擷取資料湖構建某個使用者的服務開通狀態。

其他

API	標題	API概述
SearchAcrossCatalog	跨Catalog搜尋中繼資料	跨Catalog搜尋庫、表、欄位等內容。
RegisterLocation	註冊Location	將OSS路徑註冊為由DLF管理。
DeregisterLocation	取消Location註冊	取消Location註冊。
UpdateRegisteredLocation	編輯Location	編輯登入的Location。
ListPartitionsByExpr	按條件擷取資料表分區列表	擷取資料湖中資料表分區列表，按條件查詢。
GetDatabaseProfile	擷取庫資料概況	擷取庫資料概況的詳細資料。
GetLifecycleRule	擷取庫表生命週期規則	擷取庫表生命週期規則。
ListPartitionsProfile	擷取分區資料概況	擷取分區資料概況的詳細資料。

Others

API	標題	API概述
CreateCatalog	建立資料湖資料目錄	建立資料湖資料目錄。
CreateDatabase	新增資料庫	在資料湖中繼資料中建立一個新的中繼資料庫。
CreateFunction	新增資料庫的函數	新增資料湖中資料庫的使用者自訂函數。
CreateRole	建立資料湖許可權的角色	在資料湖許可權中新增一個角色。
DeleteCatalog	刪除資料湖資料目錄	刪除資料目錄。
DeleteDatabase	刪除資料庫	根據名稱刪除資料湖中的資料庫。
DeleteFunction	刪除資料庫的函數	根據名稱刪除資料湖中資料庫的使用者自訂函數。
DeleteRole	刪除資料湖許可權中的角色	刪除資料湖許可權中的角色。
DescribeRegions	擷取開通的地區	擷取開通的地區列表。
GetCatalog	擷取目錄詳情	擷取資料目錄詳情。
GetDatabase	擷取資料庫詳情	擷取資料湖具體的一個資料庫的詳細資料。
GetFunction	擷取資料庫的指定函數	根據函數名稱，擷取資料湖中資料庫的使用者自訂函數。
GetPartition	擷取資料庫分區	擷取資料湖中資料庫分區詳情。
GetRole	擷取資料湖許可權中的角色詳情	根據角色名稱擷取資料湖許可權中的角色。
GetTable	擷取資料表詳情	擷取資料湖中資料表的詳細資料。
GrantPermissions	對User/資料湖角色授予許可權	對User/資料湖角色授予資源的操作許可權。
GrantRoleToUsers	將資料湖角色授予使用者	將資料湖角色授予多個使用者。
ListCatalogs	擷取資料目錄列表	分頁查詢，擷取中繼資料庫命名空間（Catalog）列表。
ListDatabases	擷取資料庫列表	擷取資料湖中資料庫列表，分頁查詢，可以根據資料庫名稱匹配。
ListFunctions	擷取資料庫的函數列表	批量擷取資料湖中資料庫的使用者自訂函數列表。
ListPartitions	擷取資料庫分區列表	擷取資料湖中資料庫分區詳情列表。
ListRoles	擷取資料湖角色列表	擷取資料湖角色列表。
ListTables	擷取資料表列表	擷取資料湖中資料表列表。
RevokeRoleFromUsers	將多個User從單個角色中移除	將多個User從單個資料湖角色中移除。
Search	搜尋中繼資料	中繼資料檢索。
UpdateFunction	更新資料庫的函數	根據名稱，更新資料湖中資料庫的使用者自訂函數資訊。
UpdateRole	更新資料湖許可權中的角色	更新資料湖許可權中的角色。
UpdateTable	更新資料表資訊	根據名稱更新資料湖中資料表資訊。