全部API介面功能分類概覽-Data Management-阿里雲 - Data Management

API標準及多語言預置SDK

本產品（dms-enterprise/2018-11-01）的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概述
GetUserActiveTenant	擷取當前所處的租戶資訊	擷取當前所處的租戶資訊。
ListUserTenants	擷取當前的租戶列表	擷取當前的租戶列表。
RegisterUser	錄入新使用者	錄入本企業的新使用者。

執行個體管理

API	標題	API概述
AddInstance	錄入資料庫執行個體	調用該API可以實現將您的資料庫執行個體錄入至DMS中，同時，可以為執行個體開啟安全託管能力。
ModifyInstance	修改執行個體資訊	當您需要修改執行個體的託管模式、資料庫賬密、功能包等基本資料，及環境類型、執行個體在DMS的名稱、查詢和匯出資料的逾時時間等進階資訊時，可調用該API。
RegisterInstance	錄入新的資料庫執行個體（舊）	在DMS中錄入新的資料庫執行個體。

操作稽核

API	標題	API概述
GetOpLog	擷取指定時間內的動作記錄詳情列表	擷取指定時間內的動作記錄詳情列表。
ListInstanceLoginAuditLog	擷取執行個體登入日誌	擷取執行個體登入列表資訊。
ListProxySQLExecAuditLog	擷取SQL資源審計日誌	擷取安全訪問代理審計資訊列表。
ListSQLExecAuditLog	擷取SQL審計日誌列表	擷取在DMS進行SQL操作的審計日誌列表。

審批流程

API	標題	API概述
ListWorkFlowTemplates	擷取審批模板列表	擷取審批模板列表。
ListWorkFlowNodes	擷取審批節點列表	擷取審批節點列表。
SetWorkflowExtraInfo	為審批流設定額外資訊	調用此API可以設定DMS工單審批地區是否需要顯示同意、撤銷、加簽等按鈕。

庫表中繼資料

API	標題	API概述
邏輯庫表	邏輯庫表
CreateLogicDatabase	建立邏輯庫	建立DMS邏輯庫。
AddLogicTableRouteConfig	邏輯表中配置路由演算法	為邏輯表添加路由演算法配置。
DeleteLogicDatabase	刪除邏輯庫中的物理庫	刪除DMS邏輯庫。僅刪除邏輯庫，並不會對物理分庫做任何物理刪除操作。
DeleteLogicTableRouteConfig	刪除邏輯表路由演算法	刪除邏輯表路由演算法配置資訊。
ListLogicDatabases	返回邏輯庫詳情列表	調用ListLogicDatabases介面，返回邏輯庫詳情列表。
GetLogicDatabase	擷取邏輯庫資訊	擷取邏輯庫詳情資訊。
ListLogicTables	擷取邏輯庫中的邏輯表詳情列表	擷取指定邏輯庫下面的邏輯表詳情列表。
GetDBTopology	擷取邏輯庫拓撲資訊	擷取邏輯庫與其對應物理分庫的拓撲資訊。
GetTableDBTopology	擷取邏輯表的拓撲圖	擷取資料表的拓撲圖。
ListLogicTableRouteConfig	擷取邏輯表的路由演算法列表	擷取邏輯表的路由演算法配置列表。
EditLogicDatabase	返回邏輯庫詳情資訊	編輯邏輯庫資訊。
資料湖庫表	資料湖庫表
ListDataLakeDatabase	擷取資料湖的資料庫列表	調用此API可以擷取資料湖的資料庫列表。
GetDataLakeDatabase	擷取資料湖的資料庫資訊	調用此API可以擷取資料湖中的資料庫資訊。
ListDataLakeCatalog	擷取資料湖的資料目錄列表	調用此API可以擷取資料湖的資料目錄列表。
GetDataLakeCatalog	擷取資料湖的資料目錄	調用此API可以擷取資料湖的資料目錄。
ListDataLakeTablebaseInfo	擷取資料湖中表的基本資料	調用此API可以擷取資料湖中表的基本資料。
GetDataLakeTable	擷取資料湖的表資訊	調用此API可以擷取資料湖的表資訊。
BatchCreateDataLakePartitions	批量建立湖倉表分區	調用此API可批量建立湖倉表分區。
UpdateDataLakeTable	更新湖倉表資訊	調用此API可更新湖倉表資訊。
UpdateDataLakePartition	更新湖倉表分區資訊	調用此API可更新湖倉表分區資訊。
UpdateDataLakeDatabase	更新湖倉資料庫資訊	調用此API可更新湖倉資料庫資訊。
ListDataLakeTableName	擷取資料湖表名列表	調用此API可擷取資料湖表名列表。
ListDataLakeTable	擷取資料湖表列表	調用此API可擷取資料湖表列表。
ListDataLakePartitionName	擷取資料湖表分區名列表	調用此API可擷取資料湖表分區名列表。
ListDataLakePartitionByFilter	根據篩選條件擷取資料湖表分區列表	調用此API可根據篩選條件擷取資料湖表分區列表。
ListDataLakePartition	擷取資料湖表分區列表	調用此API可擷取資料湖表分區列表。
GetDataLakePartition	擷取湖倉表分區詳情	調用此API可擷取湖倉表分區詳情。
DeleteDataLakeTable	刪除湖倉表	調用此API可刪除湖倉表。
DeleteDataLakePartition	刪除湖倉表分區	調用此API可刪除湖倉表分區。
DeleteDataLakeDatabase	刪除湖倉資料庫	調用此API可刪除湖倉資料庫。
CreateDataLakeTable	建立湖倉表	調用此API可建立湖倉表。
CreateDataLakePartition	建立湖倉表分區	調用此API可建立湖倉表分區。
CreateDataLakeDatabase	建立湖倉資料庫	調用此API可建立湖倉資料庫。
BatchUpdateDataLakePartitions	批次更新湖倉表分區	調用此API可批次更新湖倉表分區資訊。
BatchDeleteDataLakePartitions	大量刪除湖倉表分區	調用此API可大量刪除湖倉表分區。
CreateDataLakeFunction	建立資料湖自訂函數	調用此API可以建立湖倉自訂函數。
GetDataLakeFunction	擷取湖倉自訂函數的詳細資料	調用此API可擷取湖倉自訂函數的詳細資料。
UpdateDataLakeFunction	更新湖倉自訂函數	調用此API可更新湖倉自訂函數。
DeleteDataLakeFunction	刪除湖倉自訂函數	調用此API可刪除湖倉自訂函數。
ListDataLakeFunction	擷取資料湖函數列表	調用此API可擷取資料湖函數列表。
ListDataLakeFunctionName	擷取資料湖函數名稱列表	調用此API可擷取資料湖函數名稱列表。
SearchDatabase	搜尋資料庫詳情列表	搜尋庫詳情資訊。
SearchTable	搜尋表詳情列表	搜尋表詳情列表。
ListTableColumns	擷取表欄位資訊	擷取表欄位資訊。
ListIndexes	擷取表的索引資訊	調用ListIndexes返回表索引資訊。
GetPhysicalDatabase	擷取物理庫的詳情	調用GetPhysicalDatabase擷取物理庫的詳情。
GetTableTopology	擷取資料表的拓撲資訊	調用GetTableTopology擷取資料表的拓撲資訊。
GetMetaTableDetailInfo	擷取表的欄位、索引等資訊	調用GetMetaTableDetailInfo介面擷取表的欄位、索引等資訊。
GetMetaTableColumn	擷取表的欄位資訊	調用GetMetaTableColumn介面擷取表的欄位資訊。
SyncInstanceMeta	同步執行個體下所有資料庫的中繼資料	調用SyncInstanceMeta同步執行個體下所有資料庫字典中繼資料。
SyncDatabaseMeta	同步資料庫中繼資料	同步資料庫字典中繼資料。
GetTableKnowledgeInfo	擷取表的資產描述	擷取指定guid的中繼資料知識
EditMetaKnowledgeAsset	編輯中繼資料的資產描述	編輯指定guid的中繼資料業務知識

