DescribePatternPerformance - 查询模式性能 - 云原生数据仓库AnalyticDB

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

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 集群的详情，包括集群 ID。	am-****************
StartTime	string	是	查询开始时间。格式：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 小时。	2021-11-18T00:00:00Z
EndTime	string	是	查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明查询结束时间需晚于查询开始时间。	2021-11-18T18:05:00Z
RegionId	string	是	地域 ID。说明您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息，包括地域 ID。	cn-hangzhou
PatternId	string	是	SQL Pattern 的 ID。说明您可以调用 DescribeSQLPatterns 接口查看指定时间内目标 AnalyticDB MySQL 集群下所有的 SQL Pattern 列表信息，包括 SQL Pattern 的 ID。	3847585356974******

返回参数

名称	类型	描述	示例值
	object	列表。
EndTime	string	查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2021-11-18T18:05Z
RequestId	string	请求 ID。	210f47011634026610213529******
StartTime	string	查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2021-11-18T00:00Z
Performances	array<object>	性能指标列表。
PerformanceItem	object	列表。
Key	string	查询的性能指标项。取值说明： AnalyticDB_PatternQueryCount：Pattern 相关查询的总次数。 AnalyticDB_PatternQueryTime：Pattern 相关查询的总耗时。 AnalyticDB_PatternExecutionTime：Pattern 相关查询的执行耗时。 AnalyticDB_PatternPeakMemory：Pattern 相关查询的峰值内存。 AnalyticDB_PatternScanSize：Pattern 相关查询的数据读取量。	AnalyticDB_PatternQueryCount
Unit	string	性能指标项对应的单位。取值说明：当性能指标项为查询时间相关（即`Key`值为`AnalyticDB_PatternQueryTime`或`AnalyticDB_PatternExecutionTime`）时，该返回值为 ms。当性能指标项为峰值内存相关（即`Key`值为`AnalyticDB_PatternPeakMemory`）时，该返回值为 MB。当性能指标项为数据读取量（即`Key`值为`AnalyticDB_PatternScanSize`）时，该返回值为 MB。当性能指标项为查询次数（即`Key`值为`AnalyticDB_PatternQueryCount`）时，该返回值为空。	ms
Series	array<object>	性能指标项下各性能值的详情。
SeriesItem	object	列表。
Values	array	性能值列表。
values	string	性能值。	[ "2021-11-18 13:38:00", "224" ]
Name	string	性能值名称。取值说明：当`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": "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"
        }
      ]
    }
  ],
  "AccessIp": "",
  "FailedCount": 0,
  "QueryCount": 0,
  "SQLPattern": "",
  "Tables": "",
  "User": ""
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-21	OpenAPI 返回结构发生变更	查看变更详情
2021-10-12	API 内部配置变更，不影响调用	查看变更详情
2021-09-27	OpenAPI 返回结构发生变更	查看变更详情