集群管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateDBCluster | 创建湖仓版集群 | 查看文档去调试 |
| ModifyDBCluster | 对湖仓版集群进行升降配 | 查看文档去调试 |
| DescribeDBClusters | 查看目标地域下的湖仓版集群列表信息 | 查看文档去调试 |
| DescribeDBClusterStatus | 查询集群的状态列表 | 查看文档去调试 |
| DescribeDBClusterAttribute | 查看指定集群的详细信息 | 查看文档去调试 |
| DeleteDBCluster | 删除集群 | 查看文档去调试 |
| ModifyDBClusterDescription | 修改指定集群的描述信息，方便集群的维护管理 | 查看文档去调试 |
| DescribeClusterNetInfo | 调用DescribeDBClusterNetInfo接口查询指定集群的网络信息 | 查看文档去调试 |
| AllocateClusterPublicConnection | 为集群申请公网连接地址 | 查看文档去调试 |
| ReleaseClusterPublicConnection | 释放指定集群的公网连接地址 | 查看文档去调试 |
| ModifyClusterConnectionString | 修改指定集群的连接地址 | 查看文档去调试 |
| DescribeClusterAccessWhiteList | 查看指定集群的IP白名单 | 查看文档去调试 |
| ModifyClusterAccessWhiteList | 修改指定集群的IP白名单 | 查看文档去调试 |
资源组管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateDBResourceGroup | 为指定的AnalyticDB MySQL湖仓版（3.0）集群创建资源组 | 查看文档去调试 |
| DescribeDBResourceGroup | 查询集群的资源组信息 | 查看文档去调试 |
| ModifyDBResourceGroup | 变更集群的资源组 | 查看文档去调试 |
| DeleteDBResourceGroup | 调用CreateDBResourceGroup接口删除指定集群的资源组 | 查看文档去调试 |
| BindDBResourceGroupWithUser | 绑定资源组 | 查看文档去调试 |
| UnbindDBResourceGroupWithUser | 为AnalyticDB MySQL集群的资源组解绑数据库账号 | 查看文档去调试 |
| DescribeApsResourceGroups | 获取数据同步时所用资源组的详细信息 | 查看文档去调试 |
| DescribeComputeResourceUsage | 查询集群资源组计算资源使用情况 | 查看文档去调试 |
| DescribeUserQuota | 查询可用配额 | 查看文档去调试 |
资源弹性计划
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateElasticPlan | 创建集群的弹性计划 | 查看文档去调试 |
| DescribeElasticPlans | 根据查询条件查询集群的弹性计划 | 查看文档去调试 |
| ModifyElasticPlan | 修改集群的弹性计划 | 查看文档去调试 |
| EnableElasticPlan | 启用集群的弹性计划 | 查看文档去调试 |
| DisableElasticPlan | 停用集群的弹性计划 | 查看文档去调试 |
| DeleteElasticPlan | 删除集群的弹性计划 | 查看文档去调试 |
| DescribeElasticPlanJobs | 查询集群的弹性计划作业 | 查看文档去调试 |
| DescribeElasticPlanAttribute | 查询集群的弹性计划详情 | 查看文档去调试 |
| DescribeElasticPlanSpecifications | 查询集群的不同类型弹性计划支持的规格列表 | 查看文档去调试 |
账号管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateAccount | 为集群创建数据库账号 | 查看文档去调试 |
| DescribeAccounts | 查询集群的数据库账号 | 查看文档去调试 |
| BindAccount | 绑定RAM用户与集群的数据库普通账号 | 查看文档去调试 |
| UnbindAccount | 解绑RAM用户与集群的数据库普通账号 | 查看文档去调试 |
| CheckBindRamUser | 检查集群数据库账号绑定的RAM账号 | 查看文档去调试 |
| ResetAccountPassword | 重置指定集群的数据库账号密码 | 查看文档去调试 |
| ModifyAccountDescription | 修改目标集群的数据库账号的备注信息 | 查看文档去调试 |
| DeleteAccount | 删除集群的数据库账号 | 查看文档去调试 |
| ModifyAccountPrivileges | 修改某一数据库账户的权限 | 查看文档去调试 |
| DescribeAccountPrivileges | 获取给定数据库账号在某个级别拥有的权限 | 查看文档去调试 |
| DescribeEnabledPrivileges | 获取支持的权限级别和权限列表 | 查看文档去调试 |
| DescribeAccountAllPrivileges | 获取给定账号拥有的所有权限，包括全局、库、表、列级别 | 查看文档去调试 |
| DescribeAccountPrivilegeObjects | 获取给定账号可见的库表列 | 查看文档去调试 |
监控信息
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeDBClusterHealthStatus | 查看集群的健康状态 | 查看文档去调试 |
| DescribeDBClusterPerformance | 查看目标集群的性能数据 | 查看文档去调试 |
| DescribeClusterResourceUsage | 查询集群资源使用情况 | 查看文档去调试 |
| DescribeClusterResourceDetail | 查询集群资源具体使用详情 | 查看文档去调试 |
| DescribeStorageResourceUsage | 查询集群存储资源使用情况 | 查看文档去调试 |
| DescribeJobResourceUsage | 获取作业资源使用统计 | 查看文档去调试 |
| DescribePerformanceViews | 获取监控视图列表 | 查看文档去调试 |
| CreatePerformanceView | 创建自定义监控视图 | 查看文档去调试 |
| ModifyPerformanceView | 修改自定义监控视图 | 查看文档去调试 |
| DescribePerformanceViewAttribute | 查看监控视图详情 | 查看文档去调试 |
| DeletePerformanceView | 删除监控视图 | 查看文档去调试 |
| ExistRunningSQLEngine | 是否有存活的SQL ENGINE | 查看文档去调试 |
Spark开发
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| PreloadSparkAppMetrics | 预加载Spark App 指标数据 | 查看文档去调试 |
| GetSparkAppMetrics | 获取Spark App指标数据 | 查看文档去调试 |
| ListSparkLogAnalyzeTasks | 获取所有的Spark日志分析任务列表 | 查看文档去调试 |
| SubmitSparkLogAnalyzeTask | 提交一个Spark日志分析任务,，服务端会开启指定Spark作业日志的分析流程并返回分析结果 | 查看文档去调试 |
| KillSparkLogAnalyzeTask | 终止一个Spark分析任务，返回尝试终止后的任务详情 | 查看文档去调试 |
| GetSparkLogAnalyzeTask | 获取Spark日志分析任务结果 | 查看文档去调试 |
| SetSparkAppLogRootPath | 更改用户Spark的日志配置 | 查看文档去调试 |
| GetSparkConfigLogPath | 查询AnalyticDB MySQL Spark中的日志配置结果，包括默认的Spark日志写入地址 | 查看文档去调试 |
| StartSparkSQLEngine | 启动Spark SQL引擎 | 查看文档去调试 |
| KillSparkSQLEngine | 关闭Spark SQL引擎 | 查看文档去调试 |
| GetSparkSQLEngineState | 查询Spark SQL引擎的状态 | 查看文档去调试 |
| DescribeSparkCodeOutput | 获取spark代码的执行结果 | 查看文档去调试 |
| DescribeSparkCodeLog | 查询Spark code的执行日志 | 查看文档去调试 |
| DescribeSparkCodeWebUi | 查询Spark应用的Web UI地址 | 查看文档去调试 |
| ListSparkTemplateFileIds | 查询集群所有保存的Spark模板文件ID | 查看文档去调试 |
| GetSparkAppWebUiAddress | 查询Spark应用的Web UI地址 | 查看文档去调试 |
| ListSparkAppAttempts | 查询指定Spark应用的重试信息 | 查看文档去调试 |
| CreateSparkTemplate | 创建Spark应用模板 | 查看文档去调试 |
| DeleteSparkTemplate | 删除Spark模板文件 | 查看文档去调试 |
| GetSparkTemplateFolderTree | 查询Spark应用的目录结构 | 查看文档去调试 |
| GetSparkTemplateFullTree | 查看Spark应用的目录结构 | 查看文档去调试 |
| GetSparkTemplateFileContent | 获取Spark应用模板的内容 | 查看文档去调试 |
| UpdateSparkTemplateFile | 更新Spark应用模板 | 查看文档去调试 |
| DeleteSparkTemplateFile | 删除Spark模板文件 | 查看文档去调试 |
| GetSparkAppAttemptLog | 查询Spark应用的重试日志 | 查看文档去调试 |
| ListSparkApps | 查看Spark应用列表 | 查看文档去调试 |
| GetSparkAppInfo | 查看Spark应用的信息 | 查看文档去调试 |
| GetSparkAppState | 查询Spark应用的状态 | 查看文档去调试 |
| GetSparkAppLog | 查询Spark应用的日志 | 查看文档去调试 |
| SubmitSparkApp | 提交Spark应用 | 查看文档去调试 |
| KillSparkApp | 强行停止运行中的Spark作业 | 查看文档去调试 |
| CreateOssSubDirectory | OSS创建子目录 | 查看文档去调试 |
数据管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeAdbMySqlColumns | 查询集群指定表的列信息 | 查看文档去调试 |
| DescribeAdbMySqlTables | 枚举集群指定数据库下所有表信息 | 查看文档去调试 |
| DescribeAdbMySqlSchemas | 枚举指定集群下所有数据库列表 | 查看文档去调试 |
| DescribeTableAccessCount | 查看指定日期内集群下目标表或所有表被访问次数 | 查看文档去调试 |
| GetViewDDL | 查询视图的创建语句 | 查看文档去调试 |
| GetViewObjects | 查询视图信息 | 查看文档去调试 |
| GetDatabaseObjects | 查询数据库信息 | 查看文档去调试 |
| GetTable | 获取表信息 | 查看文档去调试 |
| GetTableColumns | 查询列信息 | 查看文档去调试 |
| GetTableDDL | 查询建表语句 | 查看文档去调试 |
| GetTableObjects | 查询表信息 | 查看文档去调试 |
| CheckSampleDataSet | 检查内置数据集状态 | 查看文档去调试 |
| DescribeSchemas | 查询指定实例的数据库列表信息 | 查看文档去调试 |
| DescribeAllDataSource | 枚举实例下所有数据库列表、表列表和列列表 | 查看文档去调试 |
| DescribeTables | 查询指定数据库的表列表信息 | 查看文档去调试 |
| DescribeColumns | 查询指定表的列列表信息 | 查看文档去调试 |
| LoadSampleDataSet | 加载内置数据集 | 查看文档去调试 |
诊断优化
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeDiagnosisSQLInfo | 查看某个SQL的执行详情，包括执行计划、运行信息、资源使用、自诊断结果等 | 查看文档去调试 |
| DescribeDiagnosisDimensions | 查看AnalyticDB MySQL湖仓版（3.0）集群符合指定检索条件的SQL在资源组、数据库名、用户名以及访问源地址等维度下的去重统计信息 | 查看文档去调试 |
| DownloadDiagnosisRecords | 下载目标AnalyticDB MySQL湖仓版（3.0）集群中符合指定条件的查询SQL的摘要信息 | 查看文档去调试 |
| DescribeDiagnosisRecords | 调用DownloadDiagnosisRecords接口查看目标AnalyticDB MySQL湖仓版（3.0）集群中符合指定条件的SQL摘要信息 | 查看文档去调试 |
| DescribeDownloadRecords | 查看目标AnalyticDB MySQL湖仓版（3.0）集群中最近5次的SQL查询下载任务列表 | 查看文档去调试 |
| DescribeSqlPattern | 查看指定日期内AnalyticDB for MySQL集群的SQL Pattern详情 | 查看文档去调试 |
| DescribeSQLPatterns | 查看指定日期内AnalyticDB MySQL湖仓版集群的SQL Pattern列表 | 查看文档去调试 |
| DescribePatternPerformance | 查看集群指定时间段内SQL Pattern的各指标（如查询时间、平均内存消耗）详情 | 查看文档去调试 |
其他
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| ListTagResources | 查询一个或多个AnalyticDB MySQL集群已绑定的标签列表，或者查询一个或多个标签绑定的AnalyticDB MySQL集群列表 | 查看文档去调试 |
| ModifyDBClusterResourceGroup | 修改集群所属的阿里云资源组 | 查看文档去调试 |
| ModifyDBClusterVip | 修改集群访问的VIP | 查看文档去调试 |
| ModifyEssdCacheConfig | 修改集群加速配置，EIU云盘空间缓存大小 | 查看文档去调试 |
| DescribeEssdCacheConfig | 查询集群加速配置，云盘缓存空间大小，单位为GB | 查看文档去调试 |
| DescribeCompactionServiceSwitch | 查询集群加速配置中，远程Build服务是否开启 | 查看文档去调试 |
| ModifyCompactionServiceSwitch | 修改集群查询加速配置远程Build服务开关 | 查看文档去调试 |
| GrantOperatorPermission | 用户授予服务账号权限，供值班定位问题 | 查看文档去调试 |
| DescribeOperatorPermission | 查询服务账号授权情况 | 查看文档去调试 |
| RevokeOperatorPermission | 取消服务账号的授权 | 查看文档去调试 |
| DescribeLakeCacheSize | 获取集群湖存储加速缓存空间大小 | 查看文档去调试 |
| ModifyLakeCacheSize | 修改集群湖存储加速缓存空间大小 | 查看文档去调试 |
| DeleteBackups | 手动删除备份集 | 查看文档去调试 |
| DescribeKernelVersion | 调用DescrbeKernelVersion接口查看目标集群的内核版本信息 | 查看文档去调试 |
| ModifyApsWorkloadName | 修改APS工作负载名称 | 查看文档去调试 |
| CreateApsHiveJob | 创建APS Hive任务 | 查看文档去调试 |
| DescribeApsProgress | 查询APS进度 | 查看文档去调试 |
| DescribeApsMigrationWorkloads | 查询APS迁移任务工作负载列表 | 查看文档去调试 |
| DescribeApsDatasources | 查询APS数据源列表 | 查看文档去调试 |
| DeleteApsDatasoure | 删除APS数据源 | 查看文档去调试 |
| DescribeApsHiveWorkload | 查询APS Hive工作负载详情 | 查看文档去调试 |
| ModifyApsDatasoure | 修改APS数据源 | 查看文档去调试 |
| DescribeApsDatasource | 查询过APS数据源详情 | 查看文档去调试 |
| CreateApsDatasoure | 创建APS数据源 | 查看文档去调试 |
| CreateApsCopyWorkload | 创建APS复制链路 | 查看文档去调试 |
| DeleteApsJob | 删除aps任务 | 查看文档去调试 |
| ModifyApsJob | 修改aps任务 | 查看文档去调试 |
| SuspendApsJob | 暂停APS任务 | 查看文档去调试 |
| StartApsJob | 启动APS任务 | 查看文档去调试 |
| CreateAPSJob | 创建APS任务 | 查看文档去调试 |
| DescribeApsJobs | 查询APS任务列表 | 查看文档去调试 |
| DescribeApsJobDetail | DescribeApsJobDetail | 查看文档去调试 |
| KillProcess | 终止正在进行的任务 | 查看文档去调试 |
| DescribeTablePartitionDiagnose | 查询分区诊断信息 | 查看文档去调试 |
| DescribeSparkAppDiagnosisInfo | 查询Spark应用诊断信息 | 查看文档去调试 |
| DescribeSparkAppType | 查询Spark应用类型 | 查看文档去调试 |
| DescribeAvailableAdvices | 用DescribeAvailableAdvices来显示可用优化建议 | 查看文档去调试 |
| ApplyAdviceById | 应用单条优化建议 | 查看文档去调试 |
| BatchApplyAdviceByIdList | 批量应用优化建议 | 查看文档去调试 |
| DisableAdviceService | 用DisableAdviceService来关闭建议服务 | 查看文档去调试 |
| DescribeAppliedAdvices | 显示已采纳的优化建议 | 查看文档去调试 |
| EnableAdviceService | 用EnableAdviceService来开启建议服务 | 查看文档去调试 |
| DescribeTableDetail | 查看表在每个Shard的数据分布情况 | 查看文档去调试 |
| DescribeAbnormalPatternDetection | 查询异常Pattern诊断结果 | 查看文档去调试 |
| DescribeBadSqlDetection | 查看一段时间范围内影响实例稳定的BadSQL | 查看文档去调试 |
| DescribeControllerDetection | 查看接入层诊断结果 | 查看文档去调试 |
| DescribeWorkerDetection | 查询存储层诊断结果 | 查看文档去调试 |
| DescribeExecutorDetection | 查看计算层诊断结果 | 查看文档去调试 |
| DescribeAdviceServiceEnabled | 查询建议服务是否开启 | 查看文档去调试 |
| GetSparkReplSession | 获取会话状态 | 查看文档去调试 |
| ExecuteSparkReplStatement | 执行Spark作业中的部分代码 | 查看文档去调试 |
| GetSparkReplStatement | 获取一段代码的执行结果 | 查看文档去调试 |
| CancelSparkReplStatement | 终止Spark作业中的部分代码块 | 查看文档去调试 |
| StartSparkReplSession | 启动一个Spark会话 | 查看文档去调试 |
| DescribeSparkSQLDiagnosisAttribute | 查询单个Spark SQL的诊断详情 | 查看文档去调试 |
| DescribeSparkSQLDiagnosisList | 查询SparkSQL诊断列表 | 查看文档去调试 |
| DescribeAPSADBInstances | 获取APS联邦分析ADB实例列表 | 查看文档去调试 |
| GetApsManagedDatabases | 获取数据库列表 | 查看文档去调试 |
| ListApsOptimizationStrategy | 获取当前ADB实例湖存储优化策略列表 | 查看文档去调试 |
| ListApsOptimizationTasks | 获取指定类型湖存储优化策略执行过的任务列表。湖存储优化策略会周期性调度执行优化任务 | 查看文档去调试 |
| ListApsLifecycleStrategy | 获取当前ADB实例生命周期管理策略列表 | 查看文档去调试 |
| ModifyApsSlsADBJob | 修改sls投递adb数仓任务 | 查看文档去调试 |
| CreateApsSlsADBJob | 创建一个SLS到ADB数仓的APS链路 | 查看文档去调试 |
| GetCreateTableSQL | 查询某个表的建表语句 | 查看文档去调试 |
| DescribeOversizeNonPartitionTableInfos | 查看集群非分区表是否存在不合理的情况 | 查看文档去调试 |
| DescribeInclinedNodes | 查询所有存储节点的磁盘水位 | 查看文档去调试 |
| SubmitResultExportJob | 提交SQL查询并导出结果集 | 查看文档去调试 |
| ListResultExportJobHistory | 查询当前RAM用户结果集导出执行历史记录列表 | 查看文档去调试 |
| DeleteLakeStorage | 删除湖存储 | 查看文档去调试 |
| CreateLakeStorage | 创建湖存储 | 查看文档去调试 |
| GetLakeStorage | 获取湖存储 | 查看文档去调试 |
| ListLakeStorages | 列取湖存储 | 查看文档去调试 |
| UpdateLakeStorage | 更新湖存储 | 查看文档去调试 |
| ModifyClickhouseEngine | 为AnalyticDB MySQL实例开启宽表引擎；如果宽表引擎已开启，则修改宽表引擎的缓存大小 | 查看文档去调试 |
| DownloadInstanceCACertificate | 获取CA证书下载OSS路径，用于连接宽表引擎 | 查看文档去调试 |
| ListSparkWarehouseBatchSQL | 分页查询所有执行的Spark SQL | 查看文档去调试 |
| CancelSparkWarehouseBatchSQL | 取消Spark SQL执行 | 查看文档去调试 |
| GetSparkWarehouseBatchSQL | 获取Spark SQL执行结果 | 查看文档去调试 |
| ExecuteSparkWarehouseBatchSQL | 批量执行Spark SQL | 查看文档去调试 |
| ModifyUserEniVswitchOptions | 修改ENI交换机 | 查看文档去调试 |
| UpgradeKernelVersion | 升级目标AnalyticDB MySQL版集群的内核版本 | 查看文档去调试 |
| DescribeInclinedTables | 查看集群表倾斜信息 | 查看文档去调试 |
| DescribeTableStatistics | 查看集群的表统计信息 | 查看文档去调试 |
| DescribeLLMAnswer | 由大语言模型回答用户提出的关于ADB For MySQL的使用咨询问题 | 查看文档去调试 |
| DescribeLLMSimilarQuestions | 获取和用户提问相似的问题 | 查看文档去调试 |
| DescribeResourceGroupSpec | 查询资源组规格相关信息 | 查看文档去调试 |