工單操作

API	標題	API概述
通用	通用
GetApprovalDetail	擷取工單審批詳情	調用GetApprovalDetail擷取工單審批詳情。
GetOrderBaseInfo	擷取工單基本資料	調用GetOrderBaseInfo擷取工單基本資料。
SubmitOrderApproval	提交工單審批	調用SubmitOrderApproval提交工單審批。
ApproveOrder	審批工單	調用ApproveOrder介面審批工單。
CloseOrder	關閉工單	調用CloseOrder關閉工單。
GetOrderAttachmentFile	擷取工單附件下載地址	調用GetOrderAttachmentFile介面，擷取工單附件下載地址。
PreviewWorkflow	預覽工單審批流	該API用於在正式提交審批前，預覽工單審批流。
權限申請	權限申請
GetOwnerApplyOrderDetail	擷取申請資料許可權工單詳情	擷取申請庫-Owner、表-Owner、執行個體-Owner的工單詳情。
GetPermApplyOrderDetail	擷取申請操作許可權的工單詳情	調用GetPermApplyOrderDetail擷取許可權申請的工單詳情。
庫表同步	庫表同步
CreateStructSyncOrder	建立結構同步工單	建立變更工單。
GetStructSyncOrderDetail	擷取結構同步的工單詳情資訊	調用GetStructSyncOrderDetail擷取結構同步的工單詳情資訊。
GetStructSyncJobDetail	擷取結構同步任務詳情	調用GetStructSyncJobDetail擷取結構同步的任務詳情。
GetStructSyncJobAnalyzeResult	擷取結構同步的任務分析結果	調用GetStructSyncJobAnalyzeResult擷取結構同步的任務分析結果。
GetStructSyncExecSqlDetail	擷取結構同步的執行SQL指令碼	調用GetStructSyncExecSqlDetail擷取結構同步的執行SQL指令碼。
SubmitStructSyncOrderApproval	提交結構同步工單至審批次程序	調用SubmitStructSyncOrderApproval提交結構同步工單至審批次程序。
ExecuteStructSync	執行結構同步工單	調用此API執行結構同步工單。
資料變更	資料變更
CreateDataCorrectOrder	建立普通資料變更工單	建立普通資料變更工單。
CreateDataCronClearOrder	建立歷史資料清理工單	建立歷史資料清理工單。
CreateDataImportOrder	建立資料匯入工單	建立資料匯入工單。
CreateFreeLockCorrectOrder	建立無鎖變更工單	建立無鎖變更工單。
ModifyDataCorrectExecSQL	修改資料變更工單SQL指令碼	修改資料變更工單提交的SQL指令碼。
PauseDataCorrectSQLJob	暫停執行資料變更工單SQL任務	暫停執行資料變更工單SQL任務。
GetDataCorrectTaskDetail	擷取工單任務詳情	擷取普通資料變更、無鎖變更、資料匯入工單任務詳情。
GetDataCronClearTaskDetailList	擷取歷史資料清理工單任務詳情	擷取歷史資料清理工單任務詳情。
GetDataCorrectRollbackFile	擷取資料變更工單提交的復原附件下載地址	調用GetDataCorrectRollbackFile介面，擷取資料變更工單提交的復原附件下載地址。
GetDataCorrectBackupFiles	擷取備份檔案下載地址	擷取資料變更工單備份檔案下載地址。
GetDataCorrectOrderDetail	擷取資料變更工單詳細資料	擷取資料變更工單詳細資料。
GetDataCronClearConfig	查詢歷史資料清理工單的定時配置	查詢歷史資料清理工單的定時配置。
GetDataCorrectSQLFile	擷取資料變更工單SQL指令碼下載地址	擷取資料變更工單的SQL指令碼附件下載地址。
ListDataCorrectPreCheckSQL	獲預檢查環節的SQL詳情	擷取資料變更工單中預檢查環節的SQL資訊列表。
ListDataCorrectPreCheckDB	擷取預檢查環節的資料庫列表	擷取資料變更工單中預檢查環節的資料庫列表。
ExecuteDataCorrect	執行資料變更工單	執行資料變更工單。
RetryDataCorrectPreCheck	重新執行資料變更工單預檢查	重新執行資料變更工單預檢查步驟。
RestartDataCorrectSQLJob	重新執行失敗的資料變更SQL任務	對已經執行失敗的資料變更SQL任務進行重試。
ListDataImportSQLPreCheckDetail	擷取資料匯入預檢SQL詳情	擷取資料匯入預檢SQL詳情。
ListDataImportSQLType	擷取資料匯入SQL類型	擷取資料匯入SQL類型。
GetDataImportSQL	擷取資料匯入的SQL	擷取資料匯入的SQL。
SkipDataCorrectRowCheck	跳過資料變更預檢查行數校正	跳過資料變更預檢查行數校正。
CreateProcCorrectOrder	建立可程式化對象變更工單	使用此API建立可程式化對象變更工單。
結構設計	結構設計
CreatePublishGroupTask	執行結構設計工單	執行結構設計工單。
ListDDLPublishRecords	擷取結構設計工單詳情	擷取結構設計工單的發布詳情。
GetTableDesignProjectFlow	擷取結構設計專案流程資訊	調用此API可擷取結構設計工單當前所在環節、是否允許返回結構設計節點、執行發布的策略等資訊。
GetTableDesignProjectInfo	擷取結構設計專案資訊	調用此API可擷取指定結構設計工單的專案資訊以及工單的變更基準庫的資訊，包含結構設計工單的狀態、工單建立者ID、基準庫的名稱和ID等。
資料匯出	資料匯出
CreateDatabaseExportOrder	建立資料庫匯出工單	建立資料庫匯出工單。
CreateDataExportOrder	建立SQL結果集匯出工單	建立SQL結果集匯出工單。
ExecuteDataExport	執行資料匯出工單	調用ExecuteDataExport執行資料匯出工單。
GetDataExportPreCheckDetail	查看SQL結果集匯出預檢查詳情	查看SQL結果集匯出工單預檢查詳情。
GetDataExportDownloadURL	擷取資料匯出結果附件下載地址	調用GetDataExportDownloadURL擷取資料匯出結果附件下載地址。
GetDatabaseExportOrderDetail	擷取資料庫匯出工單詳情	擷取資料庫匯出工單詳情。
GetDataExportOrderDetail	擷取SQL結果集匯出工單詳情	擷取SQL結果集匯出工單詳情。
GetDbExportDownloadURL	擷取資料庫匯出結果附件下載地址	調用GetDbExportDownloadURL介面，擷取資料庫匯出結果附件下載地址。
SuspendDataExportJob	中斷SQL結果集匯出任務	調用此介面可以中斷正在執行或定時執行的SQL結果集匯出任務。
PauseDataExportJob	終止SQL結果集匯出任務	調用此介面可以終止SQL結果集匯出任務。
RemoveDataExportJob	刪除資料匯出任務	調用此介面可以刪除資料匯出任務。
RestartDataExportJob	重啟SQL結果集匯出任務	調用此介面重啟SQL結果集匯出任務。
SQL 審核	SQL 審核
CreateSQLReviewOrder	建立SQL審核工單	調用CreateSQLReviewOrder建立SQL審核工單。
GetSQLReviewCheckResultStatus	擷取SQL審核工單的審核結果	擷取SQL審核工單的審核結果。
ListSQLReviewOriginSQL	擷取SQL審核工單的SQL詳情	擷取SQL審核工單的SQL詳情結果。
GetSQLReviewOptimizeDetail	擷取SQL審核最佳化建議的詳情	擷取SQL審核最佳化建議的詳情，適用於資料變更工單和SQLReview工單。
資料追蹤	資料追蹤
CreateDataTrackOrder	建立資料追蹤工單	建立資料追蹤工單。
GetDataTrackJobDegree	擷取資料追蹤任務進度	擷取資料追蹤任務進度。
GetDataTrackJobTableMeta	擷取資料追蹤表中繼資料資訊	擷取資料追蹤表中繼資料資訊。
GetDataTrackOrderDetail	擷取資料追蹤工單詳情	擷取資料追蹤工單詳情。
SearchDataTrackResult	搜尋資料追蹤日誌解析結果	搜尋資料追蹤日誌解析結果。
DownloadDataTrackResult	下載資料追蹤日誌解析結果	下載資料追蹤日誌解析結果。
QueryDataTrackResultDownloadStatus	查詢下載資料追蹤日誌解析結果進度	查詢下載資料追蹤日誌解析結果進度。
附件上傳	附件上傳
CreateUploadFileJob	上傳連結形式附件	建立上傳連結形式附件任務，獲得附件任務Key。
CreateUploadOSSFileJob	上傳OSS附件	建立上傳OSS附件任務，獲得附件任務Key。
GetUserUploadFileJob	擷取上傳附件的任務資訊	擷取上傳附件的任務資訊。
資料歸檔	資料歸檔
CreateDataArchiveOrder	建立資料歸檔工單	使用此API可以建立資料歸檔工單，將資料歸檔至專屬儲存、RDS MySQL等目標中。
GetDataArchiveOrderDetail	擷取資料歸檔工單詳情	調用此API擷取資料歸檔工單詳情，包含工單的建立時間、任務調度資訊、歸檔任務日誌和歸檔資料庫的資訊等。
GetDataArchiveCount	擷取資料歸檔工單量統計	擷取資料歸檔工單量統計，包括：歸檔成功的工單數、歸檔失敗的工單數、進行中歸檔的工單數和歸檔工單的總數。
GetPagedInstance	擷取工單任務資訊	返回指定工單的任務資訊。

