数据库自治服务_API文档

数据库自治服务 - OpenAPI 概览2020-01-16
插件下载了解更多
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 名称描述操作
AddHDMInstancehot将数据库实例接入DAS查看文档去调试
巡检评分
OpenAPI 名称描述操作
GetInstanceInspectionshot获取数据库实例巡检评分的结果查看文档去调试
事件通知
OpenAPI 名称描述操作
GetEventSubscription获取数据库实例的事件订阅设置查看文档去调试
GetAutonomousNotifyEventContent获取指定数据库实例自治事件的内容查看文档去调试
GetAutonomousNotifyEventsInRange获取指定类型或范围的通知事件查看文档去调试
SetEventSubscription配置数据库实例的事件订阅设置查看文档去调试
诊断报告
OpenAPI 名称描述操作
CreateDiagnosticReporthot创建诊断报告查看文档去调试
DescribeDiagnosticReportListhot查询诊断报告查看文档去调试
GetDBInstanceConnectivityDiagnosis获取用户输入IP地址到指定数据库实例的网络连通性诊断结果查看文档去调试
缓存分析
OpenAPI 名称描述操作
CreateCacheAnalysisJobhot创建缓存分析任务查看文档去调试
DescribeCacheAnalysisJobhot查询缓存分析任务详情查看文档去调试
DescribeCacheAnalysisJobs查询缓存分析任务列表查看文档去调试
SQL限流
OpenAPI 名称描述操作
EnableSqlConcurrencyControl启用SQL限流来控制数据库请求访问量和SQL并发量查看文档去调试
GetRunningSqlConcurrencyControlRules获取正在执行的限流规则查看文档去调试
GetSqlConcurrencyControlRulesHistory获取正在执行或被触发过的限流规则查看文档去调试
GetSqlConcurrencyControlKeywordsFromSqlText根据原始SQL语句,生成限流关键词串查看文档去调试
DisableSqlConcurrencyControl关闭指定限流规则查看文档去调试
DisableAllSqlConcurrencyControlRules关闭全部正在执行的限流规则查看文档去调试
SQL诊断
OpenAPI 名称描述操作
CreateRequestDiagnosishot发起SQL诊断请求查看文档去调试
GetRequestDiagnosisResult查询SQL诊断的结果查看文档去调试
GetRequestDiagnosisPage分页获取SQL诊断历史记录查看文档去调试
Key分析
OpenAPI 名称描述操作
DescribeHotBigKeyshot实时获取当前内存中的热Key和大Key查看文档去调试
DescribeTopHotKeys获取一段时间内排名前100的热Key查看文档去调试
DescribeTopBigKeys获取一段时间内排名前100的大Key查看文档去调试
DescribeHotKeys查询Redis实例的热Key查看文档去调试
查询治理
OpenAPI 名称描述操作
GetQueryOptimizeExecErrorStats获取执行失败的模板数据查看文档去调试
GetQueryOptimizeExecErrorSample获取执行失败的样本数据查看文档去调试
GetQueryOptimizeSolution获取治理建议查看文档去调试
GetQueryOptimizeRuleList获取规则列表查看文档去调试
GetQueryOptimizeDataTrend获取查询治理趋势数据查看文档去调试
GetQueryOptimizeDataTop获取查询治理实例红榜和实例黑榜的数据查看文档去调试
GetQueryOptimizeDataStats获取查询治理模板数据查看文档去调试
GetQueryOptimizeTag获取指定SQL的标签查看文档去调试
GetQueryOptimizeShareUrl获取查询治理的分享链接查看文档去调试
CreateQueryOptimizeTag对目标SQL进行打标查看文档去调试
SQL洞察
OpenAPI 名称描述操作
GetErrorRequestSample异步查询数据库实例SQL洞察结果中执行错误的SQL样本数据,最多返回指定时间范围内20条数据查看文档去调试
GetAsyncErrorRequestStatResult异步获取数据库实例SQL洞察结果中指定SQL的执行错误次数查看文档去调试
GetAsyncErrorRequestListByCode异步查询数据库实例SQL洞察结果中产生指定MySQL错误码的SQL ID查看文档去调试
GetAsyncErrorRequestStatByCode异步查询数据库实例SQL洞察结果中的MySQL错误码以及每个错误码对应的SQL数量查看文档去调试
GetFullRequestOriginStatByInstanceId按照访问来源统计数据库实例SQL洞察结果中的全量请求数据查看文档去调试
GetFullRequestStatResultByInstanceIdhot按照SQL ID异步统计数据库实例SQL洞察结果中的全量请求数据查看文档去调试
GetFullRequestSampleByInstanceId按照SQL ID查询数据库实例SQL洞察结果中的SQL样本数据,最大返回20条样本数据查看文档去调试
企业版管理
OpenAPI 名称描述操作
DescribeSqlLogConfig查询数据库实例的DAS企业版配置信息查看文档去调试
DescribeSqlLogStatistic查询DAS企业版的数据统计信息查看文档去调试
GetDasSQLLogHotData获取审计日志热数据查看文档去调试
CreateSqlLogTask创建明细数据异步任务查看文档去调试
DescribeSqlLogTask查询DAS企业版离线任务详情查看文档去调试
DescribeSqlLogTasks查询实例的审计日志任务列表查看文档去调试
ModifySqlLogConfig为数据库实例开启或配置DAS企业版查看文档去调试
实例会话
OpenAPI 名称描述操作
CreateKillInstanceSessionTask创建结束会话的任务查看文档去调试
GetRedisAllSession获取Redis实例当前会话数据查看文档去调试
GetMongoDBCurrentOp获取MongoDB实例当前会话查看文档去调试
GetKillInstanceSessionTaskResult获取结束会话任务的结果查看文档去调试
GetMySQLAllSessionAsynchot采用异步方式获取实例当前会话数据,并按照不同维度统计会话信息查看文档去调试
KillInstanceAllSession结束指定实例上的全部会话查看文档去调试
空间分析
OpenAPI 名称描述操作
CreateStorageAnalysisTask创建空间分析任务,获取数据库及表的空间使用数据查看文档去调试
GetStorageAnalysisResult查询空间分析任务状态和分析结果查看文档去调试
GetAutoIncrementUsageStatistic获取表自增ID的使用数据查看文档去调试
锁优化
OpenAPI 名称描述操作
CreateLatestDeadLockAnalysis创建最近死锁分析任务查看文档去调试
GetDeadLockDetailList查询RDS SQL Server实例的死锁详情列表查看文档去调试
GetBlockingDetailList查询RDS SQL Server实例的锁阻塞列表查看文档去调试
GetDeadLockHistory获取最近死锁分析、全量死锁分析的历史分析任务列表查看文档去调试
GetDeadLockDetail查询单个死锁详情查看文档去调试
GetDeadlockHistogram查询时间范围内基于错误日志全量死锁分析的死锁数量趋势查看文档去调试
索引诊断
OpenAPI 名称描述操作
GetInstanceMissingIndexList查询RDS SQL Server实例所有缺失索引的详细信息查看文档去调试
慢日志
OpenAPI 名称描述操作
DescribeSlowLogHistogramAsync异步获取实例慢日志趋势数据查看文档去调试
DescribeSlowLogStatistic慢日志统计信息查看文档去调试
自动SQL限流
OpenAPI 名称描述操作
GetAutoThrottleRules获取指定数据库实例的自动SQL限流规则查看文档去调试
UpdateAutoThrottleRulesAsync采用异步方式,批量设置指定数据库实例的自动SQL限流配置参数查看文档去调试
DisableAutoThrottleRules批量关闭指定数据库实例的自动SQL限流功能查看文档去调试
自动SQL优化
OpenAPI 名称描述操作
GetSqlOptimizeAdvice查询DAS自动SQL优化产生的诊断建议查看文档去调试
GetInstanceSqlOptimizeStatistic获取指定时间段内自动SQL优化任务的统计数据,包括任务总数和最大收益等查看文档去调试
UpdateAutoSqlOptimizeStatus批量开启、修改或关闭自动SQL优化功能查看文档去调试
自动空间优化
OpenAPI 名称描述操作
GetAutoResourceOptimizeRules获取指定数据库实例的空间碎片自动回收规则查看文档去调试
UpdateAutoResourceOptimizeRulesAsync采用异步方式,批量设置指定数据库实例空间碎片自动回收功能的配置参数查看文档去调试
DisableAutoResourceOptimizeRules批量关闭指定数据库实例的空间碎片自动回收功能查看文档去调试
自动弹性伸缩
OpenAPI 名称描述操作
DescribeAutoScalingConfig查询实例弹性伸缩功能配置信息查看文档去调试
DescribeAutoScalingHistory查询实例弹性伸缩历史信息查看文档去调试
ModifyAutoScalingConfig修改实例弹性伸缩功能配置查看文档去调试
DisableInstanceDasConfig关闭指定弹性伸缩功能查看文档去调试
分区热力图
OpenAPI 名称描述操作
GetPartitionsHeatmap查看PolarDB-X 2.0分区访问热度和数据热点查看文档去调试
性能洞察(新版)
OpenAPI 名称描述操作
GetPfsSqlSample获取性能洞察(新版)功能的SQL样本数据查看文档去调试
GetPfsMetricTrends查询数据库实例性能洞察(新版)指定指标的趋势查看文档去调试
GetPfsSqlSummaries查询数据库实例性能洞察(新版)中按照SQL ID维度的全量请求数据查看文档去调试
其他
OpenAPI 名称描述操作
EnableDasPro开启指定实例DAS专业版查看文档去调试
DescribeSqlLogRecords查询DAS企业版日志明细查看文档去调试
DescribeInstanceDasPro查询指定数据库实例是否开启了DAS企业版 V1或企业版 V2查看文档去调试
GetDasProServiceUsage查询数据库实例DAS企业版 V1或企业版 V2存储空间的使用情况查看文档去调试
DisableDasPro关闭指定实例DAS专业版查看文档去调试
GetHDMAliyunResourceSyncResult获取资源(已经废弃)查看文档去调试
GetEndpointSwitchTask不再使用查看文档去调试
GetHDMLastAliyunResourceSyncResult获取资源同步结果(已经废弃)查看文档去调试
RunCloudBenchTask执行压测任务查看文档去调试
DescribeCloudbenchTask查询压测任务查看文档去调试
DescribeCloudBenchTasks查询压测任务列表查看文档去调试
CreateCloudBenchTasks创建压测任务查看文档去调试
DescribeCloudbenchTaskConfig查询压测任务配置信息查看文档去调试
DeleteCloudBenchTask删除压测任务查看文档去调试
DeleteStopGateway删除已停止的DBGateway元数据查看文档去调试