本產(chǎn)品（
云原生數(shù)據(jù)倉庫AnalyticDB MySQL版/2021-12-01）的OpenAPI采用RPC簽名風(fēng)格，簽名細(xì)節(jié)參見簽名機(jī)制說明。我們已經(jīng)為開發(fā)者封裝了常見編程語言的SDK，開發(fā)者可通過下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無需關(guān)心技術(shù)細(xì)節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過簽名機(jī)制進(jìn)行自簽名對接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費(fèi) 5個工作日左右。因此建議加入我們的服務(wù)釘釘群（78410016550），在專家指導(dǎo)下進(jìn)行簽名對接。在使用API前，您需要準(zhǔn)備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細(xì)節(jié)請參見獲取AccessKey。
地域管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeRegions | 查詢地域和可用區(qū) | 查詢AnalyticDB MySQL湖倉版支持的地域和可用區(qū)。 |
集群管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateDBCluster | 創(chuàng)建集群 | 創(chuàng)建湖倉版集群。 |
| ModifyDBCluster | 集群升降配 | 對湖倉版集群進(jìn)行升降配。 |
| DescribeDBClusters | 查詢集群列表 | 查看目標(biāo)地域下的湖倉版集群列表信息。 |
| DescribeDBClusterStatus | 查看集群的運(yùn)行狀態(tài) | 查詢集群的狀態(tài)列表。 |
| DescribeDBClusterAttribute | 查詢集群詳細(xì)信息 | 查看指定集群的詳細(xì)信息。 |
| DeleteDBCluster | 釋放集群 | 刪除集群。 |
| ModifyDBClusterDescription | 變更集群描述 | 修改指定集群的描述信息，方便集群的維護(hù)管理。 |
| DescribeClusterNetInfo | 查詢網(wǎng)絡(luò)信息 | 調(diào)用DescribeDBClusterNetInfo接口查詢指定集群的網(wǎng)絡(luò)信息。 |
| AllocateClusterPublicConnection | 申請公網(wǎng)地址 | 為集群申請公網(wǎng)連接地址。 |
| ReleaseClusterPublicConnection | 釋放公網(wǎng)地址 | 釋放指定集群的公網(wǎng)連接地址。 |
| ModifyClusterConnectionString | 修改公網(wǎng)連接地址 | 修改指定集群的公網(wǎng)連接地址。 |
| DescribeClusterAccessWhiteList | 查詢白名單 | 查看指定集群的IP白名單。 |
| ModifyClusterAccessWhiteList | 修改白名單 | 修改指定集群的IP白名單。 |
資源組管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateDBResourceGroup | 創(chuàng)建資源組 | 為指定的AnalyticDB MySQL湖倉版（3.0）集群創(chuàng)建資源組。 |
| DescribeDBResourceGroup | 查詢資源組 | 查詢集群的資源組信息。 |
| ModifyDBResourceGroup | 修改資源組 | 變更集群的資源組。 |
| DeleteDBResourceGroup | 刪除資源組 | 調(diào)用CreateDBResourceGroup接口刪除指定集群的資源組。 |
| BindDBResourceGroupWithUser | 將資源組與數(shù)據(jù)庫用戶進(jìn)行綁定 | 綁定資源組。 |
| UnbindDBResourceGroupWithUser | 解綁資源組和用戶 | 為AnalyticDB MySQL集群的資源組解綁數(shù)據(jù)庫賬號。 |
| DescribeApsResourceGroups | 查詢資源組信息 | 獲取數(shù)據(jù)同步時所用資源組的詳細(xì)信息。 |
| DescribeComputeResourceUsage | 查詢資源組計(jì)算資源使用情況 | 查詢集群資源組計(jì)算資源使用情況。 |
| DescribeUserQuota | 查詢用戶可用配額 | 查詢可用配額。 |
資源彈性計(jì)劃
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateElasticPlan | 創(chuàng)建彈性計(jì)劃 | 創(chuàng)建集群的彈性計(jì)劃。 |
| DescribeElasticPlans | 查詢彈性計(jì)劃列表 | 根據(jù)查詢條件查詢集群的彈性計(jì)劃。 |
| ModifyElasticPlan | 修改彈性計(jì)劃 | 修改集群的彈性計(jì)劃。 |
| EnableElasticPlan | 啟用彈性計(jì)劃 | 啟用集群的彈性計(jì)劃。 |
| DisableElasticPlan | 停用彈性計(jì)劃 | 停用集群的彈性計(jì)劃。 |
| DeleteElasticPlan | 刪除彈性計(jì)劃 | 刪除集群的彈性計(jì)劃。 |
| DescribeElasticPlanJobs | 查詢彈性計(jì)劃作業(yè)列表 | 查詢集群的彈性計(jì)劃作業(yè)。 |
| DescribeElasticPlanAttribute | 查詢彈性計(jì)劃詳情 | 查詢集群的彈性計(jì)劃詳情。 |
| DescribeElasticPlanSpecifications | 查詢彈性計(jì)劃支持的規(guī)格列表 | 查詢集群的不同類型彈性計(jì)劃支持的規(guī)格列表。 |
SQL審計(jì)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeAuditLogRecords | 查詢SQL審計(jì)日志 | 查詢集群的SQL審計(jì)日志。 |
| ModifyAuditLogConfig | 修改SQL審計(jì)日志設(shè)置 | 修改集群的SQL審計(jì)日志設(shè)置。 |
網(wǎng)絡(luò)管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| AttachUserENI | 打通用戶ENI | 為集群創(chuàng)建VPC彈性網(wǎng)卡。 |
| DetachUserENI | 關(guān)閉用戶ENI |
賬號管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateAccount | 創(chuàng)建數(shù)據(jù)庫賬號 | 為集群創(chuàng)建數(shù)據(jù)庫賬號。 |
| DescribeAccounts | 查詢數(shù)據(jù)庫賬號 | 查詢集群的數(shù)據(jù)庫賬號。 |
| BindAccount | 綁定RAM用戶與數(shù)據(jù)庫賬號 | 綁定RAM用戶與集群的數(shù)據(jù)庫普通賬號。 |
| UnbindAccount | 解綁RAM用戶與數(shù)據(jù)庫賬號 | 解綁RAM用戶與集群的數(shù)據(jù)庫普通賬號。 |
| CheckBindRamUser | 查詢數(shù)據(jù)庫賬號是否綁定RAM用戶 | 檢查集群數(shù)據(jù)庫賬號綁定的RAM賬號。 |
| ResetAccountPassword | 重置數(shù)據(jù)庫賬號的密碼 | 重置指定集群的數(shù)據(jù)庫賬號密碼。 |
| ModifyAccountDescription | 修改數(shù)據(jù)庫賬號的備注信息 | 修改目標(biāo)集群的數(shù)據(jù)庫賬號的備注信息。 |
| DeleteAccount | 刪除數(shù)據(jù)庫賬號 | 刪除集群的數(shù)據(jù)庫賬號。 |
| ModifyAccountPrivileges | 修改數(shù)據(jù)庫賬戶的權(quán)限 | 修改某一數(shù)據(jù)庫賬戶的權(quán)限。 |
| DescribeAccountPrivileges | 查詢數(shù)據(jù)庫賬號的權(quán)限 | 獲取給定數(shù)據(jù)庫賬號在某個級別擁有的權(quán)限。 |
| DescribeEnabledPrivileges | 查詢支持的權(quán)限級別和權(quán)限列表 | 獲取支持的權(quán)限級別和權(quán)限列表。 |
| DescribeAccountAllPrivileges | 查詢數(shù)據(jù)庫賬號的所有權(quán)限 | 獲取給定賬號擁有的所有權(quán)限，包括全局、庫、表、列級別。 |
| DescribeAccountPrivilegeObjects | 查詢數(shù)據(jù)庫賬號可見的庫表列 | 獲取給定賬號可見的庫表列。 |
備份恢復(fù)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeBackups | 查詢備份集列表 | |
| DescribeBackupPolicy | 查詢集群自動備份策略 | |
| ModifyBackupPolicy | 修改集群備份策略 | 修改集群的備份策略。 |
監(jiān)控信息
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeDBClusterHealthStatus | 查詢集群健康檢查狀態(tài) | 查看集群的健康狀態(tài)。 |
| DescribeDBClusterPerformance | 查看集群性能數(shù)據(jù) | 查看目標(biāo)集群的性能數(shù)據(jù)。 |
| DescribeClusterResourceUsage | 查詢集群資源使用情況 | 調(diào)用DescribeClusterResourceUsage接口查詢集群資源使用情況。 |
| DescribeClusterResourceDetail | 查詢集群資源具體使用詳情 | 查詢集群資源具體使用詳情。 |
| DescribeStorageResourceUsage | 查詢集群存儲資源使用情況 | 調(diào)用DescribeStorageResourceUsage接口查詢集群存儲資源使用情況。 |
| DescribeJobResourceUsage | 查詢?nèi)蝿?wù)型資源使用情況 | 獲取作業(yè)資源使用統(tǒng)計(jì)。 |
| DescribePerformanceViews | 獲取監(jiān)控視圖列表 | 獲取監(jiān)控視圖列表。 |
| CreatePerformanceView | 創(chuàng)建自定義監(jiān)控視圖 | 創(chuàng)建自定義監(jiān)控視圖。 |
| ModifyPerformanceView | 修改自定義監(jiān)控視圖 | 修改自定義監(jiān)控視圖。 |
| DescribePerformanceViewAttribute | 查看監(jiān)控視圖詳情 | 查看監(jiān)控視圖詳情。 |
| DeletePerformanceView | 刪除監(jiān)控視圖 | 刪除監(jiān)控視圖。 |
| ExistRunningSQLEngine | 檢測是否存在運(yùn)行中的Spark SQLEngine | 是否有存活的SQL ENGINE。 |
Spark開發(fā)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| PreloadSparkAppMetrics | 預(yù)加載Spark App指標(biāo)數(shù)據(jù) | 預(yù)加載Spark App 指標(biāo)數(shù)據(jù)。 |
| GetSparkAppMetrics | 查詢Spark App指標(biāo)數(shù)據(jù) | 獲取Spark App指標(biāo)數(shù)據(jù)。 |
| ListSparkLogAnalyzeTasks | 查詢Spark日志分析任務(wù)列表 | 獲取所有的Spark日志分析任務(wù)列表。 |
| SubmitSparkLogAnalyzeTask | 提交Spark日志分析任務(wù) | 提交一個Spark日志分析任務(wù),，服務(wù)端會開啟指定Spark作業(yè)日志的分析流程并返回分析結(jié)果。 |
| KillSparkLogAnalyzeTask | 終止Spark日志分析任務(wù) | 終止一個Spark分析任務(wù)，返回嘗試終止后的任務(wù)詳情。 |
| GetSparkLogAnalyzeTask | 查詢Spark日志分析任務(wù)結(jié)果 | 獲取Spark日志分析任務(wù)結(jié)果。 |
| SetSparkAppLogRootPath | 更改用戶Spark的日志配置 | 更改用戶Spark的日志配置。 |
| GetSparkConfigLogPath | 獲取Spark日志配置路徑 | 查詢AnalyticDB MySQL Spark中的日志配置結(jié)果，包括默認(rèn)的Spark日志寫入地址。 |
| StartSparkSQLEngine | 啟動Spark SQL引擎 | 啟動Spark SQL引擎。 |
| KillSparkSQLEngine | 關(guān)閉Spark SQL引擎 | 關(guān)閉Spark SQL引擎。 |
| GetSparkSQLEngineState | 查詢Spark SQL引擎狀態(tài) | 查詢Spark SQL引擎的狀態(tài)。 |
| ListSparkTemplateFileIds | 列出集群中的Spark模板文件ID | 查詢集群所有保存的Spark模板文件ID。 |
| GetSparkAppWebUiAddress | 查詢Spark Web UI地址 | 查詢Spark應(yīng)用的Web UI地址。 |
| ListSparkAppAttempts | 查詢Spark應(yīng)用的重試信息 | 查詢指定Spark應(yīng)用的重試信息。 |
| CreateSparkTemplate | 創(chuàng)建Spark應(yīng)用模板 | 創(chuàng)建Spark應(yīng)用模板。 |
| DeleteSparkTemplate | 刪除Spark模板 | 刪除Spark模板文件。 |
| GetSparkTemplateFolderTree | 查詢Spark應(yīng)用的目錄結(jié)構(gòu) | 查詢Spark應(yīng)用的目錄結(jié)構(gòu)。 |
| GetSparkTemplateFullTree | 查詢Spark應(yīng)用的目錄結(jié)構(gòu) | 查看Spark應(yīng)用的目錄結(jié)構(gòu)。 |
| GetSparkTemplateFileContent | 查詢Spark應(yīng)用模板的內(nèi)容 | 獲取Spark應(yīng)用模板的內(nèi)容。 |
| UpdateSparkTemplateFile | 更新Spark應(yīng)用模板 | 更新Spark應(yīng)用模板。 |
| DeleteSparkTemplateFile | 刪除Spark模板 | 刪除Spark模板文件。 |
| GetSparkAppAttemptLog | 查詢Spark應(yīng)用的重試日志 | 查詢Spark應(yīng)用的重試日志。 |
| ListSparkApps | 查詢Spark應(yīng)用列表 | 查看Spark應(yīng)用列表。 |
| GetSparkAppInfo | 查詢Spark應(yīng)用的信息 | 查看Spark應(yīng)用的信息。 |
| GetSparkAppState | 查詢Spark應(yīng)用的狀態(tài) | 查詢Spark應(yīng)用的狀態(tài)。 |
| GetSparkAppLog | 查詢Spark應(yīng)用日志 | 查詢Spark應(yīng)用的日志。 |
| SubmitSparkApp | 提交Spark應(yīng)用 | 提交Spark應(yīng)用。 |
| KillSparkApp | 強(qiáng)行停止運(yùn)行中的Spark作業(yè) | 強(qiáng)行停止運(yùn)行中的Spark作業(yè)。 |
數(shù)據(jù)管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeAdbMySqlColumns | 查詢表的列信息 | 查詢集群指定表的列信息。 |
| DescribeAdbMySqlTables | 查詢數(shù)據(jù)庫下所有表信息 | 枚舉集群指定數(shù)據(jù)庫下所有表信息。 |
| DescribeAdbMySqlSchemas | 查詢所有數(shù)據(jù)庫列表 | 枚舉指定集群下所有數(shù)據(jù)庫列表。 |
| GetViewDDL | 查詢視圖的創(chuàng)建語句 | 查詢視圖的創(chuàng)建語句。 |
| GetViewObjects | 查詢視圖信息 | 查詢視圖信息。 |
| GetDatabaseObjects | 查詢數(shù)據(jù)庫信息 | 查詢數(shù)據(jù)庫信息。 |
| GetTable | 查詢表信息 | 獲取表信息。 |
| GetTableColumns | 查詢列信息 | 查詢列信息。 |
| GetTableDDL | 查詢建表語句 | 查詢建表語句。 |
| GetTableObjects | 查詢表信息 | 查詢表信息。 |
| CheckSampleDataSet | 檢查內(nèi)置數(shù)據(jù)集狀態(tài) | |
| DescribeSchemas | 枚舉實(shí)例的庫列表 | 查詢指定實(shí)例的數(shù)據(jù)庫列表信息。 |
| DescribeAllDataSource | 枚舉數(shù)據(jù)庫列表 | 枚舉實(shí)例下所有數(shù)據(jù)庫列表、表列表和列列表。 |
| DescribeTables | 枚舉數(shù)據(jù)庫的表列表 | 查詢指定數(shù)據(jù)庫的表列表信息。 |
| DescribeColumns | 枚舉表的列列表 | 查詢指定表的列列表信息。 |
| LoadSampleDataSet | 加載內(nèi)置數(shù)據(jù)集 | 調(diào)用LoadSampleDataSet接口加載內(nèi)置數(shù)據(jù)集。 |
診斷優(yōu)化
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeSqlPattern | 查詢SQL Pattern詳情 | 查看指定日期內(nèi)AnalyticDB for MySQL集群的SQL Pattern詳情。 |
| DescribeSQLPatterns | 查詢SQL Pattern列表 | 查看指定日期內(nèi)AnalyticDB MySQL湖倉版集群的SQL Pattern列表。 |
| DescribePatternPerformance | 查詢SQL Pattern的指標(biāo) | 查看集群指定時間段內(nèi)SQL Pattern的各指標(biāo)（如查詢時間、平均內(nèi)存消耗）詳情。 |
空間分析
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeDBClusterSpaceSummary | 查看集群的空間概覽 | 查看實(shí)例的空間概覽信息，包括總數(shù)據(jù)量、熱數(shù)據(jù)量、冷數(shù)據(jù)量、數(shù)據(jù)增長量等。 |
| DescribeExcessivePrimaryKeys | 檢測主鍵過多表 | 查看集群存在主鍵過多的表信息。 |
運(yùn)維管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ModifyDBClusterMaintainTime | 修改可維護(hù)時間段 | 修改指定集群的可維護(hù)時間段。 |
查詢鏈接
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeApsActionLogs | 查詢實(shí)時數(shù)據(jù)接入任務(wù)的日志 | 查詢集群實(shí)時數(shù)據(jù)接入任務(wù)的日志詳細(xì)信息。 |
其他
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListTagResources | 查詢標(biāo)簽列表 | 調(diào)用ListTagResources查詢一個或多個AnalyticDB MySQL集群已綁定的標(biāo)簽列表，或者查詢一個或多個標(biāo)簽綁定的AnalyticDB MySQL集群列表。 |
| ModifyDBClusterResourceGroup | 修改集群所屬的資源組 | 修改集群所屬的阿里云資源組。 |
| ModifyDBClusterVip | 修改集群訪問VIP | 修改集群訪問的VIP。 |
| ModifyEssdCacheConfig | 修改云盤緩存 | 修改集群加速配置，EIU云盤空間緩存大小。 |
| DescribeEssdCacheConfig | 查詢集群云盤緩存空間 | 查詢集群加速配置，云盤緩存空間大小，單位為GB。 |
| DescribeCompactionServiceSwitch | 查詢集群加速配置 | 查詢集群加速配置中，遠(yuǎn)程Build服務(wù)是否開啟。 |
| ModifyCompactionServiceSwitch | 修改遠(yuǎn)程Build服務(wù)開關(guān) | 修改集群查詢加速配置遠(yuǎn)程Build服務(wù)開關(guān)。 |
| GrantOperatorPermission | 授予服務(wù)賬號權(quán)限 | 用戶授予服務(wù)賬號權(quán)限，供值班定位問題。 |
| DescribeOperatorPermission | 查詢服務(wù)賬號授權(quán)情況 | 查詢服務(wù)賬號授權(quán)情況。 |
| RevokeOperatorPermission | 取消授權(quán)服務(wù)賬號 | 取消服務(wù)賬號的授權(quán)。 |
| DescribeLakeCacheSize | 查詢湖存儲緩存空間設(shè)置 | 獲取集群湖存儲加速緩存空間大小 |
| ModifyLakeCacheSize | 修改湖存儲緩存空間 | 修改集群湖存儲加速緩存空間大小 |
| DeleteBackups | 刪除備份集 | 手動刪除備份集。 |
| DescribeKernelVersion | 查詢集群內(nèi)核版本 | 調(diào)用DescrbeKernelVersion接口查看目標(biāo)集群的內(nèi)核版本信息。 |