云原生数据仓库AnalyticDB MySQL版_API文档

云原生数据仓库AnalyticDB MySQL版 - OpenAPI 概览2019-03-15
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
集群管理
OpenAPI 名称描述操作
CreateDBClusterhot创建数仓版集群查看文档去调试
DescribeDBClustershot查询数仓版集群列表查看文档去调试
DescribeDBClusterStatus查询数仓版集群的状态列表查看文档去调试
DescribeDBClusterAttributehot查看目标AnalyticDB MySQL版集群的详细信息查看文档去调试
DescribeAutoRenewAttribute查询包年包月集群自动续费状态查看文档去调试
DescribeAvailableResource查询指定可用区资源查看文档去调试
DescribeComputeResource查询数仓版集群指定地域下的计算资源规格查看文档去调试
DescribeEIURange查询数仓版集群可选择的弹性IO资源数量范围查看文档去调试
ModifyDBCluster对数仓版集群进行升降配查看文档去调试
ModifyDBClusterMaintainTime修改实例可维护时间段查看文档去调试
ModifyDBClusterPayType修改AnalyticDB MySQL集群的付费类型查看文档去调试
ModifyAutoRenewAttribute设置包年包月集群自动续费状态查看文档去调试
ModifyDBClusterDescription修改集群的备注名,方便维护管理查看文档去调试
ModifyDBClusterResourceGroup修改AnalyticDB MySQL集群的资源组查看文档去调试
DeleteDBCluster删除数仓版集群查看文档去调试
AttachUserENI为数仓版集群创建VPC弹性网卡,从而打通ADB节点到用户VPC的网络访问查看文档去调试
DetachUserENI删除数仓版集群已创建的VPC弹性网卡查看文档去调试
DescribeKernelVersion调用DescrbeKernelVersion接口查看目标数仓版集群的内核版本信息查看文档去调试
UpgradeKernelVersion升级目标AnalyticDB MySQL版集群的内核版本查看文档去调试
MigrateDBCluster将数仓版迁移至湖仓版集群查看文档去调试
资源组管理(旧版)
OpenAPI 名称描述操作
CreateDBResourcePool创建资源组。仅适用于AnalyticDB MySQL弹性模式集群版(新版)查看文档去调试
DescribeDBResourcePool查询集群的资源组信息。该接口仅适用于数仓版弹性模式集群版(新版)查看文档去调试
ModifyDBResourcePool更新资源组的资源。该接口仅适用于数仓版弹性模式集群版(新版)查看文档去调试
DeleteDBResourcePool删除资源组。该接口仅适用于数仓版弹性模式集群版(新版)查看文档去调试
BindDBResourcePoolWithUser将资源组与数据库用户进行绑定查看文档去调试
UnbindDBResourcePoolWithUser解绑资源组用户。该接口仅适用于数仓版弹性模式集群版(新版)查看文档去调试
资源组管理(新版)
OpenAPI 名称描述操作
CreateDBResourceGroup为数仓版集群创建资源组查看文档去调试
DescribeDBResourceGroup查询数仓版集群的资源组信息查看文档去调试
ModifyDBResourceGroup变更数仓版集群资源组的节点数量或查询模式查看文档去调试
DeleteDBResourceGroup删除数仓版集群的指定资源组查看文档去调试
BindDBResourceGroupWithUser为数仓版集群的资源组绑定数据库账号查看文档去调试
UnbindDBResourceGroupWithUser为数仓版集群的资源组解绑数据库账号查看文档去调试
DescribeResubmitConfig查询作业投递规则查看文档去调试
ModifyResubmitConfig修改作业投递规则查看文档去调试
ModifySQAConfig修改作业投递规则查看文档去调试
DescribeSQAConfig查询集群小查询加速的配置查看文档去调试
弹性计划管理
OpenAPI 名称描述操作
CreateElasticPlan创建分时弹性计划。该接口仅适用于数仓版弹性模式集群版(新版)查看文档去调试
DescribeElasticDailyPlan查询分时弹性计划日计划执行信息。该接口仅适用于数仓版弹性模式集群版(新版)查看文档去调试
DescribeElasticPlan查询弹性计划。该接口仅适用于数仓版弹性模式集群版(新版)查看文档去调试
ModifyElasticPlan修改分时弹性计划。该接口仅适用于数仓版弹性模式集群版(新版)查看文档去调试
DeleteElasticPlan删除分时弹性计划。该接口仅适用于数仓版弹性模式集群版(新版)查看文档去调试
数据库
OpenAPI 名称描述操作
DescribeTableshot枚举实例指定数据库下所有表列表查看文档去调试
DescribeAllDataSource枚举实例下所有数据库列表、表列表和列列表查看文档去调试
DescribeSchemas枚举实例下所有数据库列表查看文档去调试
DescribeTableDetail查看表在每个Shard的数据分布情况查看文档去调试
DescribeProcessList查看实例正在运行的查询查看文档去调试
DescribeColumns枚举实例下指定表格的列列表查看文档去调试
DescribeTaskInfo查看相关管控任务流进度查看文档去调试
DescribeSQLPlan查询目标SQL,例如查询语句或ETL(Extract Transform Load)任务语句的计划信息查看文档去调试
DescribeSQLPlanTask查询任务信息查看文档去调试
DescribeTablePartitionDiagnose查询分区诊断信息查看文档去调试
DescribeLoadTasksRecords查看异步导入导出任务的详情查看文档去调试
DescribeConnectionCountRecords返回目标AnalyticDB MySQL版集群当前的连接数查看文档去调试
KillProcess终止正在进行的任务查看文档去调试
日志管理
OpenAPI 名称描述操作
DescribeSlowLogRecordshot查看AnalyticDB MySQL版集群的慢日志明细查看文档去调试
DescribeAuditLogConfig查询集群审计日志设置查看文档去调试
DescribeAuditLogRecordshot查询数仓版集群的SQL审计日志查看文档去调试
ModifyAuditLogConfig修改审计日志设置查看文档去调试
地域管理
OpenAPI 名称描述操作
DescribeRegionshot查询ADB可选的地域和可用区查看文档去调试
网络管理
OpenAPI 名称描述操作
DescribeDBClusterNetInfo查询集群的网络信息查看文档去调试
ModifyClusterConnectionString修改实例的网络连接地址查看文档去调试
AllocateClusterPublicConnection为数仓版集群申请公网连接地址查看文档去调试
ReleaseClusterPublicConnection释放集群的公网连接地址查看文档去调试
DescribeVSwitches查询交换机列表查看文档去调试
账号管理
OpenAPI 名称描述操作
CreateAccount创建账号查看文档去调试
DescribeAllAccounts查询指定集群、指定数据库的账号列表信息或某个指定账号的信息查看文档去调试
DescribeAccounts查询集群的账号信息查看文档去调试
DescribeOperatorPermission查询集群服务账号的授权详情查看文档去调试
ModifyAccountDescription修改数据库账号的备注信息查看文档去调试
DeleteAccount删除数据库账号查看文档去调试
GrantOperatorPermission为集群服务账号授权查看文档去调试
ResetAccountPassword重置数据库账号的密码查看文档去调试
RevokeOperatorPermission撤销集群服务账号权限查看文档去调试
标签管理
OpenAPI 名称描述操作
ListTagResources查询一个或多个AnalyticDB MySQL集群已绑定的标签列表,或者查询一个或多个标签绑定的AnalyticDB MySQL集群列表查看文档去调试
TagResources为AnalyticDB MySQL集群绑定标签查看文档去调试
UntagResources解绑后,如果该标签没有绑定其他任何实例查看文档去调试
安全管理
OpenAPI 名称描述操作
DescribeDBClusterAccessWhiteList查看集群的IP白名单查看文档去调试
ModifyDBClusterAccessWhiteListhot创建或修改集群的白名单(包括IP白名单和安全组)查看文档去调试
DescribeDBClusterSSL查询集群的SSL配置情况查看文档去调试
ModifyDBClusterSSL修改集群的SSL链路配置查看文档去调试
备份恢复
OpenAPI 名称描述操作
DescribeBackupPolicy查看集群备份设置查看文档去调试
DescribeBackups查看集群的备份列表查看文档去调试
ModifyBackupPolicy修改AnalyticDB MySQL版实例的备份策略查看文档去调试
ModifyLogBackupPolicy修改日志备份设置查看文档去调试
监控管理
OpenAPI 名称描述操作
DescribeDBClusterHealthStatus查看数仓版集群的健康状态查看文档去调试
DescribeDBClusterPerformancehot查看目标集群的性能数据查看文档去调试
DescribeDBClusterResourcePoolPerformance查询弹性模式集群版(新版)ADB集群的资源池监控信息查看文档去调试
DescribeInclinedTables查看表监控查看文档去调试
运维事件
OpenAPI 名称描述操作
DescribeMaintenanceAction查询运维事件的详细信息查看文档去调试
ModifyMaintenanceAction修改运维事件的执行时间查看文档去调试
SQL诊断
OpenAPI 名称描述操作
DescribeDiagnosisTasks获取指定查询ID和Stage ID的分布式子任务执行详情信息查看文档去调试
DescribeDiagnosisRecordshot查看目标AnalyticDB MySQL版集群中符合指定检索条件的SQL语句摘要信息查看文档去调试
DescribeDiagnosisDimensions查看符合指定检索条件的SQL在资源组、数据库名、用户名以及访问源地址等维度下的去重统计信息查看文档去调试
DescribeDownloadRecords查看目标AnalyticDB MySQL版集群中最近5次的SQL查询下载任务列表查看文档去调试
DescribeDiagnosisSQLInfo查看某个SQL的执行详情,包括执行计划、运行信息、资源使用、自诊断结果等查看文档去调试
DescribeDiagnosisMonitorPerformance用于获取用户选定时间范围内查询的执行开始时间信息和结束时间信息查看文档去调试
DescribeSQLPatterns查看指定日期内AnalyticDB MySQL版集群下的SQL Pattern列表查看文档去调试
DescribePatternPerformance查看指定时间段内SQL Pattern的各指标(如查询时间、平均内存消耗)详情查看文档去调试
DescribeAdviceServiceEnabled用DescribeAdviceServiceEnabled来查询建议服务是否开启查看文档去调试
DescribeAppliedAdvices来显示已采纳的优化建议查看文档去调试
DescribeAvailableAdvices用DescribeAvailableAdvices来显示可用优化建议查看文档去调试
DownloadDiagnosisRecords下载目标AnalyticDB MySQL版集群中符合指定条件的查询SQL的摘要信息查看文档去调试
EnableAdviceService用EnableAdviceService来开启建议服务查看文档去调试
ApplyAdviceById应用一条优化建议查看文档去调试
BatchApplyAdviceByIdList用BatchApplyAdviceByIdList接口批量应用多条优化建议查看文档去调试
DisableAdviceService用DisableAdviceService来关闭建议服务查看文档去调试
空间分析
OpenAPI 名称描述操作
DescribeDBClusterSpaceSummary查看实例的空间概览信息,包括总数据量、热数据量、冷数据量、数据增长量等查看文档去调试
DescribeTableStatistics查询目标AnalyticDB MySQL集群中的表信息统计详情查看文档去调试
DescribeExcessivePrimaryKeys查看集群存在主键过多的表查看文档去调试
实例运行报告
OpenAPI 名称描述操作
DescribeTableAccessCount查看指定日期内AnalyticDB MySQL版集群下目标表或所有表的被访问次数查看文档去调试
DescribeSqlPattern查看指定日期内AnalyticDB MySQL版集群下的SQL模板详情查看文档去调试
其它
OpenAPI 名称描述操作
CheckServiceLinkedRole校验服务关联角色查看文档去调试
CreateServiceLinkedRole创建服务关联角色查看文档去调试
DescribeKmsKeys查询用户KMS密钥列表查看文档去调试
DescribeLogHubAttribute查询SLS链路详情查看文档去调试
DescribeLogStoreKeys查询日志库中的关键字查看文档去调试
DescribeLoghubDetail查询日志采集详情查看文档去调试
DescribeRdsAnalysisResourceQuotas查询RDS分析实例配额查看文档去调试
DescribeRegionsMixed查询地域信息查看文档去调试
DescribeSyncAvailableDBClusterList查询同步可用的实例列表查看文档去调试
DescribeSyncJobList查询集群同步作业列表查看文档去调试
DescribeVSwitchs查询可组网信息查看文档去调试
DescribeVpcs获取指定地域内可用的VPC查看文档去调试
ModifyLogHubStatus修改SLS链路状态查看文档去调试
ModifySyncJob修改同步任务查看文档去调试
OperateLogHub创建日志任务查看文档去调试
CancelActiveOperationTasks取消运维事件查看文档去调试
DescribeHistoryEventsStat查询统计历史事件查看文档去调试
ModifyActiveOperationMaintainConf修改运维事件事件配置查看文档去调试
DescribeActiveOperationTasks获取运维事件查看文档去调试
DescribeActiveOperationMaintainConf查询主动运维配置查看文档去调试
ModifyActiveOperationTasks修改运维事件执行时间查看文档去调试
DescribeControllerDetection查询控制器检测查看文档去调试
DescribeWorkerDetection存储节点检测查看文档去调试
DescribeAbnormalPatternDetection查询异常模式检测查看文档去调试
DescribeBadSqlDetection查看BadSQL查看文档去调试
DescribeExecutorDetection计算节点检测查看文档去调试
ModifyDBClusterVip修改集群访问VIP查看文档去调试
GetCreateTableSQL查询某个表的建表语句查看文档去调试
DescribeInclinedNodes查询存储节点磁盘水位查看文档去调试
DescribeOversizeNonPartitionTableInfos查询过大的非分区表查看文档去调试
DeleteBackups删除备份集查看文档去调试
DescribeDBClusterShardNumber获取实例分片数目查看文档去调试