SQL 任務

API	標題	API概述
ListDBTaskSQLJob	擷取SQL工作清單	擷取SQL工作清單。
ListDBTaskSQLJobDetail	擷取SQL任務的詳情資訊	擷取SQL任務的詳情資訊。
GetDBTaskSQLJobLog	擷取SQL任務日誌	擷取SQL任務調度詳情日誌。
GetOnlineDDLProgress	擷取OnlineDDL任務執行進度詳情	調用GetOnlineDDLProgress介面，擷取OnlineDDL任務執行進度詳情。

權限管理

API	標題	API概述
SetOwners	設定資源Owner角色	設定執行個體、庫、表的Owner。
ListInstanceUserPermissions	擷取執行個體的使用者權限列表	調用ListInstanceUserPermissions擷取執行個體的使用者權限列表。
ListDatabaseUserPermssions	展示具備指定資料庫許可權的使用者權限詳情	調用ListDatabaseUserPermssions展示具備指定資料庫許可權的使用者權限詳情。
ListUserPermissions	查詢指定使用者擁有的庫表許可權	調用ListUserPermissions展示指定使用者所具備的庫表許可權。
GrantUserPermission	授予使用者庫表許可權	授予使用者執行個體、庫、表許可權。
RevokeUserPermission	回收使用者庫表許可權	回收使用者執行個體、庫、表許可權。
ListAuthorizedInstancesForUser	擷取使用者有許可權的執行個體	調用此API可以擷取指定使用者有許可權的執行個體列表。
ListAuthorizedUsersForInstance	查詢有執行個體許可權的使用者	調用此API可以擷取擁有指定執行個體許可權的使用者列表。
ListAuthorizedDatabasesForUser	擷取使用者有許可權的資料庫列表	調用此API可以擷取使用者有許可權的資料庫列表。
ListAuthorizedUsersForDatabase	查詢擁有指定資料庫許可權的使用者	調用此API可以擷取擁有指定資料庫許可權的使用者列表。

