全部产品

：DAS API概览

更新时间：Jun 27, 2023

数据库自治服务DAS提供以下相关API接口。

实例接入

API	描述
AddHDMInstance	添加数据库实例。

SQL限流

API	描述
EnableSqlConcurrencyControl	控制数据库请求访问量和SQL并发量。
DisableSqlConcurrencyControl	关闭指定限流规则。
DisableAllSqlConcurrencyControlRules	关闭全部正在执行的限流规则。
GetRunningSqlConcurrencyControlRules	获取正在执行的限流规则。
GetSqlConcurrencyControlRulesHistory	获取历史限流规则。
GetSqlConcurrencyControlKeywordsFromSqlText	根据原始SQL语句，生成限流关键词串。

SQL诊断

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

智能压测

API	描述
DescribeCloudBenchTasks	查询压测任务列表。
DescribeCloudbenchTask	查询压测任务。
DescribeCloudbenchTaskConfig	查询压测任务配置。
RunCloudBenchTask	执行压测任务。
CreateCloudBenchTasks	接口创建压测任务。
DeleteCloudBenchTask	删除压测任务。
StopCloudBenchTask	停止压测任务。
CreateAdamBenchTask	在ADAM上创建压测任务。
DeleteStopGateway	删除已停止的DBGateway元数据。

诊断报告

API	描述
CreateDiagnosticReport	创建诊断报告。
DescribeDiagnosticReportList	查询诊断报告列表。

自动SQL优化

API	描述
GetSqlOptimizeAdvice	查询DAS自动SQL优化产生的诊断建议。
UpdateAutoSqlOptimizeStatus	批量开启、修改或关闭自动SQL优化功能。
GetInstanceSqlOptimizeStatistic	获取指定时间段内自动SQL优化任务的统计数据，包括任务总数和最大收益等。

缓存分析

API	描述
CreateCacheAnalysisJob	创建缓存分析任务。
DescribeCacheAnalysisJob	查询缓存分析任务详情。
DescribeCacheAnalysisJobs	查询缓存分析任务列表。

巡检评分

API	描述
GetInstanceInspections	获取实例巡检评分。

事件通知

API	描述
SetEventSubscription	配置数据库实例的事件订阅设置。
GetEventSubscription	获取数据库实例的事件订阅设置。
GetAutonomousNotifyEventContent	获取自治事件内容。
GetAutonomousNotifyEventsInRange	获取指定事件范围内的通知事件。

Redis热键

API	描述
DescribeHotKeys	查询Redis实例热Key。
DescribeHotBigKeys	获取当前内存中的热Key和大Key。
DescribeTopHotKeys	获取一段时间内排名前20的热Key。
DescribeTopBigKeys	获取一段时间内排名前20的大Key。

查询治理

API	描述
GetQueryOptimizeExecErrorStats	获取执行失败的模板数据。
GetQueryOptimizeExecErrorSample	获取执行失败的样本数据。
GetQueryOptimizeSolution	获取治理建议。
GetQueryOptimizeRuleList	获取规则列表。
GetQueryOptimizeDataTrend	获取查询治理趋势数据。
GetQueryOptimizeDataTop	获取查询治理实例红榜和实例黑榜的数据。
GetQueryOptimizeDataStats	获取查询治理模板数据。
CreateQueryOptimizeTag	对目标SQL进行打标。
GetQueryOptimizeTag	获取指定SQL的标签。
GetQueryOptimizeShareUrl	获取查询治理的分享链接。

SQL洞察

API	描述
GetAsyncErrorRequestStatByCode	查询数据库实例SQL洞察结果中的MySQL错误码以及每个错误码对应的SQL数量。
GetAsyncErrorRequestStatResult	获取数据库实例SQL洞察结果中指定SQL的执行错误次数。
GetAsyncErrorRequestListByCode	查询数据库实例SQL洞察结果中产生指定MySQL错误码的SQL ID。
GetErrorRequestSample	查询数据库实例SQL洞察结果中执行错误的SQL样本数据，最多返回指定时间范围内20条数据。
GetFullRequestOriginStatByInstanceId	按照访问来源统计数据库实例SQL洞察结果中的全量请求数据。
GetFullRequestStatResultByInstanceId	按照SQL ID异步统计数据库实例SQL洞察结果中的全量请求数据。
GetFullRequestSampleByInstanceId	按照SQL ID查询数据库实例SQL洞察结果中的SQL样本数据，最大返回20条样本数据。
GetDasSQLLogHotDat	查询数据库实例7天内SQL洞察和审计（新版）的热存储数据明细。

专业版管理

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

实例会话

API	描述
GetRedisAllSession	获取Redis数据库实例当前会话数据。
KillInstanceAllSession	结束指定实例上的全部会话。
CreateKillInstanceSessionTask	创建结束会话的任务。
GetKillInstanceSessionTaskResult	获取结束会话任务的结果。
GetMySQLAllSessionAsync	采用异步方式获取实例当前会话数据，并按照不同维度统计会话信息。

自动SQL限流

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

自动空间优化

API	描述
UpdateAutoResourceOptimizeRulesAsync	采用异步方式，批量设置指定数据库实例空间碎片自动回收功能的配置参数。
GetAutoResourceOptimizeRules	获取指定数据库实例的空间碎片自动回收规则。
DisableAutoResourceOptimizeRules	批量关闭指定数据库实例的空间碎片自动回收功能。

自动弹性伸缩

API	描述
ModifyAutoScalingConfig	修改实例弹性伸缩功能配置。
DescribeAutoScalingConfig	查询实例弹性伸缩功能配置信息。
DisableInstanceDasConfig	关闭指定弹性伸缩功能。

分区热力图

API	描述
GetPartitionsHeatmap	查看PolarDB-X 2.0分区访问热度和数据热点。

性能洞察（新版）

API	描述
GetPfsSqlSample	获取性能洞察（新版）功能的SQL样本数据。
GetPfsMetricTrends	查询数据库实例性能洞察（新版）指定指标的趋势。
GetPfsSqlSummaries	查询数据库实例性能洞察（新版）中按照SQL ID维度统计的全量请求数据。