API概览

更新时间：2021-04-16 16:13

新浪微博微信钉钉

云原生数据仓库AnalyticDB MySQL版提供以下API接口。

集群管理

API	描述
CreateDBCluster	调用CreateDBCluster接口创建一个AnalyticDB MySQL集群。
DescribeDBClusters	调用DescribeDBClusters接口查看集群列表或被RAM授权的集群列表。
ModifyDBCluster	调用ModifyDBCluster接口对AnalyticDB MySQL集群进行升降配。
DeleteDBCluster	调用DeleteDBCluster接口删除AnalyticDB MySQL集群。
DescribeDBClusterAttribute	调用DescribeDBClusterAttribute接口查看实例的详细信息。
ModifyDBClusterMaintainTime	调用ModifyDBClusterMaintainTime接口修改实例可维护时间段。
DescribeAutoRenewAttribute	调用DescribeAutoRenewAttribute接口查询包年包月集群自动续费状态。
ModifyAutoRenewAttribute	调用ModifyAutoRenewAttribute接口设置包年包月集群自动续费状态。
ModifyDBClusterDescription	调用ModifyDBClusterDescription接口修改实例的备注名，方便实例的维护管理。
DescribeAvailableResource	调用DescribeAvailableResource接口查询指定可用区资源。
ModifyDBClusterResourceGroup	调用ModifyDBClusterResourceGroup接口将AnalyticDB实例移动到指定资源组。

资源池管理

API	描述
CreateDBResourcePool	调用CreateDBResourcePool创建资源池。该接口仅适用于ADB弹性模式集群版（新版）。
DeleteDBResourcePool	调用DeleteDBResourcePool接口删除资源池。该接口仅适用于ADB弹性模式集群版（新版）。
DescribeDBResourcePool	调用DescribeDBResourcePool接口查询集群的资源池信息。该接口仅适用于ADB弹性模式集群版（新版）。
ModifyDBResourcePool	调用ModifyDBResourcePool接口更新资源池资源。该接口仅适用于ADB弹性模式集群版（新版）。
BindDBResourcePoolWithUser	调用BindDBResourcePoolWithUser接口将资源池与数据库用户进行绑定。该接口仅适用于ADB弹性模式集群版（新版）。
UnbindDBResourcePoolWithUser	调用UnbindDBResourcePoolWithUser接口解绑资源池用户。该接口仅适用于ADB弹性模式集群版（新版）。

弹性计划管理

API	描述
CreateElasticPlan	调用CreateElasticPlan创建分时弹性计划。该接口仅适用于ADB弹性模式集群版（新版）。
DeleteElasticPlan	调用DeleteElasticPlan接口删除分时弹性计划。该接口仅适用于ADB弹性模式集群版（新版）。
DescribeElasticDailyPlan	调用DescribeElasticDailyPlan接口查询分时弹性计划日计划执行信息。该接口仅适用于ADB弹性模式集群版（新版）。
DescribeElasticPlan	调用DescribeElasticPlan接口查询弹性计划。该接口仅适用于ADB弹性模式集群版（新版）。
ModifyElasticPlan	调用ModifyElasticPlan修改分时弹性计划。该接口仅适用于ADB弹性模式集群版（新版）。

数据库

API	描述
DescribeTables	调用DescribeTables接口枚举实例指定数据库下所有表列表。
DescribeAllDataSource	调用DescribeAllDataSource接口枚举实例下所有数据库列表、表列表和列列表。
DescribeSchemas	调用DescribeSchemas接口枚举实例下所有数据库列表。
DescribeTableDetail	调用DescribeTableDetail接口表详情，查看分区偏离度。
DescribeProcessList	调用DescribeProcessList接口查看实例正在运行的查询。
DescribeColumns	调用DescribeColumns接口枚举实例下指定表格的列列表。
DescribeTaskInfo	调用DescribeTaskInfo接口查看相关管控任务流进度。
DescribeSQLPlan	调用DescribeSQLPlan接口查询基础信息和计划信息。
DescribeSQLPlanTask	调用DescribeSQLPlanTask查询任务信息。
KillProcess	调用KillProcess接口终止正在进行的任务。
DescribeTablePartitionDiagnose	调用DescribeTablePartitionDiagnose查询二级分区诊断新系列。

