文档

API概览

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

地域管理

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

集群管理

API标题API概述
CreateDBCluster创建集群创建AnalyticDB MySQL湖仓版(3.0)集群。
ModifyDBCluster集群升降配对AnalyticDB MySQL湖仓版(3.0)集群进行升降配。
DescribeDBClusters查询集群列表查看目标地域下的AnalyticDB MySQL湖仓版(3.0)集群列表信息。
DescribeDBClusterAttribute查询集群详细信息查看指定AnalyticDB MySQL湖仓版(3.0)集群的详细信息。
DeleteDBCluster释放集群删除AnalyticDB MySQL湖仓版(3.0)集群。
ModifyDBClusterDescription变更集群描述修改指定AnalyticDB MySQL湖仓版(3.0)集群的描述信息,方便集群的维护管理。
DescribeClusterNetInfo查询网络信息调用DescribeDBClusterNetInfo接口查询指定AnalyticDB MySQL湖仓版(3.0)集群的网络信息。
AllocateClusterPublicConnection申请公网地址为AnalyticDB MySQL湖仓版(3.0)集群申请公网连接地址。
ReleaseClusterPublicConnection释放公网地址释放指定AnalyticDB MySQL湖仓版(3.0)集群的公网连接地址。
ModifyClusterConnectionString修改公网连接地址修改指定AnalyticDB MySQL湖仓版(3.0)集群的公网连接地址。
DescribeClusterAccessWhiteList查询白名单查看指定AnalyticDB MySQL湖仓版(3.0)集群的IP白名单。
ModifyClusterAccessWhiteList修改白名单修改指定AnalyticDB MySQL湖仓版(3.0)集群的IP白名单。

资源组管理

API标题API概述
CreateDBResourceGroup创建资源组为指定的AnalyticDB MySQL湖仓版(3.0)集群创建资源组。
DescribeDBResourceGroup查询资源组查询AnalyticDB MySQL湖仓版(3.0)集群的资源组信息。
ModifyDBResourceGroup修改资源组变更AnalyticDB MySQL湖仓版(3.0)集群的计算预留资源。
DeleteDBResourceGroup删除资源组调用CreateDBResourceGroup接口删除指定AnalyticDB MySQL湖仓版(3.0)集群的资源组。

资源弹性计划

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

SQL审计

API标题API概述
DescribeAuditLogRecords查询SQL审计日志查询AnalyticDB MySQL湖仓版(3.0)集群的SQL审计日志。
ModifyAuditLogConfig修改SQL审计日志设置修改AnalyticDB MySQL湖仓版(3.0)集群的SQL审计日志设置。

账号管理

API标题API概述
CreateAccount创建数据库账号为AnalyticDB MySQL湖仓版(3.0)集群创建数据库账号。
DescribeAccounts查询数据库账号查询AnalyticDB MySQL湖仓版(3.0)集群的数据库账号。
BindAccount绑定RAM用户与数据库账号绑定RAM用户与AnalyticDB MySQL湖仓版(3.0)集群的数据库普通账号。
UnbindAccount解绑RAM用户与数据库账号解绑RAM用户与AnalyticDB MySQL湖仓版(3.0)集群的数据库普通账号。
CheckBindRamUser查询数据库账号是否绑定RAM用户检查AnalyticDB MySQL湖仓版集群数据库账号绑定的RAM账号。
ResetAccountPassword重置数据库账号的密码重置指定AnalyticDB MySQL湖仓版(3.0)集群的数据库账号密码。
ModifyAccountDescription修改数据库账号的备注信息修改目标AnalyticDB MySQL湖仓版(3.0)集群的数据库账号的备注信息。
DeleteAccount删除数据库账号删除AnalyticDB MySQL湖仓版(3.0)集群的数据库账号。
ModifyAccountPrivileges 修改数据库账户的权限修改某一数据库账户的权限。
DescribeAccountPrivileges查询数据库账号的权限获取给定数据库账号在某个级别拥有的权限。
DescribeEnabledPrivileges查询支持的权限级别和权限列表获取支持的权限级别和权限列表。
DescribeAccountAllPrivileges查询数据库账号的所有权限获取给定账号拥有的所有权限,包括全局、库、表、列级别。
DescribeAccountPrivilegeObjects查询数据库账号可见的库表列获取给定账号可见的库表列。

监控信息

API标题API概述
DescribeDBClusterHealthStatus查询集群健康检查状态查看AnalyticDB MySQL湖仓版(3.0)集群的健康状态。
DescribeDBClusterPerformance查看集群性能数据查看目标集群的性能数据。

Spark开发

API标题API概述
GetSparkDefinitions查询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引擎的状态。
ListSparkTemplateFileIds列出集群中的Spark模板文件ID查询AnalyticDB MySQL湖仓版(3.0)集群所有保存的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作业。

