首页 云原生数据仓库AnalyticDB MySQL版 开发参考 API参考（数仓版） API目录 SQL诊断 DescribeSQLPatterns - 查询SQL模式列表

DescribeSQLPatterns - 查询SQL模式列表

更新时间: 2023-04-13 15:06:25

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

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
DBClusterIdstring是

集群ID。

说明您可以调用DescribeDBClusters接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。
am-bp1r053byu48p****
StartTimestring是

查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

说明
  • 仅支持查看最近14天的数据。例如：当前时间为2021-11-22T12:00:00Z，最早可以查询到2021-11-09T12:00:00Z的数据。
  • 查询开始时间和查询结束时间的间隔不能大于24小时。
    		• 2021-09-30T00:10:00Z
    EndTimestring是

    查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    说明查询结束时间需晚于查询开始时间。
    		2021-09-30T00:15:00Z
    RegionIdstring是

    地域ID。

    说明您可以调用DescribeRegions接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。
    		cn-hangzhou
    Keywordstring否

    查询关键字。

    		SELECT
    Orderstring是

    将查询结果按指定字段进行排序。格式为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"}]
    PageNumberinteger否

    页码，取值为大于0且不超过Integer数据类型的最大值。

    说明本参数不填写，默认为1。
    		1
    PageSizeinteger否

    每页记录数，取值说明：

    • 30
    • 50
    • 100
    说明本参数不填写，默认为30。
    		30
    Langstring否

    设置下载文件的文件标题以及部分错误信息的语言，取值说明：

    • zh：简体中文（默认语言）。
    • en：英文。
    • ja：日文。
    • zh-tw：繁体中文。
    		zh

    返回参数

    名称类型描述示例值
    object

    列表信息。

    PageNumberinteger

    页数。

    		1
    PageSizeinteger

    本页记录数。

    		30
    TotalCountinteger

    总记录数。

    		1
    PatternDetailsarray

    SQL Pattern的详细信息。

    object

    列表。

    SQLPatternstring

    SQL Pattern的具体语句。

    		SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)
    PatternIdstring

    SQL Pattern的ID。

    		5575924945138******
    Userstring

    提交Pattern相关的SQL数据库用户名。

    		reporter
    AccessIpstring

    提交Pattern相关的SQL客户端IP地址。

    		192.168.xx.xx
    Tablesstring

    SQL Pattern扫描的列表。

    		tpch.orders
    PatternCreationTimestring

    查询时间范围内，Pattern的最早提交时间。单位：毫秒。

    		2021-11-12 03:06:00
    AverageQueryTimedouble

    查询时间范围内，Pattern的平均总耗时。单位：毫秒。

    		4
    MaxQueryTimelong

    查询时间范围内，Pattern的最大总耗时。单位：毫秒。

    		2341
    AverageExecutionTimedouble

    查询时间范围内，Pattern的平均执行时间。单位：毫秒。

    		234.78
    MaxExecutionTimelong

    查询时间范围内，Pattern的最大执行时间。单位：毫秒。

    		2142
    AveragePeakMemorydouble

    查询时间范围内，Pattern的平均峰值内存。单位：Byte。

    		234.22
    MaxPeakMemorylong

    Pattern相关SQL的最大峰值内存。单位：Byte。

    		234149
    AverageScanSizedouble

    查询时间范围内，Pattern的平均数据读取量。单位：Byte。

    		234149.23
    MaxScanSizelong

    Pattern相关SQL的最大数据读取量。单位：Byte。

    		234149
    QueryCountlong

    查询时间范围内，Pattern的执行次数。

    		345
    FailedCountlong

    查询时间范围内，Pattern的失败次数。

    		234
    Blockableboolean

    能否拦截当前SQL Pattern的运行。取值说明：

    • true：支持拦截。
    • false：不支持拦截。
    说明目前AnalyticDB MySQL版仅支持Select和Insert相关语句的拦截。
    		true
    RequestIdstring

    请求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
    }
  ],
  "RequestId": "6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******"
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2021-10-12OpenAPI 返回结构发生变更
    变更项变更内容
    出参OpenAPI 返回结构发生变更
    阿里云首页 云原生数据仓库AnalyticDB MySQL版 相关技术圈