安全管理

API	標題	API概述
安全規則	安全規則
CreateStandardGroup	建立安全規則集	調用CreateStandardGroup建立安全規則集。
ListStandardGroups	擷取安全規則集列表	擷取安全規則集列表。
UpdateStandardGroup	調整安全規則集的配置資訊	使用該API可以調整指定安全規則集的名稱及描述資訊。
DeleteStandardGroup	刪除安全規則集	調用DeleteStandardGroup介面可以刪除已建立的安全規則集。
GetStandardGroup	擷取安全規則集	調用GetStandardGroup介面可以擷取到租戶下已有的安全規則集資訊，包含規則名稱、描述及規則關聯執行個體的類型等資訊。
敏感資料管理	敏感資料管理
AddDesensitizationRule	添加脫敏規則	添加脫敏規則。
ListDesensitizationRule	擷取脫敏規則列表	擷取脫敏規則列表。
ModifyDesensitizationStrategy	修改欄位綁定的脫敏規則	修改欄位綁定的脫敏規則。
ListClassificationTemplates	擷取分類分級模板列表	調用ListClassificationTemplates介面，擷取分類分級模板列表資訊。
ListSensitiveDataAuditLog	查看敏感資訊審計日誌詳情	調用ListSensitiveDataAuditLog介面，查看敏感資訊審計日誌詳情。
ListSensitiveColumns	搜尋敏感欄位列表	調用ListSensitiveColumns搜尋敏感欄位列表。
ListSensitiveColumnsDetail	擷取敏感欄位詳情資訊	調用ListSensitiveColumnsDetail擷取敏感欄位詳情資訊。
ChangeColumnSecLevel	調整欄位敏感等級	調整欄位敏感等級。
ChangeColumnSecurityLevel	調整欄位安全層級	調整欄位的安全層級。
GetClassificationTemplate	擷取執行個體綁定的分類分級模板	使用此API擷取執行個體綁定的分類分級模板資訊，包含模板ID、模板類型等資訊。
ListSensitivityLevel	擷取分類分級模板的敏感序列列表	擷取分類分級模板對應的敏感序列列表。
ListSensitiveColumnInfo	擷取敏感欄位的脫敏演算法相關資訊	調用此介面可以擷取到敏感欄位所使用的脫敏演算法ID、名稱，以及欄位的安全層級等資訊。
安全存取代理	安全存取代理
CreateProxy	開啟資料安全訪問	調用CreateProxy介面，開啟執行個體的資料安全訪問功能。
DeleteProxy	關閉安全訪問代理	關閉執行個體的安全訪問代理。
ListProxies	擷取安全訪問代理列表	擷取安全訪問代理列表。
GetProxy	擷取資料安全訪問代理的詳細資料	擷取資料安全訪問代理的詳細資料。
CreateProxyAccess	授予安全訪問代理許可權	授予使用者安全訪問代理許可權。
DeleteProxyAccess	回收安全訪問代理許可權	回收目標使用者的安全訪問代理許可權。
ListProxyAccesses	擷取安全訪問代理的授權列表	擷取安全訪問代理的授權列表。
InspectProxyAccessSecret	擷取安全訪問代理的授權密碼	擷取安全訪問代理的授權密碼。
GetProxyAccess	擷取安全訪問代理授權資訊	擷取安全訪問代理的授權。
權限範本	權限範本
GrantTemplateAuthority	授予使用者權限模板中的資源許可權	授予使用者權限模板中的資源許可權。
RevokeTemplateAuthority	回收權限範本中的資源許可權	回收權限範本中的資源許可權。
CreateAuthorityTemplate	建立權限範本	建立權限範本。
UpdateAuthorityTemplate	更新權限範本	更新權限範本。
AddAuthorityTemplateItems	為權限範本添加資源	調用此API給指定權限範本添加執行個體、資料庫、表資源。
GetAuthorityTemplateItem	擷取權限範本中的資源清單	擷取權限範本中的資源清單。
GetAuthorityTemplate	擷取權限範本詳情	擷取權限範本詳情。
ListAuthorityTemplate	擷取權限範本列表	調用ListAuthorityTemplate介面擷取權限範本列表，包含模板建立者、模板名稱、模板建立者及模板總數等資訊。
DeleteAuthorityTemplate	刪除權限範本	調用DeleteAuthorityTemplate介面可以刪除已建立的權限範本。
權限原則	權限原則
CreateAbacPolicy	建立權限原則	調用此API可以建立權限原則，以協助您對DMS功能以及託管在DMS的資料資源進行細粒度的管控。
ListAbacPolicies	擷取權限原則列表	調用此API可以擷取已建立的權限原則列表。
UpdateAbacPolicy	更新權限原則資訊	調用此API可以指定更新權限原則的名稱、描述和內容。
DeleteAbacPolicy	刪除權限原則	調用此API可以刪除已建立的權限原則。
GetAbacPolicy	擷取權限原則詳情	調用此API可以擷取權限原則詳情，包含策略名稱稱、內容、建立人等資訊。
CreateAbacAuthorization	新增權限原則授權	調用此API可以給DMS使用者或自訂角色授予策略許可權，包含系統權限原則和自訂權限原則。
ListAbacAuthorizations	擷取權限原則授權列表	調用此API可以擷取指定權限原則被授權給使用者的數量及列表。
DeleteAbacAuthorization	解除權限原則授權	調用此API可以解除權限原則與使用者或角色之間的授權關係。

