API概览
云原生数据仓库AnalyticDB MySQL版提供以下API接口。
集群管理
API | 描述 |
调用CreateDBCluster接口创建一个AnalyticDB MySQL版集群。 | |
调用DescribeDBClusters接口查看集群列表或被RAM授权的集群列表。 | |
调用DeleteDBCluster接口删除AnalyticDB MySQL版集群。 | |
调用ModifyDBCluster接口对AnalyticDB MySQL版集群进行升降配。 | |
调用DescribeDBClusterAttribute接口查看AnalyticDB MySQL集群的详细信息。 | |
调用ModifyDBClusterMaintainTime接口修改AnalyticDB MySQL集群可维护时间段。 | |
调用DescribeAutoRenewAttribute接口查询包年包月集群自动续费状态。 | |
调用ModifyDBClusterPayType接口修改AnalyticDB MySQL集群的付费类型。 | |
调用ModifyAutoRenewAttribute接口设置包年包月集群自动续费状态。 | |
调用DescribeAvailableResource接口查询指定可用区资源。 | |
调用ModifyDBClusterDescription接口修改AnalyticDB MySQL集群的备注名,方便集群的维护管理。 | |
调用ModifyDBClusterResourceGroup接口将AnalyticDB MySQL集群移动到指定资源组。 | |
调用DescribeDBClusterStatus接口查询AnalyticDB MySQL数仓版(3.0)集群的状态列表。 | |
调用DescribeComputeResource接口查询AnalyticDB MySQL数仓版(3.0)集群指定地域下的计算资源规格。 | |
调用DescribeSyncJobDetail接口查询AnalyticDB MySQL数仓版(3.0)集群的同步任务详情。 |
资源池管理
API | 描述 |
调用CreateDBResourcePool创建资源池。该接口仅适用于ADB弹性模式集群版(新版)。 | |
调用DeleteDBResourcePool接口删除资源池。该接口仅适用于ADB弹性模式集群版(新版)。 | |
调用DescribeDBResourcePool接口查询集群的资源池信息。该接口仅适用于ADB弹性模式集群版(新版)。 | |
调用ModifyDBResourcePool接口更新资源池资源。该接口仅适用于ADB弹性模式集群版(新版)。 | |
调用BindDBResourcePoolWithUser接口将资源池与数据库用户进行绑定。该接口仅适用于ADB弹性模式集群版(新版)。 | |
调用UnbindDBResourcePoolWithUser接口解绑资源池用户。该接口仅适用于ADB弹性模式集群版(新版)。 |
资源组管理
API | 描述 |
调用CreateDBResourceGroup接口为AnalyticDB MySQL数仓版(3.0)集群创建资源组。 | |
调用DescribeDBResourceGroup接口查询AnalyticDB MySQL数仓版(3.0)集群的资源组信息。 | |
调用DeleteDBResourceGroup接口删除AnalyticDB MySQL数仓版(3.0)集群的指定资源组。 | |
调用ModifyDBResourceGroup接口变更AnalyticDB MySQL数仓版(3.0)集群资源组的节点数量或查询模式。 | |
调用BindDBResourceGroupWithUser接口为AnalyticDB MySQL数仓版(3.0)集群的资源组绑定数据库账号。 | |
调用UnbindDBResourceGroupWithUser接口为AnalyticDB MySQL数仓版(3.0)集群的资源组解绑数据库账号。 |
弹性计划管理
API | 描述 |
调用CreateElasticPlan创建分时弹性计划。该接口仅适用于AnalyticDB MySQL弹性模式集群版(新版)。 | |
调用DeleteElasticPlan接口删除分时弹性计划。该接口仅适用于AnalyticDB MySQL弹性模式集群版(新版)。 | |
调用DescribeElasticDailyPlan接口查询分时弹性计划日计划执行信息。该接口仅适用于AnalyticDB MySQL弹性模式集群版(新版)。 | |
调用DescribeElasticPlan接口查询弹性计划。该接口仅适用于AnalyticDB MySQL弹性模式集群版(新版)。 | |
调用ModifyElasticPlan修改分时弹性计划。该接口仅适用于AnalyticDB MySQL弹性模式集群版(新版)。 | |
调用DescribeEIURange接口查询AnalyticDB MySQL数仓版(3.0)集群可选择的弹性IO资源数量范围。 |
数据库
API | 描述 |
调用DescribeTables接口枚举AnalyticDB MySQL集群指定数据库中所有表列表。 | |
调用DescribeAllDataSource接口枚举AnalyticDB MySQL集群中所有数据库列表、表列表和列列表。 | |
调用DescribeSchemas接口枚举AnalyticDB MySQL集群中所有数据库列表。 | |
调用DescribeTableDetail接口表详情,查看分区偏离度。 | |
调用DescribeProcessList接口查看AnalyticDB MySQL集群正在运行的查询。 | |
调用DescribeColumns接口枚举AnalyticDB MySQL集群中指定表的列。 | |
调用DescribeTaskInfo接口查看相关管控任务流进度。 | |
调用DescribeSQLPlan接口查询基础信息和计划信息。 | |
调用DescribeSQLPlanTask查询任务信息。 | |
调用KillProcess接口终止正在进行的任务。 | |
调用DescribeTablePartitionDiagnose查询二级分区诊断新系列。 | |
用DescribeLoadTasksRecords接口查看异步导入导出任务的详情。 | |
调用DescribeConnectionCountRecords接口查询目标AnalyticDB MySQL版集群当前的连接数和用户基本信息。 |
日志管理
API | 描述 |
调用DescribeSlowLogRecords接口查看AnalyticDB MySQL集群慢日志明细。 | |
调用DescribeSlowLogTrend接口查看AnalyticDB MySQL集群慢日志趋势统计情况。 | |
调用DescribeAuditLogConfig接口查询AnalyticDB MySQL集群的审计日志设置。 | |
调用ModifyAuditLogConfig接口修改AnalyticDB MySQL集群的审计日志设置。 | |
调用DescribeAuditLogRecords接口查看AnalyticDB MySQL集群的SQL审计日志。 |
地域管理
API | 描述 |
调用DescribeRegions接口查询AnalyticDB MySQL可选的地域和可用区。 |
网络管理
API | 描述 |
调用AllocateClusterPublicConnection接口为AnalyticDB MySQL集群申请公网连接地址。 | |
调用DescribeDBClusterNetInfo接口查询AnalyticDB MySQL集群的网络信息。 | |
调用ReleaseClusterPublicConnection接口释放AnalyticDB MySQL集群的公网连接地址。 | |
调用ModifyClusterConnectionString接口修改AnalyticDB MySQL集群的网络连接地址。 | |
调用AttachUserENI接口为AnalyticDB MySQL数仓版(3.0)集群创建VPC弹性网卡。 | |
调用DetachUserENI接口删除AnalyticDB MySQL数仓版(3.0)集群已创建的VPC弹性网卡。 | |
调用DescribeVSwitches接口查询交换机列表。 |
账号管理
API | 描述 |
调用CreateAccount接口为集群创建账号。 | |
调用DeleteAccount接口删除数据库账号。 | |
调用DescribeAccounts接口查询集群的账号信息。 | |
调用DescribeOperatorPermission接口查询集群服务账号的授权详情。 | |
调用GrantOperatorPermission接口为集群服务账号授权。 | |
调用ResetAccountPassword接口重置数据库账号。 | |
调用RevokeOperatorPermission接口撤销集群服务账号权限。 | |
调用ModifyAccountDescription接口修改AnalyticDB MySQL数据库账号的备注信息。 | |
调用DescribeAllAccounts接口查询指定集群、指定数据库的账号列表信息或某个指定账号的信息。 |
标签管理
API | 描述 |
调用TagResources接口为AnalyticDB MySQL版集群绑定标签。 | |
调用ListTagResources接口查询一个或多个AnalyticDB MySQL版集群已绑定的标签列表,或者查询一个或多个标签绑定的AnalyticDB MySQL版集群列表。 | |
调用UntagResources接口将标签从AnalyticDB MySQL版集群中解绑,如果该标签没有绑定到其他集群,则该标签会被删除。 |
备份恢复
API | 描述 |
调用DescribeBackups接口查看集群的备份列表。 | |
调用DescribeBackupPolicy接口查看集群备份设置。 | |
调用ModifyBackupPolicy接口修改AnalyticDB MySQL集群的备份策略。 | |
调用ModifyLogBackupPolicy接口修改日志备份设置。 |
安全管理
API | 描述 |
调用DescribeDBClusterAccessWhiteList接口查看集群的IP白名单。 | |
调用ModifyDBClusterAccessWhiteList接口修改集群白名单。 |
监控管理
API | 描述 |
调用DescribeDBClusterPerformance接口查看目标集群的性能数据。 | |
调用DescribeDBClusterResourcePoolPerformance接口查看AnaluticDB MySQL版弹性模式集群版(新版)的资源池监控信息。 | |
调用DescribeInclinedTables接口查看表监控。 | |
调用DescribeTableStatistics接口查询目标AnalyticDB MySQL版集群中的表信息统计详情。 | |
调用DescribeDBClusterHealthStatus接口查看AnalyticDB MySQL数仓版(3.0)集群的健康状态。 |
运维事件
API | 描述 |
调用DescribeMaintenanceAction接口查询运维事件的详情。 | |
调用ModifyMaintenanceAction接口修改待处理运维事件的切换时间。 |
SQL诊断
API | 描述 |
调用DescribeDiagnosisMonitorPerformance 接口获取指定时间范围内查询的监控信息,包括耗时、扫描量、峰值内存等。 | |
调用DescribeDiagnosisRecords接口查看目标AnalyticDB MySQL版集群中符合指定检索条件的SQL语句摘要信息。 | |
调用DownloadDiagnosisRecords接口下载目标AnalyticDB MySQL版集群中符合指定条件的查询SQL的摘要信息。 | |
调用DescribeDownloadRecords接口查看目标AnalyticDB MySQL版集群中最近5次的SQL查询下载任务列表。 | |
调用DescribeDiagnosisDimensions接口查看SQL在资源组、数据库名、用户名以及访问源地址等维度下的去重统计信息。 | |
调用DescribeDiagnosisSQLInfo接口查看某个SQL的执行详情,包括执行计划、运行信息、资源使用、自诊断结果等。 | |
调用DescribeDiagnosisTasks接口获取指定查询ID和Stage ID的分布式子任务执行详情。 |
实例运行报告
API | 描述 |
调用DescribeTableAccessCount接口查看指定日期内AnalyticDB MySQL版集群下目标表或所有表的被访问次数。 | |
调用DescribeSqlPattern接口查看指定日期内AnalyticDB MySQL版集群下的SQL Pattern详情。 |
SQL Pattern
API | 描述 |
调用DescribeSQLPatterns接口查看指定日期内AnalyticDB MySQL版集群下的SQL Pattern列表。 | |
调用DescribeSQLPatternAttribute接口查看AnalyticDB MySQL版集群下指定SQL Pattern的统计信息。 | |
调用DescribePatternPerformance接口查看目标SQL Pattern的各指标(如查询时间、平均内存消耗等)在不同时间点的详情。 |
库表结构优化
API | 描述 |
调用EnableAdviceService接口开启建议服务。 | |
调用DisableAdviceService接口关闭建议服务。 | |
调用DescribeAvailableAdvices接口查询可用的优化建议。 | |
调用DescribeAppliedAdvices接口查询已应用的优化建议。 | |
调用DescribeAdviceServiceEnabled接口查询建议服务是否开启。 | |
调用ApplyAdviceById接口应用一条优化建议。 | |
用BatchApplyAdviceByIdList接口批量应用多条优化建议。 |