API接口参考大全按功能分类-云原生数据仓库AnalyticDB-阿里云

本产品（adb/2021-12-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

地域管理

API	标题	API概述
DescribeRegions	查询地域和可用区	查询AnalyticDB MySQL湖仓版支持的地域和可用区。

集群管理

API	标题	API概述
DescribeDBClusters	查询集群列表	查看目标地域下的湖仓版集群列表信息。
CreateDBCluster	创建集群	创建湖仓版集群。
ModifyDBCluster	集群升降配	对湖仓版集群进行升降配。
DeleteDBCluster	释放集群	删除集群。
DescribeDBClusterAttribute	查询集群详细信息	查看指定集群的详细信息。
DescribeKernelVersion	查询集群内核版本	调用DescrbeKernelVersion接口查看目标集群的内核版本信息。
UpgradeKernelVersion	升级集群内核版本	升级目标AnalyticDB MySQL版集群的内核版本。
DescribeDBClusterStatus	查询集群的状态列表	查询集群的状态列表。
ModifyDBClusterDescription	变更集群描述	修改指定集群的描述信息，方便集群的维护管理。
DescribeClusterAccessWhiteList	查询白名单	查看指定集群的IP白名单。
ModifyClusterAccessWhiteList	修改白名单	修改指定集群的IP白名单。
ModifyClickhouseEngine	开启和修改宽表引擎	为AnalyticDB MySQL实例开启宽表引擎；如果宽表引擎已开启，则修改宽表引擎的缓存大小。

资源组管理

API	标题	API概述
DescribeResourceGroupSpec	查询资源组规格	查询资源组规格相关信息。
CreateDBResourceGroup	创建资源组	为指定的企业版、基础版或湖仓版集群创建资源组。
DescribeDBResourceGroup	查询资源组	查询集群的资源组信息。
ModifyDBResourceGroup	修改资源组	变更集群的资源组。
DeleteDBResourceGroup	删除资源组	调用CreateDBResourceGroup接口删除指定集群的资源组。
BindDBResourceGroupWithUser	将资源组与数据库用户进行绑定	绑定资源组。
UnbindDBResourceGroupWithUser	解绑资源组和用户	为AnalyticDB MySQL集群的资源组解绑数据库账号。
DescribeComputeResourceUsage	查询资源组计算资源使用情况	查询集群资源组计算资源使用情况。
DescribeUserQuota	查询用户可用配额	查询可用配额。

资源弹性计划

API	标题	API概述
CreateElasticPlan	创建弹性计划	创建集群的弹性计划。
DescribeElasticPlans	查询弹性计划列表	根据查询条件查询集群的弹性计划。
ModifyElasticPlan	修改弹性计划	修改集群的弹性计划。
EnableElasticPlan	启用弹性计划	启用集群的弹性计划。
DisableElasticPlan	停用弹性计划	停用集群的弹性计划。
DeleteElasticPlan	删除弹性计划	删除集群的弹性计划。
DescribeElasticPlanJobs	查询弹性计划作业列表	查询集群的弹性计划作业。
DescribeElasticPlanAttribute	查询弹性计划详情	查询集群的弹性计划详情。
DescribeElasticPlanSpecifications	查询弹性计划支持的规格列表	查询集群的不同类型弹性计划支持的规格列表。

SQL审计

API	标题	API概述
DescribeAuditLogRecords	查询SQL审计日志	查询集群的SQL审计日志。
ModifyAuditLogConfig	修改SQL审计日志设置	修改集群的SQL审计日志设置。
DescribeSparkAuditLogRecords	查询Spark Interactive资源组的SQL审计日志。	查询Spark Interactive资源组的SQL审计日志。

网络管理

