本产品（
数据库自治服务
/
2020-01-16）的OpenAPI采用
RPC签名风格，签名细节参见
签名机制说明。
我们已经为开发者封装了常见编程语言的SDK，开发者可通过
下载SDK直接调用本产品OpenAPI而无需关心技术细节。
如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见
获取AccessKey。
实例接入
| API | 标题 | API概述 |
|---|---|---|
| AddHDMInstance | 接入数据库实例 | 调用AddHDMInstance接口，将数据库实例接入DAS。 |
巡检评分
| API | 标题 | API概述 |
|---|---|---|
| GetInstanceInspections | 获取巡检评分结果 | 获取数据库实例巡检评分的结果。 |
事件通知
| API | 标题 | API概述 |
|---|---|---|
| SetEventSubscription | 配置事件订阅设置 | 调用SetEventSubscription接口，配置数据库实例的事件订阅设置。 |
| GetEventSubscription | 获取事件订阅设置 | 调用GetEventSubscription接口，获取数据库实例的事件订阅设置。 |
| GetAutonomousNotifyEventContent | 获取实例自治事件内容 | 调用GetAutonomousNotifyEventContent接口，获取指定数据库实例自治事件的内容。 |
| GetAutonomousNotifyEventsInRange | 获取指定事件范围内的通知事件 | 调用GetAutonomousNotifyEventsInRange接口，获取指定事件范围内的通知事件。 |
诊断报告
| API | 标题 | API概述 |
|---|---|---|
| CreateDiagnosticReport | 创建诊断报告 | 调用CreateDiagnosticReport接口，创建诊断报告。 |
| DescribeDiagnosticReportList | 查询诊断报告 | 调用DescribeDiagnosticReportList接口，查询诊断报告。 |
自动SQL优化
| API | 标题 | API概述 |
|---|---|---|
| GetSqlOptimizeAdvice | 查询自动SQL优化产生的诊断建议 | 调用GetSqlOptimizeAdvice接口，查询DAS自动SQL优化产生的诊断建议。 |
| UpdateAutoSqlOptimizeStatus | 批量开启、修改或关闭自动SQL优化功能 | 调用UpdateAutoSqlOptimizeStatus接口，批量开启、修改或关闭自动SQL优化功能。 |
| GetInstanceSqlOptimizeStatistic | 获取自动SQL优化事件的统计数据 | 获取指定时间段内自动SQL优化任务的统计数据，包括任务总数和最大收益等。 |
缓存分析
| API | 标题 | API概述 |
|---|---|---|
| CreateCacheAnalysisJob | 创建缓存分析任务 | 调用CreateCacheAnalysisJob接口，创建缓存分析任务。 |
| DescribeCacheAnalysisJob | 查询缓存分析任务详情 | 调用DescribeCacheAnalysisJob接口，查询缓存分析任务详情。 |
| DescribeCacheAnalysisJobs | 查询缓存分析任务列表 | 调用DescribeCacheAnalysisJobs接口，查询缓存分析任务列表。 |
SQL限流
| API | 标题 | API概述 |
|---|---|---|
| EnableSqlConcurrencyControl | 增加限流规则 | 调用EnableSqlConcurrencyControl接口，增加SQL限流规则来控制数据库请求访问量和SQL并发量。 |
| DisableSqlConcurrencyControl | 关闭指定限流规则 | 调用DisableSqlConcurrencyControl接口，关闭指定限流规则。 |
| DisableAllSqlConcurrencyControlRules | 关闭全部正在执行的限流规则 | 调用DisableAllSqlConcurrencyControl接口，关闭全部正在执行的限流规则。 |
| GetRunningSqlConcurrencyControlRules | 获取正在执行的限流规则 | 调用GetRunningSqlConcurrencyControlRules接口，获取正在执行的限流规则。 |
| GetSqlConcurrencyControlRulesHistory | 获取限流历史 | 调用GetSqlConcurrencyControlRulesHistory接口，获取正在执行或被触发过的限流规则。 |
| 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 | 获取一段时间内排名前100的热Key。 |
| DescribeTopBigKeys | 获取排名前100的大Key | 调用DescribeTopBigKeys接口，获取一段时间内排名前100的大Key。 |
| DescribeHotKeys | 查询实例当前的热Key | 调用DescribeHotKeys接口，查询Redis实例的热Key。 |
查询治理
| API | 标题 | API概述 |
|---|---|---|
| GetQueryOptimizeExecErrorStats | 获取执行失败的模板数据 | 调用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概述 |
|---|---|---|
| GetRedisAllSession | 获取Redis实例当前会话 | 获取Redis实例当前会话数据。 |
| 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接口，获取指定数据库实例的空间碎片自动回收规则。 |
自动弹性伸缩
| API | 标题 | API概述 |
|---|---|---|
| ModifyAutoScalingConfig | 修改实例弹性伸缩功能配置 | 调用ModifyAutoScalingConfig接口，修改实例弹性伸缩功能配置。 |
| DescribeAutoScalingConfig | 查询实例弹性伸缩功能配置信息 | 调用DescribeAutoScalingConfig接口，查询实例弹性伸缩功能配置信息。 |
| DisableInstanceDasConfig | 关闭指定弹性伸缩功能 | 调用DisableInstanceDasConfig接口，关闭指定弹性伸缩功能。 |
分区热力图
| API | 标题 | API概述 |
|---|---|---|
| GetPartitionsHeatmap | 获取分区热度信息 | 调用GetPartitionsHeatmap接口，查看PolarDB-X 2.0分区访问热度和数据热点。 |