文档

DescribePatternPerformance - 查询SQL Pattern的指标

更新时间:

查看集群指定时间段内SQL Pattern的各指标(如查询时间、平均内存消耗)详情。

接口说明

当前服务的接入地址请参见服务接入点

调试

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

授权信息

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

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

请求参数

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

集群 ID。

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

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

说明
  • 当前日期为北京时间 2022 年 8 月 22 日,最早可以查询到北京时间 2022 年 8 月 9 日(UTC 时间:2022-08-08T16:00:00Z)的数据,若查询时间早于 8 月 9 日(UTC 时间:2022-08-08T16:00:00Z),返回值为空。
    • 查询开始时间和查询结束时间的间隔不能大于 24 小时。
    2022-08-21T02:15:00Z
    EndTimestring

    查询结束时间,UTC 时间,格式:yyyy-MM-ddTHH:mmZ

    说明 查询结束时间需晚于查询开始时间。
    2022-08-22T01:06:00Z
    RegionIdstring

    地域 ID。

    cn-hangzhou
    PatternIdstring

    SQL Pattern 的 ID。

    说明 您可以调用 DescribeSQLPatterns 接口查看指定时间内目标集群下所有的 SQL Pattern 列表信息,包括 SQL Pattern 的 ID。
    3847585356974******

    返回参数

    名称类型描述示例值
    object
    EndTimestring

    查询结束时间,UTC 时间,格式:yyyy-MM-ddTHH:mmZ

    2022-08-22T01:06:00Z
    RequestIdstring

    请求 ID。

    F21AF487-B8C9-57E0-8E3A-A92BC3611FB6
    StartTimestring

    查询开始时间,UTC 时间,格式:yyyy-MM-ddTHH:mmZ

    2022-08-21T02:15:00Z
    Performancesarray<object>

    详情。

    object

    列表。

    Keystring

    查询的各项性能指标项。取值说明:

    • AnalyticDB_PatternQueryCount:Pattern 相关查询的总次数。
    • AnalyticDB_PatternQueryTime:Pattern 相关查询的总耗时。
    • AnalyticDB_PatternExecutionTime:Pattern 相关查询的执行耗时。
    • AnalyticDB_PatternPeakMemory:Pattern 相关查询的峰值内存。
    • AnalyticDB_PatternScanSize:Pattern 相关查询的数据读取量。
    AnalyticDB_PatternExecutionTime
    Unitstring

    各项性能指标项对应的单位。取值说明:

    • 当性能指标项为查询时间相关(即Key值为AnalyticDB_PatternQueryTimeAnalyticDB_PatternExecutionTime)时,该返回值为 ms
    • 当性能指标项为峰值内存相关(即Key值为AnalyticDB_PatternPeakMemory)时,该返回值为 MB
    • 当性能指标项为数据读取量(即Key值为AnalyticDB_PatternScanSize)时,该返回值为 MB
    • 当性能指标项为查询次数(即Key值为AnalyticDB_PatternQueryCount)时,该返回值为空。
    ms
    Seriesarray<object>

    性能指标项下各个性能值的详情。

    object

    列表项。

    Valuesarray

    性能值列表。

    string

    不同时间点下的性能值详细信息。

    [ "2021-11-18 13:38:00", "224" ]
    Namestring

    性能值的名称。取值说明:

    • Key值为AnalyticDB_PatternQueryCount时,该参数返回 pattern_query_count,即当前 Pattern 相关 SQL 的执行次数。
    • Key值为AnalyticDB_PatternQueryTime时,该参数返回:
      • average_query_time,即当前 Pattern 相关 SQL 的平均总耗时。
      • max_query_time,即当前 Pattern 相关 SQL 的最大总耗时。
    • Key值为AnalyticDB_PatternExecutionTime时,该参数返回:
      • average_execution_time,即当前 Pattern 相关 SQL 的平均执行耗时。
      • max_execution_time,即当前 Pattern 相关 SQL 的最大执行耗时。
    • Key值为AnalyticDB_PatternPeakMemory时,该参数返回:
      • average_peak_memory,即当前 Pattern 相关 SQL 的平均峰值内存。
      • max_peak_memory,即当前 Pattern 相关 SQL 的最大峰值内存。
    • Key值为AnalyticDB_PatternScanSize时,该参数返回:
      • average_scan_size,即当前 Pattern 相关 SQL 的平均读取数据量。
      • max_scan_size,即当前 Pattern 相关 SQL 的最大数据读取量。
    max_query_time

    示例

    正常返回示例

    JSON格式

    {
      "EndTime": "2022-08-22T01:06:00Z",
      "RequestId": "F21AF487-B8C9-57E0-8E3A-A92BC3611FB6",
      "StartTime": "2022-08-21T02:15:00Z",
      "Performances": [
        {
          "Key": "AnalyticDB_PatternExecutionTime",
          "Unit": "ms",
          "Series": [
            {
              "Values": [
                "[               \"2021-11-18 13:38:00\",               \"224\"             ]"
              ],
              "Name": "max_query_time"
            }
          ]
        }
      ]
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-12-08API 内部配置变更,不影响调用查看变更详情
    2023-06-08OpenAPI 入参发生变更查看变更详情