API	标题	API概述
DescribeClusterNetInfo	查询网络信息	调用DescribeDBClusterNetInfo接口查询指定集群的网络信息。
AllocateClusterPublicConnection	申请公网地址	为集群申请公网连接地址。
ReleaseClusterPublicConnection	释放公网地址	释放指定集群的公网连接地址。
ModifyClusterConnectionString	修改连接地址	修改指定集群的连接地址。
AttachUserENI	打通用户ENI	为集群创建VPC弹性网卡。
DetachUserENI	关闭用户ENI	解绑用户弹性网卡
ModifyUserEniVswitchOptions	修改用户ENI交换机列表	修改ENI交换机。
ModifyDBClusterVip	修改集群访问VIP	修改集群访问的VIP。
ModifyDBClusterSSL	修改ADB实例的SSL配置	修改集群的SSL链路配置。
DescribeDBClusterSSL	查询ADB实例的SSL配置	查询集群的SSL配置情况。
DownloadInstanceCACertificate	获取证书下载地址	获取CA证书下载OSS路径，用于连接宽表引擎。

账号管理

API	标题	API概述
DescribeAccounts	查询数据库账号	查询集群的数据库账号。
CreateAccount	创建数据库账号	为集群创建数据库账号。
DeleteAccount	删除数据库账号	删除集群的数据库账号。
ModifyAccountDescription	修改数据库账号的备注信息	修改目标集群的数据库账号的备注信息。
ResetAccountPassword	重置数据库账号的密码	重置指定集群的数据库账号密码。
CheckBindRamUser	查询当前RAM用户是否绑定数据库账号	检查当前调用接口的RAM用户，是否已绑定集群数据库账号。
BindAccount	绑定RAM用户与数据库账号	绑定RAM用户与集群的数据库普通账号。
UnbindAccount	解绑RAM用户与数据库账号	解绑RAM用户与集群的数据库普通账号。
ModifyAccountPrivileges	修改数据库账户的权限	修改某一数据库账户的权限。
DescribeAccountPrivileges	查询数据库账号的权限	获取给定数据库账号在某个级别拥有的权限。
DescribeEnabledPrivileges	查询支持的权限级别和权限列表	获取支持的权限级别和权限列表。
DescribeAccountAllPrivileges	查询数据库账号的所有权限	获取给定账号拥有的所有权限，包括全局、库、表、列级别。
DescribeAccountPrivilegeObjects	查询数据库账号可见的库表列	获取给定账号可见的库表列。
DescribeOperatorPermission	查询服务账号授权情况	查询服务账号授权情况。
RevokeOperatorPermission	取消授权服务账号	取消服务账号的授权。
GrantOperatorPermission	授予服务账号权限	用户授予服务账号权限，供值班定位问题。

备份恢复

API	标题	API概述
DescribeBackupPolicy	查询集群自动备份策略	查看集群备份设置
ModifyBackupPolicy	修改集群备份策略	修改集群的备份策略。
DescribeBackups	查询备份集列表	查询实例备份集
CreateBackup	立即创建一个临时备份	立即创建一个备份集。
DeleteBackups	删除备份集	手动删除备份集。

监控信息

API	标题	API概述
DescribeHistoryTasks	查询历史运维任务	获取历史任务记录。
DescribeHistoryTasksStat	统计历史任务	任务中心任务统计。
DescribeExecutorDetection	计算节点检测	查看计算层诊断结果。
DescribeWorkerDetection	预留节点检测	查询存储层诊断结果。
DescribeControllerDetection	接入节点检测	查看接入层诊断结果。
DescribeBadSqlDetection	BadSQL检测	查看一段时间范围内影响实例稳定的BadSQL。
DescribeAbnormalPatternDetection	查询异常模式检测	查询异常Pattern诊断结果。
DescribeInclinedNodes	查询存储节点磁盘水位	查询所有存储节点的磁盘水位。
DescribeDBClusterHealthStatus	查询集群健康检查状态	查看集群的健康状态。
DescribeDBClusterPerformance	查看集群性能数据	查看目标集群的性能数据。
DescribeClusterResourceUsage	查询集群资源使用情况	调用DescribeClusterResourceUsage接口查询集群资源使用情况。
DescribeClusterResourceDetail	查询集群资源具体使用详情	查询集群资源具体使用详情。
DescribeStorageResourceUsage	查询集群存储资源使用情况	调用DescribeStorageResourceUsage接口查询集群存储资源使用情况。
DescribeJobResourceUsage	查询任务型资源使用情况	获取作业资源使用统计。
DescribePerformanceViews	获取监控视图列表	获取监控视图列表。
CreatePerformanceView	创建自定义监控视图	创建自定义监控视图。
ModifyPerformanceView	修改自定义监控视图	修改自定义监控视图。
DescribePerformanceViewAttribute	查看监控视图详情	查看监控视图详情。
DeletePerformanceView	删除监控视图	删除监控视图。
ExistRunningSQLEngine	检测是否存在运行中的Spark SQLEngine	是否有存活的SQL ENGINE。