資料查詢

API	標題	API概述
ExecuteScript	執行SQL指令碼	調用ExecuteScript執行SQL指令碼。

資料開發

API	標題	API概述
任務編排	任務編排
UpdateTaskFlowConstants	更新任務流常量列表	調用UpdateTaskFlowConstants介面，更新任務流常量列表。
DeleteTaskFlow	刪除任務流	調用DeleteTaskFlow介面，刪除任務流。
OfflineTaskFlow	下線發行的任務流	調用OfflineTaskFlow介面，在DMS中下線發行的任務流。
ListTaskFlow	擷取任務流資訊列表	調用ListTaskFlow介面，擷取任務流資訊列表。
GetTaskInstanceRelation	擷取任務流程執行記錄的節點資訊	調用GetTaskInstanceRelation介面，擷取任務流程執行記錄的節點資訊。
ListTaskFlowInstance	擷取任務流程執行記錄	調用ListTaskFlowInstance介面，擷取任務流程執行記錄。
ListDAGVersions	擷取任務流歷史發布版本資訊列表	調用ListDAGVersions介面，擷取任務流歷史發布版本資訊列表。
ReDeployLhDagVersion	重新部署任務流歷史版本	調用ReDeployLhDagVersion介面，重新部署任務流歷史版本。
UpdateScenario	更新任務流業務情境名稱和描述	調用UpdateScenario介面，更新任務流業務情境名稱和描述。
ResumeTaskFlowInstance	恢複已暫停啟動並執行任務流	調用ResumeTaskFlowInstance介面，恢複已暫停啟動並執行任務流。
UpdateTaskContent	更新任務流中的任務	調用UpdateTaskContent介面，更新任務流中的任務。
ListTaskFlowsByPage	分頁擷取任務流詳情列表	調用ListTaskFlowsByPage介面，分頁擷取任務流詳情列表。
ListScenarios	擷取業務情境列表	調用ListScenarios介面，擷取業務情境列表。
UpdateTaskConfig	更新任務進階配置	調用UpdateTaskConfig介面，更新任務進階配置。
ListTaskFlowConstants	擷取任務流常量列表	調用ListTaskFlowConstants介面擷取任務流常量列表。
BackFill	給任務編排補資料	調用BackFill介面，給任務編排補資料。
UpdateTaskTimeVariables	更新任務時間變數	更新任務時間變數。
ListTaskFlowTimeVariables	擷取任務流時間變數列表	調用ListTaskFlowTimeVariables介面，擷取任務流時間變數列表。
UpdateTaskFlowTimeVariables	更新任務流時間變數	調用UpdateTaskFlowTimeVariables介面，更新任務流時間變數。
UpdateTaskFlowCooperators	更新任務流相關人員列表	調用UpdateTaskFlowCooperators介面，更新任務流相關人員列表。
CreateScenario	建立業務情境	調用CreateScenario介面，建立業務情境，也可以將任務流按業務情境進行分組。
UpdateSLARules	更新任務流SLA逾時提醒	調用此API可以更新任務流SLA逾時提醒。
GetRuleNumLimitOfSLA	擷取自訂SLA規則數量限制	調用GetRuleNumLimitOfSLA介面，擷取任務編排自訂SLA規則的限制數量，自訂的SLA規則數量不可超過該限制數。
GetIntervalLimitOfSLA	擷取逾時規則最小調度周期	調用GetIntervalLimitOfSLA介面，擷取任務流允許配置SLA逾時規則時，其最小調度周期限制。
ListDefaultSLARules	擷取預設SLA逾時規則	調用ListDefaultSLARules，擷取預設SLA逾時提醒規則。
ListTaskFlowCooperators	擷取任務流相關人列表	擷取任務流相關人列表。
ListSLARules	擷取自訂SLA規則列表	調用此API可以擷取自訂SLA規則列表。
MoveTaskFlowToScenario	移動任務流至指定業務情境	調用MoveTaskFlowToScenario介面，移動任務流至指定業務情境。
GetTaskFlowNotification	擷取任務流通知設定	調用GetTaskFlowNotification介面，擷取任務流通知設定。
UpdateTaskName	更新任務名稱	調用UpdateTaskName介面，更新任務名稱。
UpdateTaskOutput	更新任務節點的輸出變數	調用UpdateTaskOutput介面，更新任務節點的輸出變數。
DeleteTaskFlowEdgesByCondition	按照多條件刪除任務流邊	調用DeleteTaskFlowEdgesByCondition介面，按照多條件刪除任務流邊。
ListTaskFlowEdgesByCondition	擷取指定任務流DAG圖的邊	調用ListTaskFlowEdgesByCondition介面，多條件擷取指定任務流DAG圖的邊。
AddTaskFlowEdges	任務流節點建立有向邊	為已存在的任務流節點建立有向邊。
UpdateTaskFlowNameAndDesc	更新任務流名稱和描述	調用UpdateTaskFlowNameAndDesc介面，更新任務流名稱和描述。
GetTaskFlowGraph	擷取任務流的DAG圖	調用GetTaskFlowGraph介面擷取任務流的DAG圖。
UpdateTaskFlowEdges	更新指定任務流邊的起始節點	批次更新指定任務流的指定邊的起點節點和終點節點。
UpdateTaskFlowOwner	更新任務流Owner	調用UpdateTaskFlowOwner介面，更新任務流Owner。
UpdateTaskFlowSchedule	更新任務流調度配置	調用UpdateTaskFlowSchedule介面，更新任務流調度配置。
UpdateTaskFlowRelations	全量更新任務流邊	調用UpdateTaskFlowRelations介面，全量更新任務流邊。
UpdateTaskFlowNotification	更新任務流通知設定	調用UpdateTaskFlowNotification介面，更新任務流通知設定。
ListTasksInTaskFlow	擷取指定任務流的任務節點列表	調用ListTasksInTaskFlow介面，擷取指定任務流的任務節點列表。
CreateTaskFlow	建立任務流	調用CreateTaskFlow介面，建立任務流。
SuspendTaskFlowInstance	暫停任務流執行個體	調用SuspendTaskFlowInstance介面，暫停運行中的任務流執行個體。
ReRunTaskFlowInstance	重跑任務流執行個體	調用ReRunTaskFlowInstance介面，重跑任務流執行個體。
MakeTaskFlowInstanceSuccess	將指定任務流的狀態設定為成功	調用MakeTaskFlowInstanceSuccess介面，將指定任務流的狀態設定為成功。
PublishAndDeployTaskFlow	發布並部署指定任務流	調用PublishAndDeployTaskFlow介面，發布並部署指定任務流。
StopTaskFlowInstance	停止運行中的任務流執行個體	調用StopTaskFlowInstance介面，停止運行中的任務流執行個體。
UpdateTaskContentV2	更新任務流中的大任務	接受大容量sql檔案的更新節點內容API。
TryRunTaskFlow	試運行任務流	調用該API可試運行任務編排的任務流。
數倉開發	數倉開發
CreateLakeHouseSpace	建立新專案空間	調用CreateLakeHouseSpace介面，在DMS數倉開發中建立新的專案空間。
GetLhSpaceByName	查詢專案空間資訊	調用GetLhSpaceByName介面，根據DMS數倉開發專案空間名查詢專案空間資訊。
DeleteLakeHouseSpace	刪除專案空間	調用DeleteLakeHouseSpace介面，刪除數倉開發中的專案空間。
ListLhTaskFlowAndScenario	查詢專案空間中業務情境對應的任務流列表	查詢DMS數倉開發專案空間中業務情境對應的任務流列表。
AddLhMembers	添加專案空間管理員、空間成員或任務流開發人員	調用AddLhMembers介面，添加DMS數倉開發專案空間管理員、空間成員或任務流開發人員。
DeleteLhMembers	刪除專案空間成員或任務流開發人員	調用DeleteLhMembers介面，刪除DMS數倉開發專案空間成員或任務流開發人員。
ChangeLhDagOwner	轉交任務流責任人	轉交DMS數倉開發專案空間中的任務流責任人。

