全部API介面功能分類概覽-資料庫自治服務-阿里雲 - Database Autonomy Service

API標準及多語言預置SDK

本產品（DAS/2020-01-16）的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	標題	API概述
AddHDMInstance	接入資料庫執行個體	調用AddHDMInstance介面，將資料庫執行個體接入DAS。
Chat	DAS Agent 互動介面	DAS大模型能力非同步邏輯介面
CreateCacheAnalysisJob	建立緩衝分析任務	調用CreateCacheAnalysisJob介面，建立緩衝分析任務。
CreateCloudBenchTasks	建立壓測任務	調用CreateCloudBenchTasks介面，建立壓測任務。
CreateDiagnosticReport	建立診斷報告	調用CreateDiagnosticReport介面，建立診斷報告。
CreateKillInstanceSessionTask	建立結束會話的任務	調用CreateKillInstanceSessionTask介面，建立結束會話的任務。
CreateLatestDeadLockAnalysis	建立最近死結分析任務	建立最近死結分析任務。
CreateQueryOptimizeTag	對目標SQL進行打標	調用CreateQueryOptimizeTag介面，對目標SQL進行打標。
CreateRequestDiagnosis	發起SQL診斷請求	調用CreateRequestDiagnosis介面，發起SQL診斷請求。
CreateSecurityIPGroup	跨產品白名單模板建立介面	建立使用者跨產品白名單模板
CreateSqlLogTask	建立DAS企業版離線任務	建立詳細資料非同步任務。
CreateStorageAnalysisTask	建立空間分析任務	調用CreateStorageAnalysisTask介面，建立空間分析任務，擷取資料庫及表的空間使用資料。
DeleteCloudBenchTask	刪除壓測任務	調用DeleteCloudBenchTask介面，刪除壓測任務。
DeleteSecurityIPGroup	跨產品白名單模板刪除介面	刪除使用者跨產品白名單模板
DeleteStopGateway	刪除已停止的DBGateway中繼資料	調用DeleteStopGateway介面，刪除已停止的DBGateway中繼資料。
DescribeAuditLogs	查詢審計警示日誌	本介面一般用於資料審計警示日誌列表查詢，便於警示搜尋和警示處理。
DescribeAutoScalingConfig	查詢執行個體Auto Scaling功能配置資訊	調用DescribeAutoScalingConfig介面，查詢執行個體Auto Scaling功能配置資訊。
DescribeAutoScalingHistory	查詢執行個體Auto Scaling歷史資訊	調用DescribeAutoScalingHistory介面，查詢執行個體Auto Scaling歷史資訊。
DescribeCacheAnalysisJob	查詢快取分析任務詳情	調用DescribeCacheAnalysisJob介面，查詢快取分析任務詳情。
DescribeCacheAnalysisJobs	查詢快取分析工作清單	調用DescribeCacheAnalysisJobs介面，查詢快取分析工作清單。
DescribeCloudBenchTasks	查詢壓測工作清單	調用DescribeCloudBenchTasks介面，查詢壓測工作清單。
DescribeCloudbenchTask	查詢壓測任務	調用DescribeCloudbenchTask介面，查詢壓測任務。
DescribeCloudbenchTaskConfig	查詢壓測任務配置	調用DescribeCloudbenchTaskConfig介面，查詢壓測任務配置資訊。
DescribeDiagnosticReportList	查詢診斷報告	調用DescribeDiagnosticReportList介面，查詢診斷報告。
DescribeErrorLogRecords	查詢錯誤日誌明細	查詢實例指定時間範圍內的錯誤日誌明細。
DescribeHotBigKeys	即時擷取當前熱Key和大Key	調用DescribeHotBigKeys介面，即時擷取當前記憶體中的熱Key和大Key。
DescribeHotKeys	查詢執行個體當前的熱Key	調用DescribeHotKeys介面，查詢Redis執行個體的熱Key。
DescribeInstanceDasPro	查詢是否開啟了DAS企業版 V1或V2	調用DescribeInstanceDasPro介面，查詢指定資料庫執行個體是否開啟了DAS企業版 V1或企業版 V2。
DescribeQueryExplain	查詢SQL執行計畫	查詢SQL的執行計畫。
DescribeSecurityIPGroup	跨產品白名單模板展示介面	展示使用者跨產品白名單模板具體資訊
DescribeSecurityIPGroupRelation	跨產品白名單模板綁定資訊展示介面	展示使用者跨產品白名單模板與執行個體綁定資訊
DescribeSlowLogHistogramAsync	非同步擷取執行個體慢日誌趨勢資料	非同步擷取執行個體慢日誌趨勢資料。
DescribeSlowLogRecords	慢日誌記錄查詢	本介面用於查詢資料庫執行個體的慢日誌記錄，支援按多種條件過濾和排序。
DescribeSlowLogStatistic	慢日誌統計資訊	慢日誌統計資訊。
DescribeSqlLogConfig	查詢DAS企業版配置資訊	調用DescribeSqlLogConfig介面，查詢資料庫執行個體的DAS企業版配置資訊。
DescribeSqlLogRecords	（廢棄）查詢DAS企業版日誌明細	調用DescribeSqlLogRecords介面，查詢DAS企業版日誌明細。
DescribeSqlLogStatistic	查詢DAS企業版資料統計資訊	調用DescribeSqlLogStatistic介面，查詢DAS企業版的資料統計資訊。
DescribeSqlLogTask	查詢DAS企業版離線任務詳情	調用DescribeSqlLogTask介面，查詢DAS企業版離線任務詳情。
DescribeSqlLogTasks	查詢DAS企業版離線工作清單	查詢執行個體的審計日誌工作清單。
DescribeTopBigKeys	擷取排名前100的大Key	調用DescribeTopBigKeys介面，擷取一段時間內排名前100的大Key。
DescribeTopHotKeys	擷取排名前100的熱Key	調用DescribeTopHotKeys介面，擷取一段時間內排名前100的熱Key。
DisableAllSqlConcurrencyControlRules	關閉全部正在執行的限流規則	調用DisableAllSqlConcurrencyControlRules介面，關閉全部正在執行的限流規則。
DisableAutoResourceOptimizeRules	關閉空間片段自動回收功能	調用DisableAutoResourceOptimizeRules介面，批量關閉指定資料庫執行個體的空間片段自動回收功能。
DisableAutoThrottleRules	關閉自動SQL限流功能	調用DisableAutoThrottleRules介面，批量關閉指定資料庫執行個體的自動SQL限流功能。
DisableDasPro	關閉DAS企業版 V1	關閉指定執行個體DAS專業版。
DisableInstanceDasConfig	關閉指定Auto Scaling功能	調用DisableInstanceDasConfig介面，關閉指定Auto Scaling功能。
DisableSqlConcurrencyControl	關閉指定限流規則	調用DisableSqlConcurrencyControl介面，關閉指定限流規則。
EnableDasPro	開啟DAS企業版 V1	開啟指定執行個體DAS專業版。
EnableSqlConcurrencyControl	啟用SQL限流	調用EnableSqlConcurrencyControl介面，啟用SQL限流來控制資料庫請求訪問量和SQL並發量。
GetAsyncErrorRequestListByCode	查詢產生指定MySQL錯誤碼的SQL ID	調用GetAsyncErrorRequestListByCode介面，非同步查詢資料庫執行個體SQL洞察結果中產生指定MySQL錯誤碼的SQL ID。
GetAsyncErrorRequestStatByCode	查詢MySQL錯誤碼以及每個錯誤碼對應的SQL數量	調用GetAsyncErrorRequestStatByCode介面，非同步查詢資料庫執行個體SQL洞察結果中的MySQL錯誤碼以及每個錯誤碼對應的SQL數量。
GetAsyncErrorRequestStatResult	擷取指定SQL的執行錯誤次數	調用GetAsyncErrorRequestStatResult介面，非同步擷取資料庫執行個體SQL洞察結果中指定SQL的執行錯誤次數。
GetAutoIncrementUsageStatistic	擷取表自增ID使用資料	調用GetAutoIncrementUsageStatistic介面，擷取表自增ID的使用資料。
GetAutoResourceOptimizeRules	擷取空間片段自動回收規則	擷取指定資料庫執行個體的空間片段自動回收規則。
GetAutoThrottleRules	擷取自動SQL限流規則	擷取指定資料庫執行個體的自動SQL限流規則。
GetAutonomousNotifyEventContent	擷取執行個體自治事件內容	調用GetAutonomousNotifyEventContent介面，擷取指定資料庫執行個體自治事件的內容。
GetAutonomousNotifyEventsInRange	擷取指定類型或範圍的通知事件	調用GetAutonomousNotifyEventsInRange介面，擷取指定類型或範圍的通知事件。
GetBlockingDetailList	查詢RDS SQL Server執行個體的鎖阻塞列表	調用GetBlockingDetailList介面，查詢RDS SQL Server執行個體的鎖阻塞列表。
GetDBInstanceConnectivityDiagnosis	擷取資料庫執行個體網路連通性診斷結果	擷取使用者輸入IP地址到指定資料庫執行個體的網路連通性診斷結果。
GetDasAgentSSE	（廢棄）Das Agent 資料流介面	DAS大模型互動SSE介面。可以進行知識問答，效能診斷等功能。
GetDasProServiceUsage	查詢DAS企業版（V1或V2）儲存空間使用方式	調用GetDasProServiceUsage介面，查詢資料庫執行個體DAS企業版 V1或企業版 V2儲存空間的使用方式。
GetDasSQLLogHotData	查詢DAS企業版熱儲存資料明細	擷取審計日誌熱資料。
GetDeadLockDetail	查詢單個死結詳情	查詢單個死結詳情。
GetDeadLockDetailList	查詢RDS SQL Server執行個體的死結列表	調用GetDeadLockDetailList介面，查詢RDS SQL Server執行個體的死結詳情列表。
GetDeadLockHistory	擷取死結分析的工作清單	擷取最近死結分析、全量死結分析的歷史分析工作清單。
GetDeadlockHistogram	查詢時間範圍內全量死結分析的數量趨勢	查詢時間範圍內基於錯誤記錄檔全量死結分析的死結數量趨勢。
GetErrorRequestSample	查詢執行錯誤的SQL樣本資料	調用GetErrorRequestSample介面，非同步查詢資料庫執行個體SQL洞察結果中執行錯誤的SQL樣本資料，最多返回指定時間範圍內20條資料。
GetEventSubscription	擷取事件訂閱設定	調用GetEventSubscription介面，擷取資料庫執行個體的事件訂閱設定。
GetFullRequestOriginStatByInstanceId	按照訪問來源統計全量請求資料	調用GetFullRequestOriginStatByInstanceId介面，按照訪問來源統計資料庫執行個體SQL洞察結果中的全量請求資料。
GetFullRequestSampleByInstanceId	按照SQL ID查詢SQL樣本資料	調用GetFullRequestSampleByInstanceId介面，按照SQL ID查詢資料庫執行個體SQL洞察結果中的SQL樣本資料，最大返回20條樣本資料。
GetFullRequestStatResultByInstanceId	按照SQL ID非同步統計全量請求資料	調用GetFullRequestStatResultByInstanceId介面，按照SQL ID非同步統計資料庫執行個體SQL洞察結果中的全量請求資料。
GetInstanceGroupInspectReportDetail	查詢 DAS Agent 維運報告明細	取得 DAS Agent 維運報告詳情。
GetInstanceGroupInspectReportList	查詢DAS Agent維運報告列表	用於查詢DAS Agent生成的維運報告列表。
GetInstanceInspections	擷取資料庫執行個體巡檢評分結果	調用GetInstanceInspections介面，擷取資料庫執行個體巡檢評分的結果。
GetInstanceMissingIndexList	查詢RDS SQL Server執行個體索引缺失情況	調用GetInstanceMissingIndexList介面，查詢RDS SQL Server執行個體所有缺失索引的詳細資料。
GetInstanceSqlOptimizeStatistic	擷取自動SQL最佳化事件的統計資料	調用GetInstanceSqlOptimizeStatistic介面，擷取指定時間段內自動SQL最佳化任務的統計資料，包括任務總數和最大收益等。
GetKillInstanceSessionTaskResult	擷取結束會話任務的結果	調用GetKillInstanceSessionTaskResult介面，擷取結束會話任務的結果。
GetMongoDBCurrentOp	擷取MongoDB執行個體當前會話	調用GetMongoDBCurrentOp介面，擷取MongoDB執行個體當前會話。
GetMySQLAllSessionAsync	擷取執行個體當前會話	調用GetMySQLAllSessionAsync介面，採用非同步方式擷取執行個體當前會話資料，並按照不同維度統計會話資訊。
GetPartitionsHeatmap	擷取分區熱度資訊	調用GetPartitionsHeatmap介面，查看PolarDB-X 2.0分區訪問熱度和資料熱點。
GetPfsMetricTrends	查詢指定指標趨勢	調用GetPfsMetricTrends介面，查詢資料庫執行個體效能洞察（新版）指定指標的趨勢。
GetPfsSqlSample	擷取SQL樣本資料	調用GetPfsSqlSample介面，擷取效能洞察（新版）功能的SQL樣本資料。
GetPfsSqlSummaries	查詢按照SQL ID維度統計的全量請求資料	調用GetPfsSqlSummaries介面，查詢資料庫執行個體效能洞察（新版）中按照SQL ID維度全量請求資料。
GetQueryOptimizeDataStats	擷取查詢治理模板資料	調用GetQueryOptimizeDataStats介面，擷取查詢治理模板資料。
GetQueryOptimizeDataTop	擷取查詢治理執行個體紅榜和執行個體黑榜的資料	調用GetQueryOptimizeDataTop介面，擷取查詢治理執行個體紅榜和執行個體黑榜的資料。
GetQueryOptimizeDataTrend	擷取查詢治理趨勢資料	調用GetQueryOptimizeDataTrend介面，擷取查詢治理趨勢資料。
GetQueryOptimizeExecErrorSample	擷取執行失敗的樣本資料	調用GetQueryOptimizeExecErrorSample介面，擷取執行失敗的樣本資料。
GetQueryOptimizeExecErrorStats	擷取執行失敗的模板資料	調用GetQueryOptimizeExecErrorStats介面，擷取執行失敗的模板資料。
GetQueryOptimizeRuleList	擷取規則列表	調用GetQueryOptimizeRuleList介面，擷取規則列表。
GetQueryOptimizeShareUrl	擷取查詢治理的分享連結	調用GetQueryOptimizeShareUrl介面，擷取查詢治理的分享連結。
GetQueryOptimizeSolution	擷取治理建議	調用GetQueryOptimizeSolution介面，擷取治理建議。
GetQueryOptimizeTag	擷取SQL標籤	調用GetQueryOptimizeTag介面，擷取指定SQL的標籤。
GetRedisAllSession	擷取Redis執行個體當前會話	調用GetRedisAllSession介面，擷取Redis執行個體當前會話資料。
GetRequestDiagnosisPage	分頁擷取SQL診斷記錄	調用GetRequestDiagnosisPage介面，分頁擷取SQL診斷記錄。
GetRequestDiagnosisResult	查詢SQL診斷的結果	調用GetRequestDiagnosisResult介面，查詢SQL診斷的結果。
GetRunningSqlConcurrencyControlRules	擷取正在執行的限流規則	調用GetRunningSqlConcurrencyControlRules介面，擷取正在執行的限流規則。
GetSqlConcurrencyControlKeywordsFromSqlText	根據SQL語句產生限流關鍵詞	調用GetSqlConcurrencyControlKeywordsFromSqlText介面，根據原始SQL語句，產生限流關鍵詞串。
GetSqlConcurrencyControlRulesHistory	擷取正在執行或被觸發過的限流規則	調用GetSqlConcurrencyControlRulesHistory介面，擷取正在執行或被觸發過的限流規則。
GetSqlOptimizeAdvice	查詢自動SQL最佳化產生的診斷建議	調用GetSqlOptimizeAdvice介面，查詢DAS自動SQL最佳化產生的診斷建議。
GetStorageAnalysisResult	擷取空間分析任務的結果	調用GetStorageAnalysisResult介面，查詢空間分析任務狀態和分析結果。
GetYaoChiAgent	Business Foundation SystemAgent大模型能力介面	Business Foundation SystemAgent大模型能力介面，可以進行知識問答，效能診斷等功能
KillInstanceAllSession	結束全部會話	調用KillInstanceAllSession介面，結束指定執行個體上的全部會話。
ModifyAutoScalingConfig	修改執行個體Auto Scaling功能配置	調用ModifyAutoScalingConfig介面，修改執行個體Auto Scaling功能配置。
ModifySecurityIPGroup	跨產品白名單模板修改介面	修改使用者跨產品白名單模板
ModifySecurityIPGroupRelation	跨產品白名單模板綁定/解除綁定介面	綁定/解除綁定使用者跨產品白名單模板
ModifySqlLogConfig	開啟或配置DAS企業版	調用ModifySqlLogConfig介面，為資料庫執行個體開啟或配置DAS企業版。
RunCloudBenchTask	執行壓測任務	調用RunCloudBenchTask介面，執行壓測任務。
SetEventSubscription	配置事件訂閱設定	調用SetEventSubscription介面，設定資料庫執行個體的事件訂閱設定。
UpdateAutoResourceOptimizeRulesAsync	設定空間片段自動回收功能的配置參數	調用UpdateAutoResourceOptimizeRulesAsync介面，採用非同步方式，大量設定指定資料庫執行個體空間片段自動回收功能的配置參數。
UpdateAutoSqlOptimizeStatus	批量開啟、修改或關閉自動SQL最佳化功能	調用UpdateAutoSqlOptimizeStatus介面，批量開啟、修改或關閉自動SQL最佳化功能。
UpdateAutoThrottleRulesAsync	設定自動SQL限流配置參數	調用UpdateAutoThrottleRulesAsync介面，採用非同步方式，大量設定指定資料庫執行個體的自動SQL限流配置參數。