Spark开发

API	标题	API概述
ExecuteSparkWarehouseBatchSQL	批量执行Spark SQL	批量执行Spark SQL。
CancelSparkWarehouseBatchSQL	取消Spark SQL执行	取消Spark SQL执行。
ListSparkWarehouseBatchSQL	分页查询所有执行的Spark SQL	分页查询所有执行的Spark SQL。
GetSparkWarehouseBatchSQL	获取Spark SQL执行结果	获取Spark SQL执行结果。
StartSparkReplSession	启动一个Spark会话	启动一个Spark会话。
GetSparkReplStatement	获取一段代码的执行结果	获取一段代码的执行结果。
ExecuteSparkReplStatement	执行Spark作业中的部分代码	执行Spark作业中的部分代码。
CancelSparkReplStatement	终止Spark作业中的部分代码块	终止Spark作业中的部分代码块。
GetSparkReplSession	获取会话状态	获取会话状态。
DescribeSparkAppType	查询Spark应用类型	查询Spark应用类型。
PreloadSparkAppMetrics	预加载Spark App指标数据	预加载Spark App 指标数据。
GetSparkAppMetrics	查询Spark App指标数据	获取Spark App指标数据。
ListSparkLogAnalyzeTasks	查询Spark日志分析任务列表	获取所有的Spark日志分析任务列表。
SubmitSparkLogAnalyzeTask	提交Spark日志分析任务	提交一个Spark日志分析任务,，服务端会开启指定Spark作业日志的分析流程并返回分析结果。
KillSparkLogAnalyzeTask	终止Spark日志分析任务	终止一个Spark分析任务，返回尝试终止后的任务详情。
GetSparkLogAnalyzeTask	查询Spark日志分析任务结果	获取Spark日志分析任务结果。
SetSparkAppLogRootPath	更改用户Spark的日志配置	更改用户Spark的日志配置。
GetSparkConfigLogPath	获取Spark日志配置路径	查询AnalyticDB MySQL Spark中的日志配置结果，包括默认的Spark日志写入地址。
StartSparkSQLEngine	启动Spark SQL引擎	启动Spark SQL引擎。
KillSparkSQLEngine	关闭Spark SQL引擎	关闭Spark SQL引擎。
GetSparkSQLEngineState	查询Spark SQL引擎状态	查询Spark SQL引擎的状态。
DescribeSparkCodeOutput	查询产品的代码配置详情	获取spark代码的执行结果。
DescribeSparkCodeLog	查询产品的代码日志	查询Spark code的执行日志。
DescribeSparkCodeWebUi	查询Spark code的web ui	查询Spark应用的Web UI地址。
ListSparkTemplateFileIds	列出集群中的Spark模板文件ID	查询集群所有保存的Spark模板文件ID。
GetSparkAppWebUiAddress	查询Spark Web UI地址	查询Spark应用的Web UI地址。
ListSparkAppAttempts	查询Spark应用的重试信息	查询指定Spark应用的重试信息。
CreateSparkTemplate	创建Spark应用模板	创建Spark应用模板。
DeleteSparkTemplate	删除Spark模板	删除Spark模板文件。
GetSparkTemplateFolderTree	查询Spark应用的目录结构	查询Spark应用的目录结构。
GetSparkTemplateFullTree	查询Spark应用的目录结构	查看Spark应用的目录结构。
GetSparkTemplateFileContent	查询Spark应用模板的内容	获取Spark应用模板的内容。
UpdateSparkTemplateFile	更新Spark应用模板	更新Spark应用模板。
DeleteSparkTemplateFile	删除Spark模板	删除Spark模板文件。
GetSparkAppAttemptLog	查询Spark应用的重试日志	查询Spark应用的重试日志。
ListSparkApps	查询Spark应用列表	查看Spark应用列表。
GetSparkAppInfo	查询Spark应用的信息	查看Spark应用的信息。
GetSparkAppState	查询Spark应用的状态	查询Spark应用的状态。
GetSparkAppLog	查询Spark应用日志	查询Spark应用的日志。
SubmitSparkApp	提交Spark应用	提交Spark应用。
KillSparkApp	强行停止运行中的Spark作业	强行停止运行中的Spark作业。
CreateOssSubDirectory	创建oss目录	OSS创建子目录。

