云原生数据仓库AnalyticDBMySQL数仓版有哪些API接口_云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

本产品（云原生数据仓库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	调用AttachUserENI接口为数仓版集群创建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	为集群申请公网连接地址	调用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	查询备份集列表	调用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模板详情。