日志管理

API	描述
DescribeSlowLogRecord	调用DescribeSlowLogRecords接口查看集群慢日志明细。
DescribeSlowLogTrend	调用DescribeSlowLogTrend接口查看集群慢日志趋势统计情况。
DescribeAuditLogConfig	调用DescribeAuditLogConfig接口查询ADB实例审计日志设置。
ModifyAuditLogConfig	调用ModifyAuditLogConfig接口修改审计日志设置。
DescribeAuditLogRecords	调用DescribeAuditLogRecords接口查看ADB实例的SQL审计日志。

地域管理

API	描述
DescribeRegions	调用DescribeRegions接口查询AnalyticDB for MySQL可选的地域和可用区。

网络管理

API	描述
AllocateClusterPublicConnection	调用AllocateClusterPublicConnection接口为集群申请公网连接地址。
DescribeDBClusterNetInfo	调用DescribeDBClusterNetInfo接口查询集群的网络信息。
ReleaseClusterPublicConnection	调用ReleaseClusterPublicConnection接口释放集群的公网连接地址。
ModifyClusterConnectionString	调用ModifyClusterConnectionString接口修改实例的网络连接地址。

账号管理

API	描述
CreateAccount	调用CreateAccount接口为集群创建账号。
DeleteAccount	调用DeleteAccount接口删除数据库账号。
DescribeAccounts	调用DescribeAccounts接口查询集群的账号信息。
DescribeOperatorPermission	调用DescribeOperatorPermission接口查询集群服务账号的授权详情。
GrantOperatorPermission	调用GrantOperatorPermission接口为集群服务账号授权。
ResetAccountPassword	调用ResetAccountPassword接口重置数据库账号。
RevokeOperatorPermission	调用RevokeOperatorPermission接口撤销集群服务账号权限。
ModifyAccountDescription	调用ModifyAccountDescription接口修改ADB数据库账号的备注信息。
DescribeAllAccounts	调用DescribeAllAccounts接口查询指定集群、指定数据库的账号列表信息或某个指定账号的信息。

标签管理

API	描述
TagResources	调用TagResources接口为AnalyticDB MySQL集群绑定标签。
ListTagResources	调用ListTagResources接口查询一个或多个AnalyticDB MySQL集群已绑定的标签列表，或者查询一个或多个标签绑定的AnalyticDB MySQL集群列表。
UntagResources	调用UntagResources接口将标签从AnalyticDB MySQL集群中解绑，如果该标签没有绑定到其他集群，则该标签会被删除。

备份恢复

API	描述
DescribeBackups	调用DescribeBackups接口查看集群的备份列表。
DescribeBackupPolicy	调用DescribeBackupPolicy接口查看集群备份设置。
ModifyBackupPolicy	调用ModifyBackupPolicy接口修改ADB实例的备份策略。
ModifyLogBackupPolicy	调用ModifyLogBackupPolicy接口修改日志备份设置。

安全管理

API	描述
DescribeDBClusterAccessWhiteList	调用DescribeDBClusterAccessWhiteList接口查看集群的IP白名单。
ModifyDBClusterAccessWhiteList	调用ModifyDBClusterAccessWhiteList接口修改集群白名单。

监控管理

API	描述
DescribeDBClusterPerformance	调用ModifyDBClusterAccessWhiteList接口修改集群白名单。
DescribeDBClusterResourcePoolPerformance	调用DescribeDBClusterResourcePoolPerformance接口查询弹性模式集群版（新版）ADB集群的资源池监控信息。
DescribeInclinedTables	调用DescribeInclinedTables接口查看表监控。

文档反馈