数据管理

API	标题	API概述
DescribeViewJobs	查询物化视图刷新任务列表	获取视图任务
DescribeTableDetail	查询表详情	调用DescribeTableDetail接口查看表在每个Shard的数据分布情况。
GetCreateTableSQL	查询某个表的建表语句	查询某个表的建表语句。
DescribeTableStatistics	查看表统计信息	查看集群的表统计信息。
DescribeAdbMySqlTableMeta	查看表元数据信息	用于查看表元数据信息。
DescribeAdbMySqlIndexes	查看表索引信息	用于查看表索引信息。
DescribeMvRecommendSubTasks	查询物化视图推荐任务执行列表	查看物化视图子任务
DescribeMVRecommendResults	查询物化视图推荐结果列表	查询物化视图推荐任务结果。
DescribeMvRecommendTasks	查询物化视图推荐任务列表	查看物化视图推荐任务
CreateMaterializedViewRecommend	创建物化视图自动推荐任务	创建物化视图自动推荐任务。
ModifyMaterializedView	修改物化视图	修改物化视图。
ModifyMaterializedViewRecommend	修改物化视图自动推荐任务	修改物化视图自动推荐任务。
DeleteMaterializedViewRecommend	删除物化视图自动推荐任务	删除物化视图自动推荐任务。
DescribeInclinedTables	查看表监控	查看集群表倾斜信息。
DescribeAdbMySqlColumns	查询表的列信息	查询集群指定表的列信息。
DescribeAdbMySqlTables	查询数据库下所有表信息	枚举集群指定数据库下所有表信息。
DescribeAdbMySqlSchemas	查询所有数据库列表	枚举指定集群下所有数据库列表。
DescribeTableAccessCount	查询表的访问次数	查看指定日期内集群下目标表或所有表被访问次数。
GetViewDDL	查询视图的创建语句	查询视图的创建语句。
GetViewObjects	查询视图信息	查询视图信息。
GetDatabaseObjects	查询数据库信息	查询数据库信息。
GetTable	查询表信息	获取表信息。
GetTableColumns	查询列信息	查询列信息。
GetTableDDL	查询建表语句	查询建表语句。
GetTableObjects	查询表信息	查询表信息。
DescribeSchemas	枚举实例的库列表	查询指定实例的数据库列表信息。
DescribeAllDataSource	枚举数据库列表	枚举实例下所有数据库列表、表列表和列列表。
DescribeTables	枚举数据库的表列表	查询指定数据库的表列表信息。
DescribeColumns	枚举表的列列表	查询指定表的列列表信息。
LoadSampleDataSet	加载内置数据集	调用LoadSampleDataSet接口加载内置数据集。

诊断优化

