调用DescribeSQLPatterns查询SQL模式列表_云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

调用DescribeSQLPatterns接口查看指定日期内AnalyticDB MySQL版集群下的SQL Pattern列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeSQLPatterns	list	DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 集群的详情，包括集群 ID。	am-bp1r053byu48p****
StartTime	string	是	查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明仅支持查看最近 14 天的数据。例如：当前时间为 2021-11-22T12:00:00Z，最早可以查询到 2021-11-09T12:00:00Z 的数据。查询开始时间和查询结束时间的间隔不能大于 24 小时。	2021-09-30T00:10:00Z
EndTime	string	是	查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明查询结束时间需晚于查询开始时间。	2021-09-30T00:15:00Z
RegionId	string	是	地域 ID。说明您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息，包括地域 ID。	cn-hangzhou
Keyword	string	否	查询关键字。	SELECT
Order	string	是	将查询结果按指定字段进行排序。格式为 JSON 字符串，例如`[{"Field":"AverageQueryTime","Type":"Asc"}]`。其中： `Field`表示排序字段。取值说明： `PatternCreationTime`：查询时间范围内，Pattern 的最早提交时间。 `AverageQueryTime`：查询时间范围内，Pattern 的平均总耗时。 `MaxQueryTime`：查询时间范围内，Pattern 的最大总耗时。 `AverageExecutionTime`: 查询时间范围内，Pattern 的平均执行耗时。 `MaxExecutionTime`: 查询时间范围内，Pattern 的最大执行耗时。 `AveragePeakMemory`: 查询时间范围内，Pattern 的平均峰值内存。 `MaxPeakMemory`: 查询时间范围内，Pattern 的最大峰值内存。 `AverageScanSize`: 查询时间范围内，Pattern 的平均数据读取量。 `MaxScanSize`: 查询时间范围内，Pattern 的最大数据读取量。 `QueryCount`: 查询时间范围内，Pattern 的执行次数。 `FailedCount`: 查询时间范围内，Pattern 的失败次数。 `Type`表示排序方式。取值说明（取值不区分大小写）： `Asc`：升序排序。 `Desc`：降序排序。	[{"Field":"AverageQueryTime","Type":"Asc"}]
PageNumber	integer	否	页码，取值为大于 0 且不超过 Integer 数据类型的最大值。说明本参数不填写，默认为 1。	1
PageSize	integer	否	每页记录数，取值说明： 30 50 100 说明本参数不填写，默认为 30。	30
Lang	string	否	设置下载文件的文件标题以及部分错误信息的语言，取值说明： zh：简体中文（默认语言）。 en：英文。 ja：日文。 zh-tw：繁体中文。	zh

返回参数

名称	类型	描述	示例值
	object	列表信息。
PageNumber	integer	页数。	1
PageSize	integer	本页记录数。	30
TotalCount	integer	总记录数。	1
PatternDetails	array<object>	SQL Pattern 的详细信息。
patternDetails	object	列表。
SQLPattern	string	SQL Pattern 的具体语句。	SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)
PatternId	string	SQL Pattern 的 ID。	5575924945138******
User	string	提交 Pattern 相关的 SQL 数据库用户名。	reporter
AccessIp	string	提交 Pattern 相关的 SQL 客户端 IP 地址。	192.168.xx.xx
Tables	string	SQL Pattern 扫描的列表。	tpch.orders
PatternCreationTime	string	查询时间范围内，Pattern 的最早提交时间。单位：毫秒。	2021-11-12 03:06:00
AverageQueryTime	double	查询时间范围内，Pattern 的平均总耗时。单位：毫秒。	4
MaxQueryTime	long	查询时间范围内，Pattern 的最大总耗时。单位：毫秒。	2341
AverageExecutionTime	double	查询时间范围内，Pattern 的平均执行时间。单位：毫秒。	234.78
MaxExecutionTime	long	查询时间范围内，Pattern 的最大执行时间。单位：毫秒。	2142
AveragePeakMemory	double	查询时间范围内，Pattern 的平均峰值内存。单位：Byte。	234.22
MaxPeakMemory	long	Pattern 相关 SQL 的最大峰值内存。单位：Byte。	234149
AverageScanSize	double	查询时间范围内，Pattern 的平均数据读取量。单位：Byte。	234149.23
MaxScanSize	long	Pattern 相关 SQL 的最大数据读取量。单位：Byte。	234149
QueryCount	long	查询时间范围内，Pattern 的执行次数。	345
FailedCount	long	查询时间范围内，Pattern 的失败次数。	234
Blockable	boolean	能否拦截当前 SQL Pattern 的运行。取值说明： true：支持拦截。 false：不支持拦截。说明目前 AnalyticDB MySQL 版仅支持 Select 和 Insert 相关语句的拦截。	true
QueryTimeSum	double	查询总时间，	5
QueryTimePercentage	double	执行目标 sql 时的排队时间，单位为毫秒（ms）。	10
PeakMemorySum	double	总峰值内存，	5
PeakMemoryPercentage	double	峰值内存比率。	10
ScanSizeSum	double	扫描总量。	5
ScanSizePercentage	double	带数据源的任务的扫描数据耗时。单位：ms。	80
AverageOperatorCost	double	平均操作耗时。	5
MaxOperatorCost	double	最大操作耗时。	5
OperatorCostSum	double	操作总耗时。	5
OperatorCostPercentage	double	操作耗时比率。	20
AverageScanCost	double	平均扫描耗时。	5
MaxScanCost	double	最大扫描耗时。	5
ScanCostSum	double	扫描总耗时。	5
ScanCostPercentage	double	扫描耗时比率。	5
RequestId	string	请求 ID。	6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "PatternDetails": [
    {
      "SQLPattern": "SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)",
      "PatternId": "5575924945138******",
      "User": "reporter",
      "AccessIp": "192.168.xx.xx",
      "Tables": "tpch.orders",
      "PatternCreationTime": "2021-11-12 03:06:00",
      "AverageQueryTime": 4,
      "MaxQueryTime": 2341,
      "AverageExecutionTime": 234.78,
      "MaxExecutionTime": 2142,
      "AveragePeakMemory": 234.22,
      "MaxPeakMemory": 234149,
      "AverageScanSize": 234149.23,
      "MaxScanSize": 234149,
      "QueryCount": 345,
      "FailedCount": 234,
      "Blockable": true,
      "QueryTimeSum": 5,
      "QueryTimePercentage": 10,
      "PeakMemorySum": 5,
      "PeakMemoryPercentage": 10,
      "ScanSizeSum": 5,
      "ScanSizePercentage": 80,
      "AverageOperatorCost": 5,
      "MaxOperatorCost": 5,
      "OperatorCostSum": 5,
      "OperatorCostPercentage": 20,
      "AverageScanCost": 5,
      "MaxScanCost": 5,
      "ScanCostSum": 5,
      "ScanCostPercentage": 5
    }
  ],
  "RequestId": "6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-09-03	OpenAPI 返回结构发生变更	查看变更详情
2021-10-12	OpenAPI 返回结构发生变更	查看变更详情