販售訂單

API	標題	API概述
ListEffectiveOrders	查詢有效訂單列表	查詢有效訂單列表。
RefundPayAsYouGoOrder	退訂已購買的DMS隨用隨付商品	調用RefundPayAsYouGoOrder介面，退訂已購買的DMS隨用隨付商品。

資產類目

API	標題	API概述
CreateMetaCategory	建立資產類目	建立資產類目。
ListMetaCategory	擷取資產類目列表	擷取資產類目列表。
UpdateMetaCategory	更新資產類目資訊	更新資產類目資訊。
DeleteMetaCategory	刪除資產類目	刪除資產類目。
ListTablesInCategory	擷取歸屬類目下的表列表	擷取類目下的表列表。
AddTableToCategory	資產類目添加表	添加表到資產類目。
RemoveTableFromCategory	從資產類目中移除表	從資產類目移除表。

SQL 血緣

API

標題

API概述

其他

API	標題	API概述
OptimizeSqlByMetaAgent	SQL最佳化	根據使用者提供的SQL資料庫ID，分析SQL效能並最佳化
FixSqlByMetaAgent	SQL報錯修複	根據使用者提供的SQL，報錯資訊和資料庫ID，分析SQL報錯原因並修複
AnswerSqlSyntaxByMetaAgent	文法回答	根據使用者提供的資料庫ID，回答對應引擎的文法問題
ListUserOwnedResources	擷取使用者Owner的資源清單	擷取使用者Owner的資源清單。
CheckBatchTableAccessPermission	批量校正表許可權	批量校正資料表許可權