数据管理

API标题API概述
DescribeAdbMySqlColumns查询表的列信息查询AnalyticDB MySQL湖仓版(3.0)集群指定表的列信息。
DescribeAdbMySqlTables查询数据库下所有表信息枚举AnalyticDB MySQL湖仓版(3.0)集群指定数据库下所有表信息。
DescribeAdbMySqlSchemas查询所有数据库列表枚举指定AnalyticDB MySQL湖仓版(3.0)集群下所有数据库列表。
GetViewDDL查询视图的创建语句查询视图的创建语句。
GetViewObjects查询视图信息查询视图信息。
GetDatabaseObjects查询数据库信息查询数据库信息。
GetTable查询表信息获取表信息。
GetTableColumns查询列信息查询列信息。
GetTableDDL查询建表语句查询建表语句。
GetTableObjects查询表信息查询表信息。

诊断优化

API标题API概述
DescribeSqlPattern查询SQL Pattern详情查看指定日期内AnalyticDB MySQL湖仓版(3.0)集群下的SQL Pattern详情。
DescribeSQLPatterns查询SQL Pattern列表查看指定日期内AnalyticDB MySQL湖仓版集群的SQL Pattern列表。
DescribePatternPerformance查询SQL Pattern的指标查看AnalyticDB MySQL湖仓版集群指定时间段内SQL Pattern的各指标(如查询时间、平均内存消耗)详情。

空间分析

API标题API概述
DescribeDBClusterSpaceSummary查看集群的空间概览查看实例的空间概览信息,包括总数据量、热数据量、冷数据量、数据增长量等。

运维管理

API标题API概述
ModifyDBClusterMaintainTime修改可维护时间段修改指定AnalyticDB MySQL湖仓版(3.0)集群的可维护时间段。

查询链接

API标题API概述
DescribeApsActionLogs查询实时数据接入任务的日志查询AnalyticDB MySQL湖仓版(3.0)集群实时数据接入任务的日志详细信息。

其他

API标题API概述
BindDBResourceGroupWithUser将资源组与数据库用户进行绑定绑定资源组。
UnbindDBResourceGroupWithUser解绑资源组和用户调用UnbindDBResourceGroupWithUser接口为AnalyticDB MySQL集群的资源组解绑数据库账号。
DescribeDBClusterStatus查看集群的运行状态调用DescribeDBClusterStatus接口查询AnalyticDB MySQL湖仓版(3.0)集群的状态列表。
DetachUserENI关闭用户ENI
AttachUserENI打通用户ENI调用AttachUserENI接口为AnalyticDB MySQL湖仓版(3.0)集群创建VPC弹性网卡。
ExistRunningSQLEngine检测是否存在运行中的Spark SQLEngine是否有存活的SQL ENGINE。
CheckSampleDataSet检查内置数据集状态
DescribeUserQuota查询用户可用配额
DescribeAllDataSource枚举数据库列表枚举实例下所有数据库列表、表列表和列列表。
DescribeTables枚举数据库的表列表查询指定数据库的表列表信息。
DescribeSchemas枚举实例的库列表查询指定实例的数据库列表信息。
DescribeColumns枚举表的列列表查询指定表的列列表信息。
RenameSparkTemplateFile重命名Spark模板文件重命名Spark模板文件。
LoadSampleDataSet加载内置数据集调用LoadSampleDataSet接口加载内置数据集。
ModifyBackupPolicy修改集群备份策略调用ModifyBackupPolicy接口修改湖仓版(3.0)集群的备份策略。
DescribeBackupPolicy查询集群自动备份策略
DescribeBackups查询备份集列表
DescribeStorageResourceUsage查询集群存储资源使用情况调用DescribeStorageResourceUsage接口查询湖仓版(3.0)集群存储资源使用情况。
DescribeClusterResourceDetail查询集群资源具体使用详情
DescribeJobResourceUsage查询任务型资源使用情况
DescribeClusterResourceUsage查询集群资源使用情况
DescribeComputeResourceUsage查询资源组计算资源使用情况
DescribeApsResourceGroups查询资源组信息调用DescribeApsResourceGroups接口获取数据同步时所用资源组的详细信息。
DescribeExcessivePrimaryKeys检测主键过多表查看集群存在主键过多的表信息。
DescribePerformanceViews获取监控视图列表获取监控视图列表。
CreatePerformanceView创建自定义监控视图创建自定义监控视图。
ModifyPerformanceView修改自定义监控视图修改自定义监控视图。
DeletePerformanceView删除监控视图删除监控视图。
DescribePerformanceViewAttribute查看监控视图详情查看监控视图详情。