API	标题	API概述
GetADBSparkNecessaryRAMPermissions	查看当前用户的Spark基本权限诊断报告	查看当前用户的Spark基本权限诊断报告。
KillProcess	终止正在进行的任务	调用KillProcess接口终止正在进行的任务。
DescribeAdviceServiceEnabled	查询建议服务是否开启	查询建议服务是否开启。
DescribeSparkSQLDiagnosisList	查询SparkSQL诊断列表	查询SparkSQL诊断列表。
DescribeSparkSQLDiagnosisAttribute	查询SparkSQL诊断详情	查询单个Spark SQL的诊断详情。
DescribeOversizeNonPartitionTableInfos	检测非分区表不合理	调用DescribeOversizeNonPartitionTableInfos接口查看集群非分区表是否存在不合理的情况。
DescribeTablePartitionDiagnose	查询二级分区诊断新系列	调用DescribeTablePartitionDiagnose接口查询分区诊断信息。
DescribeSparkAppDiagnosisInfo	查询Spark应用诊断信息	查询Spark应用诊断信息。
EnableAdviceService	开通建议服务	用EnableAdviceService来开启建议服务。
DescribeAppliedAdvices	显示已采纳的优化	显示已采纳的优化建议。
DisableAdviceService	关闭建议服务	用DisableAdviceService来关闭建议服务。
BatchApplyAdviceByIdList	批量应用优化建议	批量应用优化建议。
ApplyAdviceById	应用单条优化建议	应用单条优化建议。
DescribeAvailableAdvices	显示可用优化建议	用DescribeAvailableAdvices来显示可用优化建议。
DescribeDiagnosisSQLInfo	查看SQL执行详情	查看某个SQL的执行详情，包括执行计划、运行信息、资源使用、自诊断结果等。
DescribeDiagnosisDimensions	查询不同维度的SQL去重统计信息	查看AnalyticDB MySQL湖仓版（3.0）集群符合指定检索条件的SQL在资源组、数据库名、用户名以及访问源地址等维度下的去重统计信息。
DownloadDiagnosisRecords	下载SQL摘要信息	下载目标AnalyticDB MySQL湖仓版（3.0）集群中符合指定条件的查询SQL的摘要信息。
DescribeDiagnosisRecords	查看SQL摘要信息	调用DownloadDiagnosisRecords接口查看目标AnalyticDB MySQL集群中符合指定条件的SQL摘要信息。
DescribeDownloadRecords	查看最近5次的SQL查询下载任务列表	查看目标AnalyticDB MySQL湖仓版（3.0）集群中最近5次的SQL查询下载任务列表。
DescribeSqlPattern	查询SQL Pattern详情	查看指定日期内AnalyticDB for MySQL集群的SQL Pattern详情。
DescribeSQLPatterns	查询SQL Pattern列表	查看指定日期内AnalyticDB MySQL湖仓版集群的SQL Pattern列表。
DescribePatternPerformance	查询SQL Pattern的指标	查看集群指定时间段内SQL Pattern的各指标（如查询时间、平均内存消耗）详情。

空间分析

API	标题	API概述
DescribeDBClusterSpaceSummary	查看集群的空间概览	查看实例的空间概览信息，包括总数据量、热数据量、冷数据量、数据增长量等。
DescribeExcessivePrimaryKeys	检测主键过多表	查看集群存在主键过多的表信息。

运维管理

API	标题	API概述
ModifyDBClusterMaintainTime	修改可维护时间段	修改指定集群的可维护时间段。
ModifyDBClusterResourceGroup	修改集群所属的资源组	修改集群所属的阿里云资源组。
ListTagResources	查询标签列表	调用ListTagResources查询一个或多个AnalyticDB MySQL集群已绑定的标签列表，或者查询一个或多个标签绑定的AnalyticDB MySQL集群列表。
DescribeAutoRenewalAttribute	查询包年包月集群自动续费状态	查询包年包月集群自动续费状态。
ModifyAutoRenewalAttribute	设置包年包月集群自动续费状态	设置包年包月集群自动续费状态。

数据管道

