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