本產品（
云原生數據倉庫AnalyticDB MySQL版/2019-03-15）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
集群管理
| API | 標題 | API概述 |
|---|---|---|
| CreateDBCluster | 創建集群 | 創建數倉版集群。 |
| DeleteDBCluster | 刪除集群 | 刪除數倉版集群。 |
| ModifyDBCluster | 對集群進行升降配 | 對數倉版集群進行升降配。 |
| ModifyDBClusterMaintainTime | 修改集群可維護時間段 | 調用ModifyDBClusterMaintainTime接口修改實例可維護時間段。 |
| ModifyDBClusterPayType | 修改集群的付費類型 | 調用ModifyDBClusterPayType接口修改AnalyticDB MySQL集群的付費類型。 |
| ModifyAutoRenewAttribute | 設置包年包月集群自動續費狀態 | 調用ModifyAutoRenewAttribute接口設置包年包月集群自動續費狀態。 |
| ModifyDBClusterDescription | 修改集群的備注名 | 調用ModifyDBClusterDescription接口修改集群的備注名，方便維護管理。 |
| ModifyDBClusterResourceGroup | 修改數據庫集群資源組 | 調用ModifyDBClusterResourceGroup接口修改AnalyticDB MySQL集群的資源組。 |
| DescribeDBClusters | 查詢實例列表 | 查詢數倉版集群列表。 |
| DescribeDBClusterStatus | 查看集群的運行狀態 | 調用DescribeDBClusterStatus接口查詢數倉版集群的狀態列表。 |
| DescribeDBClusterAttribute | 查詢集群的詳細屬性 | 調用DescribeDBClusterAttribute接口查看目標AnalyticDB MySQL版集群的詳細信息。 |
| DescribeAutoRenewAttribute | 查詢包年包月集群自動續費狀態 | 調用DescribeAutoRenewAttribute接口查詢包年包月集群自動續費狀態。 |
| DescribeAvailableResource | 查詢指定可用區資源 | 調用DescribeAvailableResource接口查詢指定可用區資源。 |
| DescribeComputeResource | 查詢物理資源 | 調用DescribeComputeResource接口查詢數倉版集群指定地域下的計算資源規格。 |
| DescribeEIURange | 查詢彈性IO資源數量信息 | 調用DescribeEIURange接口查詢數倉版集群可選擇的彈性IO資源數量范圍。 |
| AttachUserENI | 打通用戶ENI | 為數倉版集群創建VPC彈性網卡，從而打通ADB節點到用戶VPC的網絡訪問。 |
| DetachUserENI | 關閉用戶ENI | 調用DetachUserENI接口刪除數倉版集群已創建的VPC彈性網卡。 |
| DescribeKernelVersion | 查詢集群內核版本 | 調用DescrbeKernelVersion接口查看目標數倉版集群的內核版本信息。 |
| UpgradeKernelVersion | 升級集群內核版本 | 升級目標AnalyticDB MySQL版集群的內核版本。 |
| MigrateDBCluster | 遷移集群 | 調用MigrateDBCluster將數倉版遷移至湖倉版集群。 |
資源組管理（舊版）
| API | 標題 | API概述 |
|---|---|---|
| CreateDBResourcePool | 創建資源組 | 調用CreateDBResourcePool接口創建資源組。僅適用于AnalyticDB MySQL彈性模式集群版（新版）。 |
| DeleteDBResourcePool | 刪除資源組 | 調用DeleteDBResourcePool接口刪除資源組。該接口僅適用于數倉版彈性模式集群版（新版）。 |
| ModifyDBResourcePool | 更新資源組資源 | 調用ModifyDBResourcePool接口更新資源組的資源。該接口僅適用于數倉版彈性模式集群版（新版）。 |
| DescribeDBResourcePool | 查詢集群的資源組信息 | 調用DescribeDBResourcePool接口查詢集群的資源組信息。該接口僅適用于數倉版彈性模式集群版（新版）。 |
| BindDBResourcePoolWithUser | 將資源組與數據庫用戶進行綁定 | 調用BindDBResourcePoolWithUser接口將資源組與數據庫用戶進行綁定。該接口僅適用于數倉版彈性模式集群版（新版）。 |
| UnbindDBResourcePoolWithUser | 解綁資源組用戶 | 調用UnbindDBResourcePoolWithUser接口解綁資源組用戶。該接口僅適用于數倉版彈性模式集群版（新版）。 |
資源組管理（新版）
| API | 標題 | API概述 |
|---|---|---|
| CreateDBResourceGroup | 創建資源組 | 調用CreateDBResourceGroup接口為數倉版集群創建資源組。 |
| BindDBResourceGroupWithUser | 將資源組與數據庫用戶進行綁定 | 調用BindDBResourceGroupWithUser接口為數倉版集群的資源組綁定數據庫賬號。 |
| UnbindDBResourceGroupWithUser | 解綁資源組和用戶 | 調用UnbindDBResourceGroupWithUser接口為數倉版集群的資源組解綁數據庫賬號。 |
| DescribeDBResourceGroup | 查詢數據庫資源組信息 | 調用DescribeDBResourceGroup接口查詢數倉版集群的資源組信息。 |
| ModifyDBResourceGroup | 修改數據庫集群資源組 | 調用ModifyDBResourceGroup接口變更數倉版集群資源組的節點數量或查詢模式。 |
| DeleteDBResourceGroup | 刪除資源組 | 調用DeleteDBResourceGroup接口刪除數倉版集群的指定資源組。 |
| DescribeResubmitConfig | 查詢作業投遞規則 | |
| ModifyResubmitConfig | 修改作業投遞規則 | |
| ModifySQAConfig | 修改作業投遞規則 | |
| DescribeSQAConfig | 查詢小查詢加速配置 | 調用DescribeSQAConfig接口查詢集群小查詢加速的配置。 |
彈性計劃管理
| API | 標題 | API概述 |
|---|---|---|
| CreateElasticPlan | 創建分時彈性計劃 | 調用CreateElasticPlan創建分時彈性計劃。該接口僅適用于數倉版彈性模式集群版（新版）。 |
| DeleteElasticPlan | 刪除分時彈性計劃 | 調用DeleteElasticPlan接口刪除分時彈性計劃。該接口僅適用于數倉版彈性模式集群版（新版）。 |
| ModifyElasticPlan | 修改分時彈性計劃 | 調用ModifyElasticPlan修改分時彈性計劃。該接口僅適用于數倉版彈性模式集群版（新版）。 |
| DescribeElasticDailyPlan | 查詢分時彈性計劃日計劃執行信息 | 調用DescribeElasticDailyPlan接口查詢分時彈性計劃日計劃執行信息。該接口僅適用于數倉版彈性模式集群版（新版）。 |
| DescribeElasticPlan | 查詢彈性計劃 | 調用DescribeElasticPlan接口查詢彈性計劃。該接口僅適用于數倉版彈性模式集群版（新版）。 |
數據庫
| API | 標題 | API概述 |
|---|---|---|
| DescribeTables | 獲取表信息列表 | 調用DescribeTables接口枚舉實例指定數據庫下所有表列表。 |
| DescribeAllDataSource | 枚舉數據庫列表 | 枚舉實例下所有數據庫列表、表列表和列列表。 |
| DescribeSchemas | 枚舉實例下所有數據庫列表 | 調用DescribeSchemas接口枚舉實例下所有數據庫列表。 |
| DescribeTableDetail | 查詢表詳情 | 調用DescribeTableDetail接口查看表在每個Shard的數據分布情況。 |
| DescribeProcessList | 查看集群正在運行的查詢 | 調用DescribeProcessList接口查看實例正在運行的查詢。 |
| DescribeColumns | 枚舉實例下指定表格的列列表 | 調用DescribeColumns接口枚舉實例下指定表格的列列表。 |
| DescribeTaskInfo | 查詢相關管控任務流進度 | 調用DescribeTaskInfo接口查看相關管控任務流進度。 |
| DescribeSQLPlan | 查詢基礎信息和計劃信息 | 調用DescribeSQLPlan接口查詢目標SQL，例如查詢語句或ETL（Extract Transform Load）任務語句的計劃信息。 |
| DescribeSQLPlanTask | 查詢計劃任務信息 | 調用DescribeSQLPlanTask查詢任務信息。 |
| DescribeTablePartitionDiagnose | 查詢分區診斷信息 | 調用DescribeTablePartitionDiagnose接口查詢分區診斷信息。 |
| DescribeLoadTasksRecords | 查詢加載任務記錄 | 查看異步導入導出任務的詳情。 |
| DescribeConnectionCountRecords | 查詢連接記錄數 | 返回目標AnalyticDB MySQL版集群當前的連接數。 |
| KillProcess | 終止正在進行的任務 | 調用KillProcess接口終止正在進行的任務。 |
日志管理
| API | 標題 | API概述 |
|---|---|---|
| ModifyAuditLogConfig | 修改審計日志設置 | 調用ModifyAuditLogConfig接口修改審計日志設置。 |
| DescribeAuditLogConfig | 查詢集群審計日志設置 | 查詢集群審計日志設置。 |
| DescribeAuditLogRecords | 查詢集群的SQL審計日志 | 調用DescribeAuditLogRecords接口查詢數倉版集群的SQL審計日志。 |
地域管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeRegions | 查詢用戶可選的地域和可用區 | 調用DescribeRegions接口查詢ADB可選的地域和可用區。 |
網絡管理
| API | 標題 | API概述 |
|---|---|---|
| ModifyClusterConnectionString | 修改集群的網絡連接地址 | 調用ModifyClusterConnectionString接口修改實例的網絡連接地址。 |
| DescribeDBClusterNetInfo | 查詢集群的網絡信息 | 調用DescribeDBClusterNetInfo接口查詢集群的網絡信息。 |
| AllocateClusterPublicConnection | 為集群申請公網連接地址 | 為數倉版集群申請公網連接地址。 |
| ReleaseClusterPublicConnection | 釋放集群的公網連接地址 | 調用ReleaseClusterPublicConnection接口釋放集群的公網連接地址。 |
| DescribeVSwitches | 查詢可組網信息 | 調用DescribeVSwitches接口查詢交換機列表。 |
賬號管理
| API | 標題 | API概述 |
|---|---|---|
| CreateAccount | 創建賬戶 | 調用CreateAccount接口創建賬號。 |
| DeleteAccount | 刪除數據庫賬號 | 調用DeleteAccount接口刪除數據庫賬號。 |
| ModifyAccountDescription | 修改數據庫賬號的備注信息 | 調用ModifyAccountDescription接口修改數據庫賬號的備注信息。 |
| DescribeAllAccounts | 查詢賬號信息 | 查詢指定集群、指定數據庫的賬號列表信息或某個指定賬號的信息。 |
| DescribeAccounts | 查詢數據庫賬號信息 | 調用DescribeAccounts接口查詢集群的賬號信息。 |
| DescribeOperatorPermission | 查詢集群服務賬號的授權詳情 | 調用DescribeOperatorPermission接口查詢集群服務賬號的授權詳情。 |
| GrantOperatorPermission | 為集群服務賬號授權 | 調用GrantOperatorPermission接口為集群服務賬號授權。 |
| ResetAccountPassword | 重置賬號密碼 | 調用ResetAccountPassword接口重置數據庫賬號的密碼。 |
| RevokeOperatorPermission | 撤銷集群服務賬號權限 | 調用RevokeOperatorPermission接口撤銷集群服務賬號權限。 |
標簽管理
| API | 標題 | API概述 |
|---|---|---|
| ListTagResources | 查詢標簽列表 | 調用ListTagResources查詢一個或多個AnalyticDB MySQL集群已綁定的標簽列表，或者查詢一個或多個標簽綁定的AnalyticDB MySQL集群列表。 |
| TagResources | 為集群綁定標簽 | 為AnalyticDB MySQL集群綁定標簽。 |
| UntagResources | 為指定的實例列表統一解綁標簽 | 解綁后，如果該標簽沒有綁定其他任何實例。 |
安全管理
| API | 標題 | API概述 |
|---|---|---|
| ModifyDBClusterAccessWhiteList | 創建或修改集群的白名單 | 創建或修改集群的白名單（包括IP白名單和安全組）。 |
| DescribeDBClusterAccessWhiteList | 查詢集群的IP白名單 | 調用DescribeDBClusterAccessWhiteList接口查看集群的IP白名單。 |
| DescribeDBClusterSSL | 查詢ADB實例的SSL配置 | 調用DescribeDBClusterSSL接口查詢集群的SSL配置情況。 |
| ModifyDBClusterSSL | 修改ADB實例的SSL配置 | 調用ModifyDBClusterSSL接口修改集群的SSL鏈路配置。 |
備份恢復
| API | 標題 | API概述 |
|---|---|---|
| ModifyBackupPolicy | 修改備份策略設置 | 調用ModifyBackupPolicy接口修改AnalyticDB MySQL版實例的備份策略。 |
| ModifyLogBackupPolicy | 修改日志備份策略設置 | 調用ModifyLogBackupPolicy接口修改日志備份設置。 |
| DescribeBackupPolicy | 查詢集群自動備份策略 | 調用DescribeBackupPolicy接口查看集群備份設置。 |
| DescribeBackups | 查詢備份集列表 | 查看集群的備份列表。 |
監控管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeDBClusterHealthStatus | 查詢集群健康檢查狀態 | 調用DescribeDBClusterHealthStatus接口查看數倉版集群的健康狀態。 |
| DescribeDBClusterPerformance | 查看集群性能數據 | 調用DescribeDBClusterPerformance接口查看目標集群的性能數據。 |
| DescribeDBClusterResourcePoolPerformance | 查詢集群資源池監控信息 | 查詢彈性模式集群版（新版）ADB集群的資源池監控信息。 |
| DescribeInclinedTables | 查看表監控 | 調用DescribeInclinedTables接口查看表監控。 |
運維事件
| API | 標題 | API概述 |
|---|---|---|
| ModifyMaintenanceAction | 修改維護動作 | 調用ModifyMaintenanceAction接口修改運維事件的執行時間。 |
| DescribeMaintenanceAction | 查詢運維事件的詳情 | 調用DescribeMaintenanceAction接口查詢運維事件的詳細信息。 |
SQL診斷
| API | 標題 | API概述 |
|---|---|---|
| DescribeDiagnosisTasks | Stage的子任務執行詳情 | 獲取指定查詢ID和Stage ID的分布式子任務執行詳情信息。 |
| DescribeDiagnosisRecords | 查詢診斷記錄 | 查看目標AnalyticDB MySQL版集群中符合指定檢索條件的SQL語句摘要信息。 |
| DescribeDiagnosisDimensions | 查詢診斷維度 | 查看符合指定檢索條件的SQL在資源組、數據庫名、用戶名以及訪問源地址等維度下的去重統計信息。 |
| DescribeDownloadRecords | 查詢下載記錄 | 查看目標AnalyticDB MySQL版集群中最近5次的SQL查詢下載任務列表。 |
| DownloadDiagnosisRecords | 下載診斷記錄 | 下載目標AnalyticDB MySQL版集群中符合指定條件的查詢SQL的摘要信息。 |
| DescribeDiagnosisSQLInfo | 查詢診斷SQL信息 | 查看某個SQL的執行詳情，包括執行計劃、運行信息、資源使用、自診斷結果等。 |
| DescribeDiagnosisMonitorPerformance | 查詢智能運維的監控信息 | 用于獲取用戶選定時間范圍內查詢的執行開始時間信息和結束時間信息。 |
| DescribeSQLPatterns | 查詢SQL模式列表 | 調用DescribeSQLPatterns接口查看指定日期內AnalyticDB MySQL版集群下的SQL Pattern列表。 |
| DescribePatternPerformance | 查詢模式性能 | 調用DescribePatternPerformance接口查看指定時間段內SQL Pattern的各指標（如查詢時間、平均內存消耗）詳情。 |
| EnableAdviceService | 開通建議服務 | 用EnableAdviceService來開啟建議服務。 |
| ApplyAdviceById | 應用優化建議 | 調用ApplyAdviceById接口應用一條優化建議。 |
| BatchApplyAdviceByIdList | 批量應用優化建議 | 用BatchApplyAdviceByIdList接口批量應用多條優化建議。 |
| DescribeAdviceServiceEnabled | 查詢建議服務是否開啟 | 用DescribeAdviceServiceEnabled來查詢建議服務是否開啟。 |
| DescribeAppliedAdvices | 顯示已采納的優化 | 調用DescribeAppliedAdvices接口來顯示已采納的優化建議。 |
| DescribeAvailableAdvices | 顯示可用優化建議 | 用DescribeAvailableAdvices來顯示可用優化建議。 |
| DisableAdviceService | 關閉建議服務 | 用DisableAdviceService來關閉建議服務。 |
空間分析
| API | 標題 | API概述 |
|---|---|---|
| DescribeDBClusterSpaceSummary | 查看集群的空間概覽 | 查看實例的空間概覽信息，包括總數據量、熱數據量、冷數據量、數據增長量等。 |
| DescribeTableStatistics | 查詢表統計信息 | 查詢目標AnalyticDB MySQL集群中的表信息統計詳情。 |
| DescribeExcessivePrimaryKeys | 檢測主鍵過多表 | 查看集群存在主鍵過多的表。 |
實例運行報告
| API | 標題 | API概述 |
|---|---|---|
| DescribeTableAccessCount | 查詢表訪問統計信息 | 查看指定日期內AnalyticDB MySQL版集群下目標表或所有表的被訪問次數。 |
| DescribeSqlPattern | 查詢SQL模式 | 查看指定日期內AnalyticDB MySQL版集群下的SQL模板詳情。 |