调用DescribePatternPerformance接口查看指定时间段内SQL Pattern的各指标(如查询时间、平均内存消耗)详情。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribePatternPerformance

系统规定参数。取值:DescribePatternPerformance

DBClusterId String am-****************

集群ID。

说明 您可以调用DescribeDBClusters接口查看目标地域下所有AnalyticDB MySQL集群的详情,包括集群ID。
StartTime String 2021-11-18T00:00:00Z

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

说明
  • 仅支持查看最近14天内的数据。例如:当前日期为北京时间11月22日,最早可以查询到北京时间11月9日(UTC时间:2021-11-08T16:00:00Z)的数据,若查询时间早于11月9日(UTC时间:2021-11-08T16:00:00Z),返回值为空。
  • 查询开始时间和查询结束时间的间隔不能大于24小时。
EndTime String 2021-11-18T18:05:00Z

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

说明 查询结束时间需晚于查询开始时间。
RegionId String cn-hangzhou

地域ID。

说明 您可以调用DescribeRegions接口查看AnalyticDB MySQL版支持的地域和可用区信息,包括地域ID。
PatternId String 3847585356974******

SQL Pattern的ID。

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

返回数据

名称 类型 示例值 描述
EndTime String 2021-11-18T18:05Z

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

RequestId String 210f47011634026610213529******

请求ID。

StartTime String 2021-11-18T00:00Z

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

Performances Array of PerformanceItem

性能指标列表。

Key String AnalyticDB_PatternQueryCount

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

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

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

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

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

Values Array of String [ "2021-11-18 13:38:00", "224" ]

性能值。

Name String max_query_time

性能值名称。取值说明:

  • 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的最大数据读取量。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribePatternPerformance
&DBClusterId=am-****************
&StartTime=2021-11-18T00:00:00Z
&EndTime=2021-11-18T18:05:00Z
&RegionId=cn-hangzhou
&PatternId=3847585356974******
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribePatternPerformanceResponse>
    <EndTime>2021-11-18T18:05Z</EndTime>
    <RequestId>210f47011634026610213529******</RequestId>
    <StartTime>2021-11-18T00:00Z</StartTime>
    <Performances>
        <Key>AnalyticDB_PatternQueryCount</Key>
        <Unit>ms</Unit>
        <Series>
            <Values>[               "2021-11-18 13:38:00",               "224"             ]</Values>
            <Name>max_query_time</Name>
        </Series>
    </Performances>
</DescribePatternPerformanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "EndTime" : "2021-11-18T18:05Z",
  "RequestId" : "210f47011634026610213529******",
  "StartTime" : "2021-11-18T00:00Z",
  "Performances" : {
    "Key" : "AnalyticDB_PatternQueryCount",
    "Unit" : "ms",
    "Series" : {
      "Values" : "[               \"2021-11-18 13:38:00\",               \"224\"             ]",
      "Name" : "max_query_time"
    }
  }
}

错误码

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