Others

API	標題	API概述
AddWorkspaceUser	工作空間添加使用者	工作空間添加使用者
CheckInventoryJob	查看盤點任務狀態	查詢資產盤點任務的執行狀態與進度資訊
ConfirmInventoryKnowledge	採納盤點結果	確認盤點任務中的單條知識，將其標記為已認證
CreateForecastAgent	建立預測推演執行個體	建立 forecast agent 執行個體
CreateInventoryJob	建立盤點任務	建立資產盤點任務，對指定執行個體/資料庫/表進行知識盤點。
CreateOrder	建立工單	建立工單。
CreateTask	建立任務流任務	調用CreateTask介面，建立任務流任務。
CreateWorkspace	建立工作空間	該介面用於建立工作空間。
DeleteInstance	刪除指定執行個體	調用deleteinstance介面，在DMS中刪除指定執行個體。
DeleteScenario	刪除業務情境	調用DeleteScenario介面，刪除業務情境。
DeleteTask	刪除任務流任務	調用DeleteTask介面，刪除任務流任務。
DeleteUser	刪除產品內的雲帳號	調用該API可刪除已錄入DMS的使用者（阿里雲帳號）。
DeleteWorkspace	刪除工作空間	該介面用於刪除工作空間。
DescribeInventoryFileUploadSignature	資產盤點取得上傳檔案的憑證介面	取得資產盤點檔案 OSS 直傳憑證。
DisableUser	禁用產品內的雲帳號	可禁用產品內暫時不需要的雲帳號。
EnableUser	啟用產品內禁用的雲帳號	可啟用產品內先前已經禁用的雲帳號。
ExportInventoryAsset	匯出盤點的資產知識	全量匯出盤點任務下的表資產列表為 XLSX 檔案。
ExportInventoryKnowledge	匯出盤點結果的知識	全量匯出盤點任務產出的知識列表為 XLSX 檔案。
GetAIOrderApprovalCommentSSE	擷取大模型工單審批建議	擷取大模型工單審批建議。
GetDatabase	擷取具體庫詳情資訊	調用GetDatabase擷取具體庫詳情資訊。
GetForecastAgentInstance	擷取推演預測梳理列表	擷取 forecast agent 列表
GetInstance	擷取執行個體詳細資料	擷取執行個體詳細資料。
GetTableColumnList	擷取表的欄位知識列表	查詢表的欄位知識列表，包含欄位元資訊、業務描述、安全資訊等
GetTableInstructions	擷取表使用說明	查詢表的業務知識/使用說明（業務描述、摘要、關聯資產）
GetTableKnowledgeDetails	擷取表知識詳細資料	查詢表的資產知識詳情，包含表元資訊、業務描述、欄位列表等
GetTask	擷取任務流節點配置	調用GetTask介面，按照任務流節點ID擷取指定節點的配置，包括任務的時間變數。
GetUser	擷取使用者資訊	擷取特定的使用者資訊。
GetWorkspace	擷取工作空間詳情	該介面用於擷取工作空間的詳情資訊。
ListColumns	擷取表的列資訊	返回表的列資訊。
ListDatabases	擷取執行個體的資料庫詳情列表	調用ListDatabases擷取一個執行個體下的資料庫列表詳情資訊。
ListInstances	取得執行個體資訊列表	呼叫 ListInstances 介面，取得執行個體資訊列表。
ListInventoryJobs	擷取資產盤點工作清單	分頁查詢資產盤點任務歷史列表
ListOrders	擷取工單列表資訊	調用ListOrders擷取工單列表資訊。
ListTables	擷取資料庫的表詳情列表	調用ListTables擷取一個庫下面的表詳情列表。
ListTagMetaAsset	擷取DataAgent協作空間資料中心添加庫表資訊	擷取DataAgent協作空間資料中心添加庫表資訊。
ListUsers	擷取使用者詳情列表	擷取使用者的詳情列表。
ListWorkspaceUsers	列出工作空間的使用者	列出工作空間內的使用者
ListWorkspaces	擷取工作空間列表	該介面用於擷取租戶下的工作空間列表。
RemoveWorkspaceUser	刪除工作空間使用者	工作空間添加使用者
SearchInventoryAsset	擷取資產盤點涉及到的資產	分頁查詢盤點任務下的表資產列表
SearchInventoryKnowledge	查看盤點結果	分頁查詢盤點任務產出的知識列表，支援按關鍵詞、知識類型等條件式篩選
SearchTableAssetKnowledge	分頁查詢某張表相關的資產知識列表	分頁查詢某張表相關的資產知識列表（含表/欄位/SQL/片段等）
SearchTableKnowledge	搜尋表知識	根據使用者提供的問題，智能搜尋擷取表知識
SearchWorkspaceRoles	搜尋工作空間裡的角色列表	搜尋工作空間內的角色
SetForecastAgentInstance	設定預測推演身份	設定執行個體認證資訊
UpdateInstance	更新執行個體資訊（舊）	更新執行個體資訊，同時檢查該執行個體連通性。
UpdateUser	更新使用者資訊	更新使用者資訊。
UpdateWorkspace	更新工作空間	該介面用於更新工作空間的資訊。
UpdateWorkspaceUser	更新工作空間的使用者	修改工作空間的使用者權限等資訊