文档

API概览

更新时间:
本产品(云原生数据仓库AnalyticDB MySQL版/2019-03-15)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

集群管理

API标题API概述
CreateDBCluster创建集群创建AnalyticDB for MySQL数仓版集群。
DeleteDBCluster删除集群删除AnalyticDB MySQL集群。
ModifyDBCluster对集群进行升降配对AnalyticDB MySQL集群进行升降配。
ModifyDBClusterMaintainTime修改集群可维护时间段调用ModifyDBClusterMaintainTime接口修改实例可维护时间段。
ModifyDBClusterPayType修改集群的付费类型调用ModifyDBClusterPayType接口修改AnalyticDB MySQL集群的付费类型。
ModifyAutoRenewAttribute设置包年包月集群自动续费状态调用ModifyAutoRenewAttribute接口设置包年包月集群自动续费状态。
ModifyDBClusterDescription修改集群的备注名调用ModifyDBClusterDescription接口修改集群的备注名,方便维护管理。
ModifyDBClusterResourceGroup修改数据库集群资源组调用ModifyDBClusterResourceGroup接口修改AnalyticDB MySQL集群的资源组。
DescribeDBClusters查询实例列表查询AnalyticDB MySQL实例列表。
DescribeDBClusterStatus查看集群的运行状态调用DescribeDBClusterStatus接口查询AnalyticDB MySQL数仓版(3.0)集群的状态列表。
DescribeDBClusterAttribute查询集群的详细属性调用DescribeDBClusterAttribute接口查看目标AnalyticDB MySQL版集群的详细信息。
DescribeAutoRenewAttribute查询包年包月集群自动续费状态调用DescribeAutoRenewAttribute接口查询包年包月集群自动续费状态。
DescribeAvailableResource查询指定可用区资源调用DescribeAvailableResource接口查询指定可用区资源。
DescribeComputeResource查询物理资源调用DescribeComputeResource接口查询AnalyticDB MySQL数仓版(3.0)集群指定地域下的计算资源规格。
DescribeEIURange查询弹性IO资源数量信息调用DescribeEIURange接口查询AnalyticDB MySQL数仓版(3.0)集群可选择的弹性IO资源数量范围。
AttachUserENI打通用户ENI调用AttachUserENI接口为AnalyticDB MySQL数仓版(3.0)集群创建VPC弹性网卡。
DetachUserENI关闭用户ENI调用DetachUserENI接口删除AnalyticDB MySQL数仓版(3.0)集群已创建的VPC弹性网卡。
DescribeKernelVersion查询集群内核版本调用DescrbeKernelVersion接口查看目标AnalyticDB MySQL版集群的内核版本信息。
UpgradeKernelVersion升级集群内核版本升级目标AnalyticDB MySQL版集群的内核版本。

资源组管理(旧版)

API标题API概述
CreateDBResourcePool创建资源组调用CreateDBResourcePool接口创建资源组。仅适用于AnalyticDB MySQL弹性模式集群版(新版)。
DeleteDBResourcePool删除资源组调用DeleteDBResourcePool接口删除资源组。该接口仅适用于AnalyticDB MySQL弹性模式集群版(新版)。
ModifyDBResourcePool更新资源组资源调用ModifyDBResourcePool接口更新资源组的资源。该接口仅适用于AnalyticDB MySQL弹性模式集群版(新版)。
DescribeDBResourcePool查询集群的资源组信息调用DescribeDBResourcePool接口查询集群的资源组信息。该接口仅适用于AnalyticDB MySQL弹性模式集群版(新版)。
BindDBResourcePoolWithUser将资源组与数据库用户进行绑定调用BindDBResourcePoolWithUser接口将资源组与数据库用户进行绑定。该接口仅适用于AnalyticDB MySQL弹性模式集群版(新版)。
UnbindDBResourcePoolWithUser解绑资源组用户调用UnbindDBResourcePoolWithUser接口解绑资源组用户。该接口仅适用于AnalyticDB MySQL弹性模式集群版(新版)。

资源组管理(新版)

