文档

DescribeSQLPatterns - 查询SQL Pattern列表

更新时间:

查看指定日期内AnalyticDB MySQL湖仓版集群的SQL Pattern列表。

接口说明

  • 中心的公网接入地址:adb.aliyuncs.com
  • 地域的公网接入地址:adb.<region-id>.aliyuncs.com。示例:adb.cn-hangzhou.aliyuncs.com
  • 地域的 VPC 接入地址:adb-vpc.<region-id>.aliyuncs.com。示例:adb-vpc.cn-hangzhou.aliyuncs.com

调试

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

授权信息

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

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

请求参数

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

AnalyticDB MySQL 湖仓版集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 湖仓版集群的详情,包括集群 ID。
amv-8vb8de93v9b****
StartTimestring

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

说明
  • 仅支持查看最近 14 天的数据。
    • 查询开始时间和查询结束时间的间隔不能大于 24 小时。
    2022-09-06T03:06:00Z
    EndTimestring

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

    说明 查询结束时间需晚于查询开始时间。
    2022-09-07T03:06:00Z
    RegionIdstring

    地域 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。

    2
    PageSizeinteger

    每页记录数,取值:

    • 10(默认值)
    • 30
    • 50
    • 100
    10
    Langstring

    语言配置,取值说明:

    • zh:简体中文(默认语言)。
    • en:英文。
    • ja:日文。
    • zh-tw:繁体中文。
    zh

    返回参数

    名称类型描述示例值
    object

    SQL Pattern 的详细信息。

    PageNumberinteger

    页码。

    2
    PageSizeinteger

    每页记录数。

    10
    TotalCountinteger

    总记录数。

    20
    PatternDetailsarray<object>

    列表。

    object

    SQL Pattern 的详细信息。

    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 数据库用户名称。

    test
    AccessIpstring

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

    192.168.xx.xx
    Tablesstring

    SQL Pattern 扫描的列表信息。

    tpch.orders
    PatternCreationTimestring

    指定时间范围内,Pattern 的最早提交时间。

    2022-09-06 05: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。

    32212254
    QueryCountlong

    指定时间范围内,Pattern 的执行次数。

    345
    FailedCountlong

    指定时间范围内,Pattern 的失败次数。

    18
    Blockableboolean

    能否拦截当前 SQL Pattern 的运行,取值说明:

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

    请求 ID。

    F3174013-5B7A-5A47-9FE0-6B5D397BD86A

    示例

    正常返回示例

    JSON格式

    {
      "PageNumber": 2,
      "PageSize": 10,
      "TotalCount": 20,
      "PatternDetails": [
        {
          "SQLPattern": "SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)",
          "PatternId": "5575924945138******",
          "User": "test",
          "AccessIp": "192.168.xx.xx",
          "Tables": "tpch.orders",
          "PatternCreationTime": "2022-09-06 05:06:00",
          "AverageQueryTime": 4,
          "MaxQueryTime": 2341,
          "AverageExecutionTime": 234.78,
          "MaxExecutionTime": 2142,
          "AveragePeakMemory": 234.22,
          "MaxPeakMemory": 234149,
          "AverageScanSize": 234149.23,
          "MaxScanSize": 32212254,
          "QueryCount": 345,
          "FailedCount": 18,
          "Blockable": true,
          "QueryTimeSum": 0,
          "QueryTimePercentage": 0,
          "PeakMemorySum": 0,
          "PeakMemoryPercentage": 0,
          "ScanSizeSum": 0,
          "ScanSizePercentage": 0,
          "AverageOperatorCost": 0,
          "MaxOperatorCost": 0,
          "OperatorCostSum": 0,
          "OperatorCostPercentage": 0,
          "AverageScanCost": 0,
          "MaxScanCost": 0,
          "ScanCostSum": 0,
          "ScanCostPercentage": 0
        }
      ],
      "RequestId": "F3174013-5B7A-5A47-9FE0-6B5D397BD86A",
      "AccessDeniedDetail": ""
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-08-06OpenAPI 返回结构发生变更查看变更详情
    2024-05-14OpenAPI 返回结构发生变更查看变更详情
    2023-12-08API 内部配置变更,不影响调用查看变更详情
    2023-06-08API 内部配置变更,不影响调用查看变更详情