API	标题	API概述
DescribeApsResourceGroups	查询资源组信息	获取数据同步时所用资源组的详细信息。
DescribeApsJobDetail	查询APS任务详情	DescribeApsJobDetail。
CreateApsWebhook	创建Webhook	用于为指定数据库集群和任务类型创建新的Webhook。
DeleteApsWebhook	删除Webhook接口	用于删除指定数据库集群中的特定Webhook。
UpdateApsWebhook	更新Webhook配置	用于更新指定数据库集群的Webhook配置信息。
ListApsWebhook	查询Webhook	用于查询指定数据库集群下的Webhook配置信息。
CreateApsKafkaHudiJob	创建APS Kafka入湖任务	创建APS Kafka入湖任务。
ListApsLifecycleStrategy	获取当前ADB实例生命周期管理策略列表	获取当前ADB实例生命周期管理策略列表。
GetApsManagedDatabases	获取APS管理的数据库列表	获取数据库列表。
CreateApsSlsADBJob	创建一个SLS到ADB数仓的APS链路	创建一个SLS到ADB数仓的APS链路。
ListApsOptimizationTasks	获取指定类型湖存储优化策略执行过的任务列表。	获取指定类型湖存储优化策略执行过的任务列表。湖存储优化策略会周期性调度执行优化任务。
ListApsOptimizationStrategy	获取当前ADB实例湖存储优化策略列表。	获取当前ADB实例湖存储优化策略列表。
DescribeAPSADBInstances	获取联邦分析支持的ADB实例列表	获取APS联邦分析ADB实例列表。
ModifyApsSlsADBJob	修改sls投递adb数仓任务	修改sls投递adb数仓任务
DescribeApsMigrationWorkloads	查询APS迁移任务工作负载列表	查询APS迁移任务工作负载列表。
DescribeApsHiveWorkload	查询APS Hive工作负载详情	查询APS Hive工作负载详情。
CreateApsCopyWorkload	创建APS复制链路	创建APS复制链路。
DescribeApsDatasource	查询过APS数据源详情	查询过APS数据源详情。
CreateAPSJob	创建APS任务	创建APS任务。
StartApsJob	启动APS任务	启动APS任务。
SuspendApsJob	暂停APS任务	暂停APS任务。
ModifyApsJob	修改aps任务	修改aps任务。
DeleteApsJob	删除APS任务	删除aps任务。
CreateApsDatasoure	创建APS数据源	创建APS数据源。
ModifyApsDatasoure	修改APS数据源	修改APS数据源。
ModifyApsWorkloadName	修改APS工作负载名称	修改APS工作负载名称。
DescribeApsDatasources	查询APS数据源列表	查询APS数据源列表。
CreateApsHiveJob	创建APS Hive任务	创建APS Hive任务。
DescribeApsProgress	查询APS进度	查询APS进度。
DeleteApsDatasoure	删除APS数据源	删除APS数据源。
DescribeApsJobs	查询APS任务列表	查询APS任务列表。
DescribeApsActionLogs	查询实时数据接入任务的日志	查询集群实时数据接入任务的日志详细信息。

湖存储

API	标题	API概述
UpdateLakeStorage	更新湖存储	更新湖存储。
ListLakeStorages	列取湖存储	列取湖存储。
GetLakeStorage	获取湖存储	获取湖存储。
CreateLakeStorage	创建湖存储	创建湖存储。
DeleteLakeStorage	删除湖存储	删除湖存储。
ModifyLakeCacheSize	修改湖存储缓存空间	修改集群湖存储加速缓存空间大小。
DescribeLakeCacheSize	查询湖存储缓存空间设置	获取集群湖存储加速缓存空间大小。

其他

API	标题	API概述
DescribeCompactionServiceSwitch	查询集群加速配置	查询集群加速配置中，远程Build服务是否开启。
ModifyEssdCacheConfig	修改云盘缓存	修改集群加速配置，EIU云盘空间缓存大小。
DescribeEssdCacheConfig	查询集群云盘缓存空间	查询集群加速配置，云盘缓存空间大小，单位为GB。
ModifyCompactionServiceSwitch	修改远程Build服务开关	修改集群查询加速配置远程Build服务开关。
SubmitResultExportJob	提交结果集导出任务	调用SubmitResultExportJob接口提交SQL查询并导出结果集。
ListResultExportJobHistory	列出结果集导出历史任务	调用ListResultExportJobHistory接口查询当前RAM用户结果集导出执行历史记录列表。
DescribeSQLWebSocketDomain	查看注册的WebSocket域名	查看注册的WebSocket域名。
ConfigureResultExport	配置结果集导出信息	配置导出的SLS 或者OSS 信息，实例级别唯一，遵循一次配置多次使用的原则。
DescribeResultExportConfig	获取结果集导出配置信息	获取用户配置的结果集导出信息
ModifySqlTemplatePosition	修改SQL模板位置	用于修改SQL模板的目录位置