API概览

本产品(数据库自治服务/2020-01-16)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行对接,或提交工单反馈给我们。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例接入

API标题API概述
AddHDMInstance接入数据库实例调用AddHDMInstance接口,将数据库实例接入DAS。

巡检评分

API标题API概述
GetInstanceInspections获取巡检评分的结果调用GetInstanceInspections接口,获取数据库实例巡检评分的结果。

事件通知

API标题API概述
GetAutonomousNotifyEventContent获取实例自治事件内容调用GetAutonomousNotifyEventContent接口,获取指定数据库实例自治事件的内容。
GetAutonomousNotifyEventsInRange获取指定时间范围内的通知事件调用GetAutonomousNotifyEventsInRange接口,获取指定时间范围内的通知事件列表。

诊断报告

API标题API概述
CreateDiagnosticReport创建诊断任务调用CreateDiagnosticReport接口,创建诊断任务。
DescribeDiagnosticReportList查询诊断报告调用DescribeDiagnosticReportList接口,查询诊断报告。

自动SQL优化

API标题API概述
GetSqlOptimizeAdvice查询自动SQL优化产生的诊断建议调用GetSqlOptimizeAdvice接口,查询DAS自动SQL优化产生的诊断建议。
UpdateAutoSqlOptimizeStatus批量开启、修改或关闭自动SQL优化功能调用UpdateAutoSqlOptimizeStatus接口,批量开启、修改或关闭自动SQL优化功能。

缓存分析

API标题API概述
CreateCacheAnalysisJob创建缓存分析任务调用CreateCacheAnalysisJob接口,创建缓存分析任务。
DescribeCacheAnalysisJob查询缓存分析任务详情调用DescribeCacheAnalysisJob接口,查询缓存分析任务详情。
DescribeCacheAnalysisJobs查询缓存分析任务列表调用DescribeCacheAnalysisJobs接口,查询缓存分析任务列表。

SQL限流

API标题API概述
EnableSqlConcurrencyControl增加限流规则调用EnableSqlConcurrencyControl接口,增加SQL限流规则来控制数据库请求访问量和SQL并发量。
DisableSqlConcurrencyControl关闭指定限流规则调用DisableSqlConcurrencyControl接口,关闭指定限流规则。
DisableAllSqlConcurrencyControlRules关闭全部正在执行的限流规则调用DisableAllSqlConcurrencyControl接口,关闭全部正在执行的限流规则。
GetRunningSqlConcurrencyControlRules获取正在执行的限流规则调用GetRunningSqlConcurrencyControlRules接口,获取正在执行的限流规则。
GetSqlConcurrencyControlRulesHistory获取限流历史调用GetRunningSqlConcurrencyControlRules接口,获取正在执行或被触发过的限流规则。
GetSqlConcurrencyControlKeywordsFromSqlText根据SQL语句生成限流关键词调用GetSqlConcurrencyControlKeywordsFromSqlText接口,根据原始SQL语句生成限流关键词串。

SQL诊断

API标题API概述
CreateRequestDiagnosis发起SQL诊断请求调用CreateRequestDiagnosis接口,在接入DAS的实例上发起SQL诊断请求。
GetRequestDiagnosisPage分页获取SQL诊断历史记录调用GetRequestDiagnosisPage接口,分页获取SQL诊断历史记录。
GetRequestDiagnosisResult查询SQL诊断结果调用GetRequestDiagnosisResult接口,查询SQL诊断的结果。

智能压测

API标题API概述
StopCloudBenchTask停止压测任务调用StopCloudBenchTask接口,停止压测任务。
DeleteCloudBenchTask删除压测任务调用DeleteCloudBenchTask接口,删除压测任务。
CreateCloudBenchTasks创建压测任务调用CreateCloudBenchTasks接口,创建压测任务。
RunCloudBenchTask执行压测任务调用RunCloudBenchTask接口,执行压测任务。
DescribeCloudbenchTaskConfig查询压测任务配置调用DescribeCloudbenchTaskConfig接口,查询压测任务配置信息。
DescribeCloudbenchTask查询压测任务调用DescribeCloudbenchTask接口,查询压测任务。
DescribeCloudBenchTasks查询压测任务列表调用DescribeCloudBenchTasks接口,查询压测任务列表。
CreateAdamBenchTask 在ADAM上创建压测任务通过CreateAdamBenchTask接口,在ADAM上创建压测任务。
DeleteStopGateway删除已停止的DBGateway元数据调用DeleteStopGateway接口,删除已停止的DBGateway元数据。

Key分析

API标题API概述
DescribeHotBigKeys实时获取热Key和大Key调用DescribeHotBigKeys接口,实时获取当前内存中的热Key和大Key。
DescribeTopHotKeys获取排名前100的热Key调用DescribeTopHotKeys接口,获取一段时间内排名前100的热Key。
DescribeTopBigKeys获取排名前100的大Key调用DescribeTopBigKeys接口,获取指定时间范围内排名前100的大Key。
DescribeHotKeys查询实例当前热Key调用DescribeHotKeys接口,查询Redis实例当前的热Key。