API标题API概述
CreateDBResourceGroup创建资源组调用CreateDBResourceGroup接口为AnalyticDB MySQL数仓版(3.0)集群创建资源组。
BindDBResourceGroupWithUser将资源组与数据库用户进行绑定调用BindDBResourceGroupWithUser接口为AnalyticDB MySQL数仓版(3.0)集群的资源组绑定数据库账号。
UnbindDBResourceGroupWithUser解绑资源组和用户调用UnbindDBResourceGroupWithUser接口为AnalyticDB MySQL数仓版(3.0)集群的资源组解绑数据库账号。
DescribeDBResourceGroup查询数据库资源组信息调用DescribeDBResourceGroup接口查询AnalyticDB MySQL数仓版(3.0)集群的资源组信息。
ModifyDBResourceGroup修改数据库集群资源组调用ModifyDBResourceGroup接口变更AnalyticDB MySQL数仓版(3.0)集群资源组的节点数量或查询模式。
DeleteDBResourceGroup删除资源组调用DeleteDBResourceGroup接口删除AnalyticDB MySQL数仓版(3.0)集群的指定资源组。

弹性计划管理

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

数据库

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查询集群审计日志设置调用DescribeAuditLogConfig接口查询ADB实例审计日志设置。
DescribeAuditLogRecords查询集群的SQL审计日志调用DescribeAuditLogRecords接口查询AnalyticDB MySQL版集群的SQL审计日志。

地域管理

API标题API概述
DescribeRegions查询用户可选的地域和可用区调用DescribeRegions接口查询ADB可选的地域和可用区。

网络管理

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

账号管理

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概述
ModifyBackupPolicy修改备份策略设置调用ModifyBackupPolicy接口修改AnalyticDB MySQL版实例的备份策略。
ModifyLogBackupPolicy修改日志备份策略设置调用ModifyLogBackupPolicy接口修改日志备份设置。
DescribeBackupPolicy查询集群自动备份策略调用DescribeBackupPolicy接口查看集群备份设置。
DescribeBackups查询备份集列表调用DescribeBackups接口查看集群的备份列表。

安全管理

API标题API概述
ModifyDBClusterAccessWhiteList创建或修改集群的白名单创建或修改集群的白名单(包括IP白名单和安全组)。
DescribeDBClusterAccessWhiteList查询集群的IP白名单调用DescribeDBClusterAccessWhiteList接口查看集群的IP白名单。

监控管理

API标题API概述
DescribeDBClusterHealthStatus查询集群健康检查状态调用DescribeDBClusterHealthStatus接口查看AnalyticDB MySQL数仓版(3.0)集群的健康状态。
DescribeDBClusterPerformance查看集群性能数据调用DescribeDBClusterPerformance接口查看目标集群的性能数据。
DescribeDBClusterResourcePoolPerformance查询集群资源池监控信息查询弹性模式集群版(新版)ADB集群的资源池监控信息。
DescribeInclinedTables查看表监控调用DescribeInclinedTables接口查看表监控。

运维事件

API标题API概述
ModifyMaintenanceAction修改维护动作调用ModifyMaintenanceAction接口修改运维事件的执行时间。
DescribeMaintenanceAction查询运维事件的详情调用DescribeMaintenanceAction接口查询运维事件的详细信息。

SQL诊断

API标题API概述
DescribeDiagnosisTasksStage的子任务执行详情获取指定查询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查看集群的空间概览查看实例的空间概览信息,包括总数据量、热数据量、冷数据量、数据增长量等。

实例运行报告

API标题API概述
DescribeTableAccessCount查询表访问统计信息查看指定日期内AnalyticDB MySQL版集群下目标表或所有表的被访问次数。
DescribeSqlPattern查询SQL模式查看指定日期内AnalyticDB MySQL版集群下的SQL模板详情。

其他

API标题API概述
DescribeVSwitches查询可组网信息调用DescribeVSwitches接口查询交换机列表。
MigrateDBCluster迁移集群调用MigrateDBCluster将AnalyticDB MySQL数仓版(3.0)迁移至AnalyticDB MySQL湖仓版(3.0)集群。
DescribeTableStatistics查询表统计信息查询目标AnalyticDB MySQL集群中的表信息统计详情。
ModifyResubmitConfig修改作业投递规则
DescribeResubmitConfig查询作业投递规则
DescribeSQAConfig查询小查询加速配置调用DescribeSQAConfig接口查询集群小查询加速的配置。
ModifySQAConfig修改作业投递规则
DescribeDBClusterSSL查询ADB实例的SSL配置调用DescribeDBClusterSSL接口查询集群的SSL配置情况。
ModifyDBClusterSSL修改ADB实例的SSL配置调用ModifyDBClusterSSL接口修改集群的SSL链路配置。
  • 本页导读 (1)