本产品(
云原生数据仓库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 | 创建集群 | 创建湖仓版集群。 |
DescribeDBClusters | 查询集群列表 | 查看目标地域下的湖仓版集群列表信息。 |
DescribeDBClusterStatus | 查看集群的运行状态 | 调用DescribeDBClusterStatus接口查询集群的状态列表。 |
DescribeDBClusterAttribute | 查询集群详细信息 | 查看指定集群的详细信息。 |
DeleteDBCluster | 释放集群 | 删除集群。 |
ModifyDBClusterDescription | 变更集群描述 | 修改指定集群的描述信息,方便集群的维护管理。 |
DescribeClusterNetInfo | 查询网络信息 | 调用DescribeDBClusterNetInfo接口查询指定集群的网络信息。 |
AllocateClusterPublicConnection | 申请公网地址 | 为集群申请公网连接地址。 |
ReleaseClusterPublicConnection | 释放公网地址 | 释放指定集群的公网连接地址。 |
ModifyClusterConnectionString | 修改公网连接地址 | 修改指定集群的公网连接地址。 |
DescribeClusterAccessWhiteList | 查询白名单 | 查看指定集群的IP白名单。 |
ModifyClusterAccessWhiteList | 修改白名单 | 修改指定集群的IP白名单。 |
资源组管理
API | 标题 | API概述 |
---|---|---|
CreateDBResourceGroup | 创建资源组 | 为指定的AnalyticDB MySQL湖仓版(3.0)集群创建资源组。 |
DescribeDBResourceGroup | 查询资源组 | 查询集群的资源组信息。 |
ModifyDBResourceGroup | 修改资源组 | 变更集群的资源组。 |
DeleteDBResourceGroup | 删除资源组 | 调用CreateDBResourceGroup接口删除指定集群的资源组。 |
BindDBResourceGroupWithUser | 将资源组与数据库用户进行绑定 | 绑定资源组。 |
UnbindDBResourceGroupWithUser | 解绑资源组和用户 | 调用UnbindDBResourceGroupWithUser接口为AnalyticDB MySQL集群的资源组解绑数据库账号。 |
DescribeApsResourceGroups | 查询资源组信息 | 调用DescribeApsResourceGroups接口获取数据同步时所用资源组的详细信息。 |
DescribeComputeResourceUsage | 查询资源组计算资源使用情况 | |
DescribeUserQuota | 查询用户可用配额 |
资源弹性计划
API | 标题 | API概述 |
---|---|---|
CreateElasticPlan | 创建弹性计划 | 创建集群的弹性计划。 |
DescribeElasticPlans | 查询弹性计划列表 | 根据查询条件查询集群的弹性计划。 |
ModifyElasticPlan | 修改弹性计划 | 修改集群的弹性计划。 |
EnableElasticPlan | 启用弹性计划 | 启用集群的弹性计划。 |
DisableElasticPlan | 停用弹性计划 | 停用集群的弹性计划。 |
DeleteElasticPlan | 删除弹性计划 | 删除集群的弹性计划。 |
DescribeElasticPlanJobs | 查询弹性计划作业列表 | 查询集群的弹性计划作业。 |
DescribeElasticPlanAttribute | 查询弹性计划详情 | 查询集群的弹性计划详情。 |
DescribeElasticPlanSpecifications | 查询弹性计划支持的规格列表 | 查询集群的不同类型弹性计划支持的规格列表。 |
SQL审计
API | 标题 | API概述 |
---|---|---|
DescribeAuditLogRecords | 查询SQL审计日志 | 查询集群的SQL审计日志。 |
ModifyAuditLogConfig | 修改SQL审计日志设置 | 修改集群的SQL审计日志设置。 |
网络管理
API | 标题 | API概述 |
---|---|---|
AttachUserENI | 打通用户ENI | 调用AttachUserENI接口为集群创建VPC弹性网卡。 |
DetachUserENI | 关闭用户ENI |
账号管理
API | 标题 | API概述 |
---|---|---|
CreateAccount | 创建数据库账号 | 为集群创建数据库账号。 |
DescribeAccounts | 查询数据库账号 | 查询集群的数据库账号。 |
BindAccount | 绑定RAM用户与数据库账号 | 绑定RAM用户与集群的数据库普通账号。 |
UnbindAccount | 解绑RAM用户与数据库账号 | 解绑RAM用户与集群的数据库普通账号。 |
CheckBindRamUser | 查询数据库账号是否绑定RAM用户 | 检查集群数据库账号绑定的RAM账号。 |
ResetAccountPassword | 重置数据库账号的密码 | 重置指定集群的数据库账号密码。 |
ModifyAccountDescription | 修改数据库账号的备注信息 | 修改目标集群的数据库账号的备注信息。 |
DeleteAccount | 删除数据库账号 | 删除集群的数据库账号。 |
ModifyAccountPrivileges | 修改数据库账户的权限 | 修改某一数据库账户的权限。 |
DescribeAccountPrivileges | 查询数据库账号的权限 | 获取给定数据库账号在某个级别拥有的权限。 |
DescribeEnabledPrivileges | 查询支持的权限级别和权限列表 | 获取支持的权限级别和权限列表。 |
DescribeAccountAllPrivileges | 查询数据库账号的所有权限 | 获取给定账号拥有的所有权限,包括全局、库、表、列级别。 |
DescribeAccountPrivilegeObjects | 查询数据库账号可见的库表列 | 获取给定账号可见的库表列。 |
备份恢复
API | 标题 | API概述 |
---|---|---|
DescribeBackups | 查询备份集列表 | |
DescribeBackupPolicy | 查询集群自动备份策略 | |
ModifyBackupPolicy | 修改集群备份策略 | 调用ModifyBackupPolicy接口修改集群的备份策略。 |
监控信息
API | 标题 | API概述 |
---|---|---|
DescribeDBClusterHealthStatus | 查询集群健康检查状态 | 查看集群的健康状态。 |
DescribeDBClusterPerformance | 查看集群性能数据 | 查看目标集群的性能数据。 |
DescribeClusterResourceUsage | 查询集群资源使用情况 | |
DescribeClusterResourceDetail | 查询集群资源具体使用详情 | 查询集群资源具体使用详情。 |
DescribeStorageResourceUsage | 查询集群存储资源使用情况 | 调用DescribeStorageResourceUsage接口查询集群存储资源使用情况。 |
DescribeJobResourceUsage | 查询任务型资源使用情况 | |
DescribePerformanceViews | 获取监控视图列表 | 获取监控视图列表。 |
CreatePerformanceView | 创建自定义监控视图 | 创建自定义监控视图。 |
ModifyPerformanceView | 修改自定义监控视图 | 修改自定义监控视图。 |
DescribePerformanceViewAttribute | 查看监控视图详情 | 查看监控视图详情。 |
DeletePerformanceView | 删除监控视图 | 删除监控视图。 |
ExistRunningSQLEngine | 检测是否存在运行中的Spark SQLEngine | 是否有存活的SQL ENGINE。 |
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作业。 |
RenameSparkTemplateFile | 重命名Spark模板文件 | 重命名Spark模板文件。 |
数据管理
API | 标题 | API概述 |
---|---|---|
DescribeAdbMySqlColumns | 查询表的列信息 | 查询集群指定表的列信息。 |
DescribeAdbMySqlTables | 查询数据库下所有表信息 | 枚举集群指定数据库下所有表信息。 |
DescribeAdbMySqlSchemas | 查询所有数据库列表 | 枚举指定集群下所有数据库列表。 |
GetViewDDL | 查询视图的创建语句 | 查询视图的创建语句。 |
GetViewObjects | 查询视图信息 | 查询视图信息。 |
GetDatabaseObjects | 查询数据库信息 | 查询数据库信息。 |
GetTable | 查询表信息 | 获取表信息。 |
GetTableColumns | 查询列信息 | 查询列信息。 |
GetTableDDL | 查询建表语句 | 查询建表语句。 |
GetTableObjects | 查询表信息 | 查询表信息。 |
CheckSampleDataSet | 检查内置数据集状态 | |
DescribeSchemas | 枚举实例的库列表 | 查询指定实例的数据库列表信息。 |
DescribeAllDataSource | 枚举数据库列表 | 枚举实例下所有数据库列表、表列表和列列表。 |
DescribeTables | 枚举数据库的表列表 | 查询指定数据库的表列表信息。 |
DescribeColumns | 枚举表的列列表 | 查询指定表的列列表信息。 |
LoadSampleDataSet | 加载内置数据集 | 调用LoadSampleDataSet接口加载内置数据集。 |
诊断优化
API | 标题 | API概述 |
---|---|---|
DescribeSqlPattern | 查询SQL Pattern详情 | 查看指定日期内AnalyticDB MySQL湖仓版(3.0)集群下的SQL Pattern详情。 |
DescribeSQLPatterns | 查询SQL Pattern列表 | 查看指定日期内AnalyticDB MySQL湖仓版集群的SQL Pattern列表。 |
DescribePatternPerformance | 查询SQL Pattern的指标 | 查看集群指定时间段内SQL Pattern的各指标(如查询时间、平均内存消耗)详情。 |
空间分析
API | 标题 | API概述 |
---|---|---|
DescribeDBClusterSpaceSummary | 查看集群的空间概览 | 查看实例的空间概览信息,包括总数据量、热数据量、冷数据量、数据增长量等。 |
DescribeExcessivePrimaryKeys | 检测主键过多表 | 查看集群存在主键过多的表信息。 |
运维管理
API | 标题 | API概述 |
---|---|---|
ModifyDBClusterMaintainTime | 修改可维护时间段 | 修改指定集群的可维护时间段。 |
查询链接
API | 标题 | API概述 |
---|---|---|
DescribeApsActionLogs | 查询实时数据接入任务的日志 | 查询集群实时数据接入任务的日志详细信息。 |