查询治理

API标题API概述
GetQueryOptimizeExecErrorStats获取执行失败的SQL模板数据调用GetQueryOptimizeExecErrorStats接口,获取执行失败的模板数据。
GetQueryOptimizeExecErrorSample获取执行失败的样本数据调用GetQueryOptimizeExecErrorSample接口,获取执行失败的样本数据。
GetQueryOptimizeSolution获取治理建议调用GetQueryOptimizeSolution接口,获取治理建议。
GetQueryOptimizeRuleList获取规则列表调用GetQueryOptimizeRuleList接口,获取规则列表。
GetQueryOptimizeDataTrend获取查询治理趋势数据调用GetQueryOptimizeDataTrend接口,获取查询治理趋势数据。
GetQueryOptimizeDataTop获取查询治理实例红榜和实例黑榜的数据调用GetQueryOptimizeDataTop接口,获取查询治理实例红榜和实例黑榜的数据。
GetQueryOptimizeDataStats获取查询治理模板数据调用GetQueryOptimizeDataStats接口,获取查询治理模板数据。

SQL洞察

API标题API概述
GetErrorRequestSample查询执行错误的SQL样本数据调用GetErrorRequestSample接口,异步查询数据库实例SQL洞察结果中执行错误的SQL样本数据,最多返回指定时间范围内20条数据。
GetAsyncErrorRequestStatResult获取指定SQL的执行错误次数调用GetAsyncErrorRequestStatResult接口,异步获取数据库实例SQL洞察结果中指定SQL的执行错误次数。
GetAsyncErrorRequestListByCode查询产生指定MySQL错误码的SQL ID调用GetAsyncErrorRequestListByCode接口,异步查询数据库实例SQL洞察结果中产生指定MySQL错误码的SQL ID。
GetAsyncErrorRequestStatByCode查询MySQL错误码以及每个错误码对应的SQL数量调用GetAsyncErrorRequestStatByCode接口,异步查询数据库实例SQL洞察结果中的MySQL错误码以及每个错误码对应的SQL数量。
GetFullRequestOriginStatByInstanceId按照访问来源统计全量请求数据调用GetFullRequestOriginStatByInstanceId接口,按照访问来源统计数据库实例SQL洞察结果中的全量请求数据。
GetFullRequestStatResultByInstanceId按照SQL ID异步统计全量请求数据调用GetFullRequestStatResultByInstanceId接口,按照SQL ID异步统计数据库实例SQL洞察结果中的全量请求数据。
GetFullRequestSampleByInstanceId按照SQL ID查询SQL样本数据调用GetFullRequestSampleByInstanceId接口,按照SQL ID查询数据库实例SQL洞察结果中的SQL样本数据,最大返回20条样本数据。

专业版管理

API标题API概述
DescribeInstanceDasPro查询是否开启了DAS专业版调用DescribeInstanceDasPro接口,查询指定数据库实例是否开启了DAS专业版。
GetDasProServiceUsage 查询SQL洞察存储空间使用情况调用GetDasProServiceUsage接口,查询数据库实例SQL洞察存储空间的使用情况。
EnableDasPro开启DAS专业版调用EnableDasPro接口,为指定数据库实例开启DAS专业版。
DisableDasPro关闭DAS专业版调用DisableDasPro接口,关闭指定数据库实例的DAS专业版。

实例会话

API标题API概述
KillInstanceAllSession结束全部会话调用KillInstanceAllSession接口,结束指定实例上的全部会话。

自动SQL限流

API标题API概述
UpdateAutoThrottleRulesAsync设置自动SQL限流配置参数调用UpdateAutoThrottleRulesAsync接口,采用异步方式,批量设置指定数据库实例的自动SQL限流配置参数。
GetAutoThrottleRules获取自动SQL限流规则调用GetAutoThrottleRules接口,获取指定数据库实例的自动SQL限流规则。
DisableAutoThrottleRules关闭自动SQL限流功能调用DisableAutoThrottleRules接口,批量关闭指定数据库实例的自动SQL限流功能。

自动空间优化

API标题API概述
DisableAutoResourceOptimizeRules关闭空间碎片自动回收功能调用DisableAutoResourceOptimizeRules接口,批量关闭指定数据库实例的空间碎片自动回收功能。
UpdateAutoResourceOptimizeRulesAsync设置空间碎片自动回收功能的配置参数调用UpdateAutoResourceOptimizeRulesAsync接口,采用异步方式,批量设置指定数据库实例空间碎片自动回收功能的配置参数。
GetAutoResourceOptimizeRules获取空间碎片自动回收规则调用GetAutoResourceOptimizeRules接口,获取指定数据库实例的空间碎片自动回收规则。
阿里云首页 数据库自治服务 DAS 相关技术圈